[Linux-kernel-mentees] [PATCH] doc: listRCU: Add some more listRCU patterns in the kernel

Amol Grover frextrite at gmail.com
Thu Dec 5 15:14:18 UTC 2019

On Wed, Dec 04, 2019 at 11:35:52AM -0500, Joel Fernandes wrote:
> On Wed, Dec 04, 2019 at 08:47:29AM -0700, Jonathan Corbet wrote:
> > On Wed, 4 Dec 2019 10:39:58 -0500
> > Joel Fernandes <joel at joelfernandes.org> wrote:
> > 
> > > 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?
> > 
> > If you have an example of a failure to cross-reference a function that
> > has kerneldoc comments *that are included in the toctree*, I'd like to see
> > it; that's a bug.
> > 
> > Changing the font on functions without anything to cross-reference to is
> > easy enough and should probably be done; I'll look into it when I get a
> > chance.
> I tried on a different machine (my work machine) and the cross-referencing is
> working fine. So I am not sure if this could be something related to Sphinx
> version or I had used an older kernel tree before. This kernel tree is
> Linus's master.

This is great! I'll remove the "``" from function text and send in the
updated version. However, should I leave in the "``CONSTANTS``" and
"``variables``"? They dont' have any kernel docs to be cross-referenced
with and also make them distinguishable from the normal text.


> thanks,
>  - Joel

More information about the Linux-kernel-mentees mailing list