Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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>
authored by
Mauro Carvalho Chehab
and committed by
Paul E. McKenney
6b05dfac
9ebcfadb
+15
-5
+12
-5
Documentation/RCU/checklist.txt
Documentation/RCU/checklist.rst
+12
-5
Documentation/RCU/checklist.txt
Documentation/RCU/checklist.rst
···
1
+
.. SPDX-License-Identifier: GPL-2.0
2
+
3
+
================================
1
4
Review Checklist for RCU Patches
5
+
================================
2
6
3
7
4
8
This document contains a checklist for producing and reviewing patches
···
415
411
__rcu sparse checks to validate your RCU code. These can help
416
412
find problems as follows:
417
413
418
-
CONFIG_PROVE_LOCKING: check that accesses to RCU-protected data
414
+
CONFIG_PROVE_LOCKING:
415
+
check that accesses to RCU-protected data
419
416
structures are carried out under the proper RCU
420
417
read-side critical section, while holding the right
421
418
combination of locks, or whatever other conditions
422
419
are appropriate.
423
420
424
-
CONFIG_DEBUG_OBJECTS_RCU_HEAD: check that you don't pass the
421
+
CONFIG_DEBUG_OBJECTS_RCU_HEAD:
422
+
check that you don't pass the
425
423
same object to call_rcu() (or friends) before an RCU
426
424
grace period has elapsed since the last time that you
427
425
passed that same object to call_rcu() (or friends).
428
426
429
-
__rcu sparse checks: tag the pointer to the RCU-protected data
427
+
__rcu sparse checks:
428
+
tag the pointer to the RCU-protected data
430
429
structure with __rcu, and sparse will warn you if you
431
430
access that pointer without the services of one of the
432
431
variants of rcu_dereference().
···
449
442
450
443
You instead need to use one of the barrier functions:
451
444
452
-
o call_rcu() -> rcu_barrier()
453
-
o call_srcu() -> srcu_barrier()
445
+
- call_rcu() -> rcu_barrier()
446
+
- call_srcu() -> srcu_barrier()
454
447
455
448
However, these barrier functions are absolutely -not- guaranteed
456
449
to wait for a grace period. In fact, if there are no call_rcu()