docs: RCU: Convert checklist.txt to ReST

- Add a SPDX header;
- Adjust document title;
- Some whitespace fixes and new line breaks;
- Use the right list markups;
- Add it to RCU/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>

diff --git a/Documentation/RCU/checklist.txt b/Documentation/RCU/checklist.rst
similarity index 98%
rename from Documentation/RCU/checklist.txt
rename to Documentation/RCU/checklist.rst
index e98ff26..2efed99 100644 (file)
--- a/Documentation/RCU/checklist.txt
+++ b/Documentation/RCU/checklist.rst
@@ -1,4 +1,8 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+================================
 Review Checklist for RCU Patches
+================================
 
 
 This document contains a checklist for producing and reviewing patches
@@ -411,18 +415,21 @@ over a rather long period of time, but improvements are always welcome!
        __rcu sparse checks to validate your RCU code.  These can help
        find problems as follows:
 
-       CONFIG_PROVE_LOCKING: check that accesses to RCU-protected data
+       CONFIG_PROVE_LOCKING:
+               check that accesses to RCU-protected data
                structures are carried out under the proper RCU
                read-side critical section, while holding the right
                combination of locks, or whatever other conditions
                are appropriate.
 
-       CONFIG_DEBUG_OBJECTS_RCU_HEAD: check that you don't pass the
+       CONFIG_DEBUG_OBJECTS_RCU_HEAD:
+               check that you don't pass the
                same object to call_rcu() (or friends) before an RCU
                grace period has elapsed since the last time that you
                passed that same object to call_rcu() (or friends).
 
-       __rcu sparse checks: tag the pointer to the RCU-protected data
+       __rcu sparse checks:
+               tag the pointer to the RCU-protected data
                structure with __rcu, and sparse will warn you if you
                access that pointer without the services of one of the
                variants of rcu_dereference().
@@ -442,8 +449,8 @@ over a rather long period of time, but improvements are always welcome!
 
        You instead need to use one of the barrier functions:
 
-       o       call_rcu() -> rcu_barrier()
-       o       call_srcu() -> srcu_barrier()
+       -       call_rcu() -> rcu_barrier()
+       -       call_srcu() -> srcu_barrier()
 
        However, these barrier functions are absolutely -not- guaranteed
        to wait for a grace period.  In fact, if there are no call_rcu()

diff --git a/Documentation/RCU/index.rst b/Documentation/RCU/index.rst
index 81a0a1e..c1ba4d1 100644 (file)
--- a/Documentation/RCU/index.rst
+++ b/Documentation/RCU/index.rst
@@ -1,3 +1,5 @@
+.. SPDX-License-Identifier: GPL-2.0
+
 .. _rcu_concepts:
 
 ============
@@ -8,6 +10,7 @@ RCU concepts
    :maxdepth: 3
 
    arrayRCU
+   checklist
    rcubarrier
    rcu_dereference
    whatisRCU