• Akira Yokosawa's avatar
    docs: Update RCU cross-references as suggested in doc-guide · 404147fa
    Akira Yokosawa authored
    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: default avatarBagas Sanjaya <bagasdotme@gmail.com>
    Reviewed-by: default avatarSteven Rostedt (Google) <rostedt@goodmis.org>
    Signed-off-by: default avatarAkira Yokosawa <akiyks@gmail.com>
    Signed-off-by: default avatarPaul E. McKenney <paulmck@kernel.org>
    404147fa
checklist.rst 22.6 KB