Re: [PATCH] Documentation: Rename rcu_node_context_switch() to rcu_note_context_switch()

From: Paul E. McKenney
Date: Tue Aug 27 2019 - 12:03:11 EST


On Tue, Aug 27, 2019 at 11:36:03AM +0200, Sebastian Andrzej Siewior wrote:
> While Paul was explaning some RCU magic I noticed a typo in
> rcu_note_context_switch().
> Replace rcu_node_context_switch() with rcu_note_context_switch().
>
> Signed-off-by: Sebastian Andrzej Siewior <bigeasy@xxxxxxxxxxxxx>

Good eyes, queued for v5.5, thank you!

Sounds like I should explain RCU magic more often, then. ;-)

Thanx, Paul

> ---
> .../RCU/Design/Memory-Ordering/Tree-RCU-Memory-Ordering.html | 2 +-
> Documentation/RCU/Design/Memory-Ordering/TreeRCU-gp.svg | 2 +-
> Documentation/RCU/Design/Memory-Ordering/TreeRCU-qs.svg | 2 +-
> 3 files changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/RCU/Design/Memory-Ordering/Tree-RCU-Memory-Ordering.html b/Documentation/RCU/Design/Memory-Ordering/Tree-RCU-Memory-Ordering.html
> index c64f8d26609fb..54db02b74f636 100644
> --- a/Documentation/RCU/Design/Memory-Ordering/Tree-RCU-Memory-Ordering.html
> +++ b/Documentation/RCU/Design/Memory-Ordering/Tree-RCU-Memory-Ordering.html
> @@ -481,7 +481,7 @@ section that the grace period must wait on.
> </table>
>
> <p>If the CPU does a context switch, a quiescent state will be
> -noted by <tt>rcu_node_context_switch()</tt> on the left.
> +noted by <tt>rcu_note_context_switch()</tt> on the left.
> On the other hand, if the CPU takes a scheduler-clock interrupt
> while executing in usermode, a quiescent state will be noted by
> <tt>rcu_sched_clock_irq()</tt> on the right.
> diff --git a/Documentation/RCU/Design/Memory-Ordering/TreeRCU-gp.svg b/Documentation/RCU/Design/Memory-Ordering/TreeRCU-gp.svg
> index 2bcd742d6e491..069f6f8371c20 100644
> --- a/Documentation/RCU/Design/Memory-Ordering/TreeRCU-gp.svg
> +++ b/Documentation/RCU/Design/Memory-Ordering/TreeRCU-gp.svg
> @@ -3880,7 +3880,7 @@
> font-style="normal"
> y="-4418.6582"
> x="3745.7725"
> - xml:space="preserve">rcu_node_context_switch()</text>
> + xml:space="preserve">rcu_note_context_switch()</text>
> </g>
> <g
> transform="translate(1881.1886,54048.57)"
> diff --git a/Documentation/RCU/Design/Memory-Ordering/TreeRCU-qs.svg b/Documentation/RCU/Design/Memory-Ordering/TreeRCU-qs.svg
> index 779c9ac31a527..7d6c5f7e505c6 100644
> --- a/Documentation/RCU/Design/Memory-Ordering/TreeRCU-qs.svg
> +++ b/Documentation/RCU/Design/Memory-Ordering/TreeRCU-qs.svg
> @@ -753,7 +753,7 @@
> font-style="normal"
> y="-4418.6582"
> x="3745.7725"
> - xml:space="preserve">rcu_node_context_switch()</text>
> + xml:space="preserve">rcu_note_context_switch()</text>
> </g>
> <g
> transform="translate(3131.2648,-585.6713)"
> --
> 2.23.0
>