linux-kernel - [tip: core/rcu] doc/RCU/rcu: Use ':ref:' for links to other docs

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>] [day] [month] [year] [list]

Date:   Tue, 24 Mar 2020 09:16:28 -0000
From:   "tip-bot2 for SeongJae Park" <tip-bot2@...utronix.de>
To:     linux-tip-commits@...r.kernel.org
Cc:     SeongJae Park <sjpark@...zon.de>,
        "Paul E. McKenney" <paulmck@...nel.org>, x86 <x86@...nel.org>,
        LKML <linux-kernel@...r.kernel.org>
Subject: [tip: core/rcu] doc/RCU/rcu: Use ':ref:' for links to other docs

The following commit has been merged into the core/rcu branch of tip:

Commit-ID:     be2895681d6d8b1eb5a052d4655dea0d7cc2d84d
Gitweb:        https://git.kernel.org/tip/be2895681d6d8b1eb5a052d4655dea0d7cc2d84d
Author:        SeongJae Park <sjpark@...zon.de>
AuthorDate:    Mon, 06 Jan 2020 21:07:59 +01:00
Committer:     Paul E. McKenney <paulmck@...nel.org>
CommitterDate: Thu, 27 Feb 2020 07:03:13 -08:00

doc/RCU/rcu: Use ':ref:' for links to other docs

Signed-off-by: SeongJae Park <sjpark@...zon.de>
Signed-off-by: Paul E. McKenney <paulmck@...nel.org>
---
 Documentation/RCU/rcu.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/Documentation/RCU/rcu.rst b/Documentation/RCU/rcu.rst
index 8dfb437..a1dd71d 100644
--- a/Documentation/RCU/rcu.rst
+++ b/Documentation/RCU/rcu.rst
@@ -11,8 +11,8 @@ 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
-Documentation/RCU/listRCU.rst file for more information on using RCU with
-linked lists.
+:ref:`Documentation/RCU/listRCU.rst <list_rcu_doc>` for more information on
+using RCU with linked lists.
 
 Frequently Asked Questions
 --------------------------
@@ -50,7 +50,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 Documentation/RCU/UP.rst file for more information.
+  See :ref:`Documentation/RCU/UP.rst <up_doc>` for more information.
 
 - How can I see where RCU is currently used in the Linux kernel?
 
@@ -68,9 +68,9 @@ Frequently Asked Questions
 
 - Why the name "RCU"?
 
-  "RCU" stands for "read-copy update".  The file Documentation/RCU/listRCU.rst
-  has more information on where this name came from, search for
-  "read-copy update" to find it.
+  "RCU" stands for "read-copy update".
+  :ref:`Documentation/RCU/listRCU.rst <list_rcu_doc>` has more information on where
+  this name came from, search for "read-copy update" to find it.
 
 - I hear that RCU is patented?  What is with that?