renegade-project/linux-next
2
0
Fork 0
mirror of https://github.com/edk2-porting/linux-next.git synced 2024-12-18 02:04:05 +08:00
Code

docs: RCU: Convert checklist.txt to ReST

Browse Source 
- 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>
This commit is contained in:
Mauro Carvalho Chehab 2020-04-21 19:04:02 +02:00 committed by Paul E. McKenney
parent 9ebcfadb06
commit 6b05dfacd7
2 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Documentation/RCU/checklist.txt → Documentation/RCU/checklist.rst
View File

@ -1,4 +1,8 @@
.. SPDX-License-Identifier: GPL-2.0
================================
Review Checklist for RCU Patches Review Checklist for RCU Patches
================================
This document contains a checklist for producing and reviewing 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 __rcu sparse checks to validate your RCU code. These can help
find problems as follows: 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 structures are carried out under the proper RCU
read-side critical section, while holding the right read-side critical section, while holding the right
combination of locks, or whatever other conditions combination of locks, or whatever other conditions
are appropriate. 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 same object to call_rcu() (or friends) before an RCU
grace period has elapsed since the last time that you grace period has elapsed since the last time that you
passed that same object to call_rcu() (or friends). 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 structure with __rcu, and sparse will warn you if you
access that pointer without the services of one of the access that pointer without the services of one of the
variants of rcu_dereference(). 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: You instead need to use one of the barrier functions:
o call_rcu() -> rcu_barrier() - call_rcu() -> rcu_barrier()
o call_srcu() -> srcu_barrier() - call_srcu() -> srcu_barrier()
However, these barrier functions are absolutely -not- guaranteed However, these barrier functions are absolutely -not- guaranteed
to wait for a grace period. In fact, if there are no call_rcu() to wait for a grace period. In fact, if there are no call_rcu()

3
Documentation/RCU/index.rst
View File

@ -1,3 +1,5 @@
.. SPDX-License-Identifier: GPL-2.0
.. _rcu_concepts: .. _rcu_concepts:
============ ============
@ -8,6 +10,7 @@ RCU concepts
:maxdepth: 3 :maxdepth: 3
arrayRCU arrayRCU
checklist
rcubarrier rcubarrier
rcu_dereference rcu_dereference
whatisRCU whatisRCU