From: Joel Fernandes <joel@joelfernandes.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: "Paul E . McKenney" <paulmck@kernel.org>,
linux-doc@vger.kernel.org, Lai Jiangshan <jiangshanlai@gmail.com>,
Josh Triplett <josh@joshtriplett.org>,
Steven Rostedt <rostedt@goodmis.org>,
linux-kernel@vger.kernel.org, rcu@vger.kernel.org,
Mathieu Desnoyers <mathieu.desnoyers@efficios.com>,
linux-kernel-mentees@lists.linuxfoundation.org
Subject: Re: [Linux-kernel-mentees] [PATCH] doc: listRCU: Add some more listRCU patterns in the kernel
Date: Wed, 4 Dec 2019 10:39:58 -0500 [thread overview]
Message-ID: <20191204153958.GA17404@google.com> (raw)
In-Reply-To: <20191204074833.44bcc079@lwn.net>
On Wed, Dec 04, 2019 at 07:48:33AM -0700, Jonathan Corbet wrote:
> On Wed, 4 Dec 2019 13:54:12 +0530
> Amol Grover <frextrite@gmail.com> wrote:
>
> > The cross-reference of the functions should be done automatically by sphinx
> > while generating HTML, right? But when compiled none of the functions were
> > cross-referenced hence "``" was added around the methods (and other symbols)
> > to distinguish them from normal text.
Amol, when I tried your patch -- some functions were cross-referenced. Some
were not. I don't think all were not cross referenced.
>
> If there's nothing to cross-reference to (i.e. no kerneldoc comments)
> then the reference obviously won't be generated. I would still ask that
> you leave out the literal markers; they will block linking to any docs
> added in the future, and they clutter up the text - the plain-text reading
> experience is important too.
Actually I had asked Amol privately to add the backticks. It appeared super
weird in my browser when some function calls were rendered monospace while
others weren't. Not all functions were successfully cross referenced for me.
May be it is my kernel version?
Amol, do as Jon said and send a v2. Then I will test your patch again.
thanks,
- Joel
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
next prev parent reply other threads:[~2019-12-04 16:08 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-12-03 6:39 [Linux-kernel-mentees] [PATCH] doc: listRCU: Add some more listRCU patterns in the kernel Amol Grover
2019-12-03 13:41 ` Jonathan Corbet
2019-12-04 8:24 ` Amol Grover
2019-12-04 14:48 ` Jonathan Corbet
2019-12-04 15:39 ` Joel Fernandes [this message]
2019-12-04 15:47 ` Jonathan Corbet
2019-12-04 16:35 ` Joel Fernandes
2019-12-05 15:14 ` Amol Grover
2019-12-06 1:08 ` Joel Fernandes
2019-12-06 8:07 ` [Linux-kernel-mentees] [PATCH v2] " Amol Grover
2019-12-19 16:29 ` Jonathan Corbet
2019-12-19 16:56 ` Paul E. McKenney
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20191204153958.GA17404@google.com \
--to=joel@joelfernandes.org \
--cc=corbet@lwn.net \
--cc=jiangshanlai@gmail.com \
--cc=josh@joshtriplett.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel-mentees@lists.linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mathieu.desnoyers@efficios.com \
--cc=paulmck@kernel.org \
--cc=rcu@vger.kernel.org \
--cc=rostedt@goodmis.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).