2
0
mirror of https://github.com/edk2-porting/linux-next.git synced 2024-12-17 17:53:56 +08:00
linux-next/Documentation/RCU
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
..
Design docs: Update RCU cross-references as suggested in doc-guide 2022-04-20 16:13:52 -07:00
arrayRCU.rst docs: Update RCU cross-references as suggested in doc-guide 2022-04-20 16:13:52 -07:00
checklist.rst docs: Update RCU cross-references as suggested in doc-guide 2022-04-20 16:13:52 -07:00
index.rst docs: RCU: Convert stallwarn.txt to ReST 2020-06-29 11:58:11 -07:00
listRCU.rst doc/RCU/listRCU: Update example function name 2020-02-27 07:03:13 -08:00
lockdep-splat.rst docs: RCU: Convert lockdep-splat.txt to ReST 2020-06-29 11:58:10 -07:00
lockdep.rst docs: Fix function name trailing double-()s 2020-08-24 17:19:07 -06:00
NMI-RCU.rst drivers: Remove CONFIG_OPROFILE support 2021-01-29 10:06:24 +05:30
rcu_dereference.rst Documentation/RCU: Fix emphasis markers 2021-07-20 13:36:33 -07:00
rcu.rst docs: Update RCU cross-references as suggested in doc-guide 2022-04-20 16:13:52 -07:00
rcubarrier.rst doc: Use CONFIG_PREEMPTION 2021-01-06 16:10:44 -08:00
rculist_nulls.rst docs: Update RCU cross-references as suggested in doc-guide 2022-04-20 16:13:52 -07:00
rcuref.rst docs: RCU: Convert rcuref.txt to ReST 2020-06-29 11:58:11 -07:00
RTFP.txt docs: Correctly spell Stephen Hemminger's name 2021-03-15 13:53:24 -07:00
stallwarn.rst rcu: Remove the RCU_FAST_NO_HZ Kconfig option 2021-11-30 17:24:47 -08:00
torture.rst docs: RCU: Convert torture.txt to ReST 2020-06-29 11:58:11 -07:00
UP.rst doc: RCU callback locks need only _bh, not necessarily _irq 2019-06-28 09:10:40 -06:00
whatisRCU.rst docs: Update RCU cross-references as suggested in doc-guide 2022-04-20 16:13:52 -07:00