Skip to contentSkip to conversation

defer/rcuintro: Add indexing tags to RCU Core APIs

PATCH In review Akira Yokosawa 2 participants 5 messages Jan 8, 2022 – Jan 9, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/4 defer/rcuintro: Add indexing tags to RCU Core APIs

---
 defer/rcuintro.tex | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
defer/rcuintro.tex +5 -5
index 2b72e49b..39f33650 100644
@@ -195,13 +195,13 @@ its fundamentals.
 The full API is covered in \cref{sec:defer:RCU Linux-Kernel API}.
 
 Three members of the core APIs are used by readers.
-The \co{rcu_read_lock()} and \co{rcu_read_unlock()} functions delimit
+The \apik{rcu_read_lock()} and \apik{rcu_read_unlock()} functions delimit
 RCU read-side critical sections.
 These may be nested, so that one \co{rcu_read_lock()}-\co{rcu_read_unlock()}
 pair can be enclosed within another.
 In this case, the nested set of RCU read-side critical section act as
 one large critical section covering the full extent of the nested set.
-The third read-side API member, \co{rcu_dereference()}, fetches an
+The third read-side API member, \apik{rcu_dereference()}, fetches an
 RCU-protected pointer.
 Conceptually, \co{rcu_dereference()} simply loads from memory, but we
 will see in
@@ -211,12 +211,12 @@ one case) the CPU from reordering its load with later memory operations
 that dereference this pointer.
 
 The other three members of the core APIs are used by updaters.
-The \co{synchronize_rcu()} function implements the ``wait for readers''
+The \apik{synchronize_rcu()} function implements the ``wait for readers''
 operation from \cref{fig:defer:Deletion With Concurrent Readers}.
-The \co{call_rcu()} function is the asynchronous counterpart of
+The \apik{call_rcu()} function is the asynchronous counterpart of
 \co{synchronize_rcu()} by invoking the specified function after
 all pre-existing RCU readers have completed.
-Finally, the \co{rcu_assign_pointer()} macro is used to update an
+Finally, the \apik{rcu_assign_pointer()} macro is used to update an
 RCU-protected pointer.
 Conceptually, this is simply an assignment statement, but we will
 see in

base-commit: 2b732c65e2a322eef7d27f65826330c9b93db2e0

Signature · 1 line
2.17.1
#1 lore raw

PATCH 2/4 defer/rcuintro: Use endash for pair of rcu_read_lock() and rcu_read_unlock()

Use endash for a range of things (in this case a range of code).

---
 defer/rcuintro.tex | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
defer/rcuintro.tex +1 -1
index 39f33650..c5f2663b 100644
@@ -197,7 +197,7 @@ The full API is covered in \cref{sec:defer:RCU Linux-Kernel API}.
 Three members of the core APIs are used by readers.
 The \apik{rcu_read_lock()} and \apik{rcu_read_unlock()} functions delimit
 RCU read-side critical sections.
-These may be nested, so that one \co{rcu_read_lock()}-\co{rcu_read_unlock()}
+These may be nested, so that one \co{rcu_read_lock()}--\co{rcu_read_unlock()}
 pair can be enclosed within another.
 In this case, the nested set of RCU read-side critical section act as
 one large critical section covering the full extent of the nested set.
Signature · 1 line
2.17.1
#2 lore raw

PATCH 3/4 defer/rcuintro: Fix trivial typos

In reply to Akira Yokosawa

---
Paul,

I think "the" in "the Section xxx" is redundant.
But please check before applying this.
2nd hunk should be the right fix.

Thanks, Akira
--

 defer/rcuintro.tex | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
defer/rcuintro.tex +2 -2
index c5f2663b..bb79ec0b 100644
@@ -181,7 +181,7 @@ So perhaps going all the way was not too far after all!
 
 But how can we tell when all of the pre-existing readers have in
 fact completed?
-This question is the topic of the \cref{sec:defer:Waiting for Readers}.
+This question is the topic of \cref{sec:defer:Waiting for Readers}.
 But first, the next section defines RCU's core API.
 
 \subsubsection{Core RCU API}
@@ -199,7 +199,7 @@ The \apik{rcu_read_lock()} and \apik{rcu_read_unlock()} functions delimit
 RCU read-side critical sections.
 These may be nested, so that one \co{rcu_read_lock()}--\co{rcu_read_unlock()}
 pair can be enclosed within another.
-In this case, the nested set of RCU read-side critical section act as
+In this case, the nested set of RCU read-side critical sections act as
 one large critical section covering the full extent of the nested set.
 The third read-side API member, \apik{rcu_dereference()}, fetches an
 RCU-protected pointer.
Signature · 1 line
2.17.1
#3 lore raw

PATCH 4/4 defer/rcuintro: Use nbsp around short numbers

In reply to Akira Yokosawa
---
 defer/rcuintro.tex | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
defer/rcuintro.tex +2 -2
index bb79ec0b..52a52ca8 100644
@@ -95,9 +95,9 @@ Again taking the lessons from
 to heart, \co{smp_store_release()} is used to \co{NULL} the pointer,
 thus moving from the first row to the second in the figure.
 At this point, pre-existing readers see the old structure with
-\co{->addr} of 42 and \co{->iface} of 1, but new readers will see
+\co{->addr} of~42 and \co{->iface} of~1, but new readers will see
 a \co{NULL} pointer, that is, concurrent readers can disagree on
-the state, as indicated by the ``2 Versions'' in the figure.
+the state, as indicated by the ``2~Versions'' in the figure.
 
 \QuickQuizSeries{%
 \QuickQuizB{
Signature · 1 line
2.17.1
#4 lore raw
In reply to Akira Yokosawa
Quoted 1 line · Akira Yokosawa

They all look good. Queued and pushed, thank you!

Thanx, Paul

Quoted 45 lines
---
 defer/rcuintro.tex | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
defer/rcuintro.tex +5 -5
index 2b72e49b..39f33650 100644
@@ -195,13 +195,13 @@ its fundamentals.
 The full API is covered in \cref{sec:defer:RCU Linux-Kernel API}.
 
 Three members of the core APIs are used by readers.
-The \co{rcu_read_lock()} and \co{rcu_read_unlock()} functions delimit
+The \apik{rcu_read_lock()} and \apik{rcu_read_unlock()} functions delimit
 RCU read-side critical sections.
 These may be nested, so that one \co{rcu_read_lock()}-\co{rcu_read_unlock()}
 pair can be enclosed within another.
 In this case, the nested set of RCU read-side critical section act as
 one large critical section covering the full extent of the nested set.
-The third read-side API member, \co{rcu_dereference()}, fetches an
+The third read-side API member, \apik{rcu_dereference()}, fetches an
 RCU-protected pointer.
 Conceptually, \co{rcu_dereference()} simply loads from memory, but we
 will see in
@@ -211,12 +211,12 @@ one case) the CPU from reordering its load with later memory operations
 that dereference this pointer.
 
 The other three members of the core APIs are used by updaters.
-The \co{synchronize_rcu()} function implements the ``wait for readers''
+The \apik{synchronize_rcu()} function implements the ``wait for readers''
 operation from \cref{fig:defer:Deletion With Concurrent Readers}.
-The \co{call_rcu()} function is the asynchronous counterpart of
+The \apik{call_rcu()} function is the asynchronous counterpart of
 \co{synchronize_rcu()} by invoking the specified function after
 all pre-existing RCU readers have completed.
-Finally, the \co{rcu_assign_pointer()} macro is used to update an
+Finally, the \apik{rcu_assign_pointer()} macro is used to update an
 RCU-protected pointer.
 Conceptually, this is simply an assignment statement, but we will
 see in

base-commit: 2b732c65e2a322eef7d27f65826330c9b93db2e0

Signature · 1 line
2.17.1