Skip to content

Commit 6b05dfa

Browse files
mchehabpaulmckrcu
authored andcommitted
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 <[email protected]> Signed-off-by: Paul E. McKenney <[email protected]>
1 parent 9ebcfad commit 6b05dfa

File tree

2 files changed

+15
-5
lines changed

2 files changed

+15
-5
lines changed

Documentation/RCU/checklist.txt renamed to Documentation/RCU/checklist.rst

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
3+
================================
14
Review Checklist for RCU Patches
5+
================================
26

37

48
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!
411415
__rcu sparse checks to validate your RCU code. These can help
412416
find problems as follows:
413417

414-
CONFIG_PROVE_LOCKING: check that accesses to RCU-protected data
418+
CONFIG_PROVE_LOCKING:
419+
check that accesses to RCU-protected data
415420
structures are carried out under the proper RCU
416421
read-side critical section, while holding the right
417422
combination of locks, or whatever other conditions
418423
are appropriate.
419424

420-
CONFIG_DEBUG_OBJECTS_RCU_HEAD: check that you don't pass the
425+
CONFIG_DEBUG_OBJECTS_RCU_HEAD:
426+
check that you don't pass the
421427
same object to call_rcu() (or friends) before an RCU
422428
grace period has elapsed since the last time that you
423429
passed that same object to call_rcu() (or friends).
424430

425-
__rcu sparse checks: tag the pointer to the RCU-protected data
431+
__rcu sparse checks:
432+
tag the pointer to the RCU-protected data
426433
structure with __rcu, and sparse will warn you if you
427434
access that pointer without the services of one of the
428435
variants of rcu_dereference().
@@ -442,8 +449,8 @@ over a rather long period of time, but improvements are always welcome!
442449

443450
You instead need to use one of the barrier functions:
444451

445-
o call_rcu() -> rcu_barrier()
446-
o call_srcu() -> srcu_barrier()
452+
- call_rcu() -> rcu_barrier()
453+
- call_srcu() -> srcu_barrier()
447454

448455
However, these barrier functions are absolutely -not- guaranteed
449456
to wait for a grace period. In fact, if there are no call_rcu()

Documentation/RCU/index.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
13
.. _rcu_concepts:
24

35
============
@@ -8,6 +10,7 @@ RCU concepts
810
:maxdepth: 3
911

1012
arrayRCU
13+
checklist
1114
rcubarrier
1215
rcu_dereference
1316
whatisRCU

0 commit comments

Comments
 (0)