summaryrefslogtreecommitdiff
path: root/Documentation/RCU/rculist_nulls.rst
diff options
context:
space:
mode:
authorAkira Yokosawa <akiyks@gmail.com>2022-03-30 17:41:00 +0300
committerPaul E. McKenney <paulmck@kernel.org>2022-04-21 02:13:52 +0300
commit404147faaaf28319ba8e60392ba9d4f3b6055ad5 (patch)
tree987ca303a337e833a5802bf89f06f3cbfc1c43c2 /Documentation/RCU/rculist_nulls.rst
parent6172de3c7f1171e55314bfc5ee4ae6edd225b048 (diff)
downloadlinux-404147faaaf28319ba8e60392ba9d4f3b6055ad5.tar.xz
docs: Update RCU cross-references as suggested in doc-guide
The RCU documentation contains old-style cross references which do not follow the best practices outlined in doc-guide/sphinx.rst. In addition, some of the cross references use URLs that should be replaced by pathnames. Update all of these cross references and adjust the surrounding words. Summary of changes: - out-of-date plaintext file names (*.txt) -> *.rst - references by :ref: tags -> path names of *.rst * use relative paths to .rst files under the RCU/ subdirectory * use abs paths of Documentation/xxx for other .rst files - references by URL under https://www.kernel.org/ -> paths of *.rst - adjust surrounding words of some of updated references. Note: The automarkup.py script interprets references via "*.txt" as if they were via "*.rst", so the *.txt -> *.rst changes should be regarded as cleanups rather than bug fixes. Cc: rcu@vger.kernel.org Cc: linux-doc@vger.kernel.org Tested-by: Bagas Sanjaya <bagasdotme@gmail.com> Reviewed-by: Steven Rostedt (Google) <rostedt@goodmis.org> Signed-off-by: Akira Yokosawa <akiyks@gmail.com> Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
Diffstat (limited to 'Documentation/RCU/rculist_nulls.rst')
-rw-r--r--Documentation/RCU/rculist_nulls.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/RCU/rculist_nulls.rst b/Documentation/RCU/rculist_nulls.rst
index a9fc774bc400..ca4692775ad4 100644
--- a/Documentation/RCU/rculist_nulls.rst
+++ b/Documentation/RCU/rculist_nulls.rst
@@ -8,7 +8,7 @@ This section describes how to use hlist_nulls to
protect read-mostly linked lists and
objects using SLAB_TYPESAFE_BY_RCU allocations.
-Please read the basics in Documentation/RCU/listRCU.rst
+Please read the basics in listRCU.rst.
Using 'nulls'
=============