[Linux-kernel-mentees] [PATCH v3 5/6] Documentation: RCU: Add links to rcu.rst
Paul E. McKenney
paulmck at linux.ibm.com
Tue Jun 25 15:56:23 UTC 2019
On Tue, Jun 25, 2019 at 01:26:26AM -0500, Jiunn Chang wrote:
> Add the following links:
> - list_rcu
> - up_rcu
> Signed-off-by: Jiunn Chang <c0d1n61at3 at gmail.com>
> Documentation/RCU/rcu.rst | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
> diff --git a/Documentation/RCU/rcu.rst b/Documentation/RCU/rcu.rst
> index 000da07d683e..d145decb5c39 100644
> --- a/Documentation/RCU/rcu.rst
> +++ b/Documentation/RCU/rcu.rst
> @@ -10,8 +10,8 @@ A "grace period" must elapse between the two parts, and this grace period
> must be long enough that any readers accessing the item being deleted have
> since dropped their references. For example, an RCU-protected deletion
> from a linked list would first remove the item from the list, wait for
> -a grace period to elapse, then free the element. See the listRCU.txt
> -file for more information on using RCU with linked lists.
> +a grace period to elapse, then free the element. See :ref:`list_rcu`
> +for more information on using RCU with linked lists.
> Frequently Asked Questions
> @@ -49,7 +49,7 @@ Frequently Asked Questions
> - If I am running on a uniprocessor kernel, which can only do one
> thing at a time, why should I wait for a grace period?
> - See the UP.txt file in this directory.
> + See :ref:`up_rcu` for more information.
This rendered as straight text after "make htmldocs" instead of producing
a link in the HTML output. The HTML itself is:
<span class="xref std std-ref">up_rcu</span>
This doesn't look like something that would create a link, though I
freely admit that my HTML is rather outdated.
> - How can I see where RCU is currently used in the Linux kernel?
> @@ -67,7 +67,7 @@ Frequently Asked Questions
> - Why the name "RCU"?
> - "RCU" stands for "read-copy update". The file listRCU.txt has
> + "RCU" stands for "read-copy update". :ref:`list_rcu` has
Same here for list_rcu.
> more information on where this name came from, search for
> "read-copy update" to find it.
More information about the Linux-kernel-mentees