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

Jonathan Corbet corbet at lwn.net
Wed Dec 4 14:48:33 UTC 2019


On Wed, 4 Dec 2019 13:54:12 +0530
Amol Grover <frextrite at 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.

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.

Thanks,

jon


More information about the Linux-kernel-mentees mailing list