linux-kernel - Re: [PATCH] doc: listRCU: Add some more listRCU patterns in the kernel

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20191204074833.44bcc079@lwn.net>
Date:   Wed, 4 Dec 2019 07:48:33 -0700
From:   Jonathan Corbet <corbet@....net>
To:     Amol Grover <frextrite@...il.com>
Cc:     "Paul E . McKenney" <paulmck@...nel.org>,
        Josh Triplett <josh@...htriplett.org>,
        Steven Rostedt <rostedt@...dmis.org>,
        Mathieu Desnoyers <mathieu.desnoyers@...icios.com>,
        Lai Jiangshan <jiangshanlai@...il.com>,
        Joel Fernandes <joel@...lfernandes.org>, rcu@...r.kernel.org,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        linux-kernel-mentees@...ts.linuxfoundation.org,
        Shuah Khan <skhan@...uxfoundation.org>,
        Madhuparna Bhowmik <madhuparnabhowmik04@...il.com>
Subject: Re: [PATCH] doc: listRCU: Add some more listRCU patterns in the
 kernel

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