[PATCH 0/3] appendix/toyrcu: Trivial fixups

[PATCH 0/3] appendix/toyrcu: Trivial fixups

[SeongJae Park]

This patchset contains trivial fixups for appendix/toyrcu/, which found
while doing Korean translation[1].

[1] https://github.com/sjp38/perfbook-ko_KR

SeongJae Park (3):
  appendix/toyrcu: Add missing parentheses
  appendix/toyrcu: Use \co{} for spin tool
  appendix/toyrcu: Add missing parentheses for rcu_quiescent_state()

 appendix/toyrcu/toyrcu.tex | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

-- 
2.17.1

[PATCH 1/3] appendix/toyrcu: Add missing parentheses

[SeongJae Park]

A sentence on toyrcu.tex is missing enclosing code with parentheses,
unlike other parts on the sentence.  Add the parentheses to be
consistent.

Signed-off-by: SeongJae Park <sj38.park@gmail.com>
---
 appendix/toyrcu/toyrcu.tex | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/appendix/toyrcu/toyrcu.tex b/appendix/toyrcu/toyrcu.tex
index 27c11968..1634953e 100644
--- a/appendix/toyrcu/toyrcu.tex
+++ b/appendix/toyrcu/toyrcu.tex
@@ -391,7 +391,7 @@ shows the read-side primitives of an RCU implementation that uses a pair
 of reference counters (\co{rcu_refcnt[]}),
 along with a global index that
 selects one counter out of the pair (\co{rcu_idx}),
-a per-thread nesting counter \co{rcu_nesting},
+a per-thread nesting counter (\co{rcu_nesting}),
 a per-thread snapshot of the global index (\co{rcu_read_idx}),
 and a global lock (\co{rcu_gp_lock}),
 which are themselves shown in
-- 
2.17.1

[PATCH 2/3] appendix/toyrcu: Use \co{} for spin tool

[SeongJae Park]

formalregress.tex is using \co{} for spin tool, especially when
mentionging it together with Promela.  A sentence in toyrcu.tex is not
using \co{} for same representation.  Use \co{} for consistency.

Signed-off-by: SeongJae Park <sj38.park@gmail.com>
---
 appendix/toyrcu/toyrcu.tex | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/appendix/toyrcu/toyrcu.tex b/appendix/toyrcu/toyrcu.tex
index 1634953e..4083f9f0 100644
--- a/appendix/toyrcu/toyrcu.tex
+++ b/appendix/toyrcu/toyrcu.tex
@@ -535,7 +535,7 @@ checking of \co{rcu_refcnt}.
 	data element.
 
 	Exercise for the reader:
-	Use a tool such as Promela/spin to determine which (if any) of
+	Use a tool such as Promela/\co{spin} to determine which (if any) of
 	the memory barriers in
 	\cref{lst:app:toyrcu:RCU Update Using Global Reference-Count Pair}
 	are really needed.
-- 
2.17.1

[PATCH 3/3] appendix/toyrcu: Add missing parentheses for rcu_quiescent_state()

[SeongJae Park]

Some sentences on toyrcu.tex is missing parentheses for
rcu_quiescent_state().  Add those.

Signed-off-by: SeongJae Park <sj38.park@gmail.com>
---
 appendix/toyrcu/toyrcu.tex | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/appendix/toyrcu/toyrcu.tex b/appendix/toyrcu/toyrcu.tex
index 4083f9f0..a33ccdb3 100644
--- a/appendix/toyrcu/toyrcu.tex
+++ b/appendix/toyrcu/toyrcu.tex
@@ -1447,13 +1447,13 @@ re-ordered with the \clnrefrange{gp1}{gp2}.
 	\begin{fcvref}[ln:defer:rcu_qs:read_lock_unlock:qs]
 	Doesn't the additional memory barrier shown on \clnref{mb2} of
 	\cref{lst:app:toyrcu:Quiescent-State-Based RCU Read Side}
-	greatly increase the overhead of \co{rcu_quiescent_state}?
+	greatly increase the overhead of \co{rcu_quiescent_state()}?
 	\end{fcvref}
 }\QuickQuizAnswer{
 	\begin{fcvref}[ln:defer:rcu_qs:read_lock_unlock:qs]
 	Indeed it does!
 	An application using this implementation of RCU should therefore
-	invoke \co{rcu_quiescent_state} sparingly, instead using
+	invoke \co{rcu_quiescent_state()} sparingly, instead using
 	\co{rcu_read_lock()} and \co{rcu_read_unlock()} most of the
 	time.
 
@@ -1574,7 +1574,7 @@ certain types of library functions.
 	effect extended beyond the enclosing
 	\co{rcu_read_lock()} and \co{rcu_read_unlock()}, out to
 	the previous and next call to \co{rcu_quiescent_state()}.
-	This \co{rcu_quiescent_state} can be thought of as an
+	This \co{rcu_quiescent_state()} can be thought of as an
 	\co{rcu_read_unlock()} immediately followed by an
 	\co{rcu_read_lock()}.
 
-- 
2.17.1

Re: [PATCH 0/3] appendix/toyrcu: Trivial fixups

[Paul E. McKenney]

On Sun, Jan 07, 2024 at 09:01:19AM -0800, SeongJae Park wrote:
> This patchset contains trivial fixups for appendix/toyrcu/, which found
> while doing Korean translation[1].
> 
> [1] https://github.com/sjp38/perfbook-ko_KR
> 
> SeongJae Park (3):
>   appendix/toyrcu: Add missing parentheses
>   appendix/toyrcu: Use \co{} for spin tool
>   appendix/toyrcu: Add missing parentheses for rcu_quiescent_state()

Queued and pushed, thank you!

							Thanx, Paul

>  appendix/toyrcu/toyrcu.tex | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
> 
> -- 
> 2.17.1
>