RCU documentation updates for v5.10
Subsystems (2)
Paul E. McKenney
maintainercover RCU documentation updates for v5.10
Hello!
This series provides documentation updates.
1. Fix typo in synchronize_rcu() function name.
2. Drop doubled words from RCU Data-Structures.rst.
3. Drop doubled words from RCU requirements documentation.
Thanx, Paul
------------------------------------------------------------------------
Design/Data-Structures/Data-Structures.rst | 2 +- Design/Requirements/Requirements.rst | 4 ++-- whatisRCU.rst | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-)
[email protected]
maintainerPATCH 1/3 docs: Fix typo in synchronize_rcu() function name
From: Tobias Klauser <[email protected]>
s/sychronize_rcu/synchronize_rcu/
Signed-off-by Tobias Klauser <[email protected]>
Signed-off-by Paul E. McKenney <[email protected]>
--- Documentation/RCU/whatisRCU.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/RCU/whatisRCU.rst +1 -1
@@ -360,7 +360,7 @@ order to amortize their overhead over many uses of the corresponding APIs. There are at least three flavors of RCU usage in the Linux kernel. The diagram above shows the most common one. On the updater side, the rcu_assign_pointer(), -sychronize_rcu() and call_rcu() primitives used are the same for all three +synchronize_rcu() and call_rcu() primitives used are the same for all three flavors. However for protection (on the reader side), the primitives used vary depending on the flavor:
Signature · 1 line
2.9.5
[email protected]
maintainerPATCH 2/3 doc: Drop doubled words from RCU Data-Structures.rst
In reply to Paul E. McKenneyFrom: Randy Dunlap <[email protected]>
Drop the doubled word "the".
Signed-off-by Randy Dunlap <[email protected]>
Cc Jonathan Corbet <[email protected]>
Cc "Paul E. McKenney" <[email protected]>
Cc Josh Triplett <[email protected]>
Cc Steven Rostedt <[email protected]>
Cc Mathieu Desnoyers <[email protected]>
Cc Lai Jiangshan <[email protected]>
Cc Joel Fernandes <[email protected]>
Signed-off-by Paul E. McKenney <[email protected]>
--- Documentation/RCU/Design/Data-Structures/Data-Structures.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/RCU/Design/Data-Structures/Data-Structures.rst +1 -1
@@ -963,7 +963,7 @@ exit and perhaps also vice versa. Therefore, whenever the ``->dynticks_nesting`` field is incremented up from zero, the ``->dynticks_nmi_nesting`` field is set to a large positive number, and whenever the ``->dynticks_nesting`` field is decremented down to zero, -the the ``->dynticks_nmi_nesting`` field is set to zero. Assuming that +the ``->dynticks_nmi_nesting`` field is set to zero. Assuming that the number of misnested interrupts is not sufficient to overflow the counter, this approach corrects the ``->dynticks_nmi_nesting`` field every time the corresponding CPU enters the idle loop from process
Signature · 1 line
2.9.5
[email protected]
maintainerPATCH 3/3 doc: Drop doubled words from RCU requirements documentation
In reply to Paul E. McKenneyFrom: Randy Dunlap <[email protected]>
Drop the doubled words "to" and "for".
Signed-off-by Randy Dunlap <[email protected]>
Cc Jonathan Corbet <[email protected]>
Cc "Paul E. McKenney" <[email protected]>
Cc Josh Triplett <[email protected]>
Cc Steven Rostedt <[email protected]>
Cc Mathieu Desnoyers <[email protected]>
Cc Lai Jiangshan <[email protected]>
Cc Joel Fernandes <[email protected]>
Signed-off-by Paul E. McKenney <[email protected]>
--- Documentation/RCU/Design/Requirements/Requirements.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/RCU/Design/Requirements/Requirements.rst +2 -2
@@ -2162,7 +2162,7 @@ scheduling-clock interrupt be enabled when RCU needs it to be: this sort of thing. #. If a CPU is in a portion of the kernel that is absolutely positively no-joking guaranteed to never execute any RCU read-side critical - sections, and RCU believes this CPU to to be idle, no problem. This + sections, and RCU believes this CPU to be idle, no problem. This sort of thing is used by some architectures for light-weight exception handlers, which can then avoid the overhead of ``rcu_irq_enter()`` and ``rcu_irq_exit()`` at exception entry and
@@ -2431,7 +2431,7 @@ However, there are legitimate preemptible-RCU implementations that do not have this property, given that any point in the code outside of an RCU read-side critical section can be a quiescent state. Therefore, *RCU-sched* was created, which follows “classic” RCU in that an -RCU-sched grace period waits for for pre-existing interrupt and NMI +RCU-sched grace period waits for pre-existing interrupt and NMI handlers. In kernels built with ``CONFIG_PREEMPT=n``, the RCU and RCU-sched APIs have identical implementations, while kernels built with ``CONFIG_PREEMPT=y`` provide a separate implementation for each.
Signature · 1 line
2.9.5