linux/Documentation/RCU/Design/Data-Structures
Akira Yokosawa 404147faaa 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>
2022-04-20 16:13:52 -07:00
..
BigTreeClassicRCU.svg
BigTreePreemptRCUBHdyntickCB.svg doc: rcu: Update Data-Structures for RCU flavor consolidation 2018-11-12 08:56:25 -08:00
blkd_task.svg doc: rcu: Update Data-Structures for RCU flavor consolidation 2018-11-12 08:56:25 -08:00
Data-Structures.rst docs: Update RCU cross-references as suggested in doc-guide 2022-04-20 16:13:52 -07:00
HugeTreeClassicRCU.svg
nxtlist.svg doc: Update RCU data-structure documentation for rcu_segcblist 2017-04-12 08:23:41 -07:00
TreeLevel.svg
TreeMapping.svg
TreeMappingLevel.svg