Skip to contentSkip to conversation

memorder: Fix typos

PATCH In review SeongJae Park 2 participants 3 messages Jan 5, 2019

lore
Share & tools
lore
#0 lore raw

PATCH 1/2 memorder: Fix typos

---
 memorder/memorder.tex | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
memorder/memorder.tex +2 -2
index cb4d037..56786fa 100644
@@ -541,13 +541,13 @@ Blank cells indicate that no ordering is supplied.
 The ``Store'' row also covers the store portion of an atomic RMW operation.
 In addition, the ``Load'' row covers the load
 component of a successful value-returning \co{_relaxed()} RMW atomic
-operation, although the combined ``\co{_relaxed()} RMW Operations''
+operation, although the combined ``\co{_relaxed()} RMW operation''
 line provides a convenient combined reference in the value-returning case.
 A CPU executing unsuccessful value-returning atomic RMW operations must
 invalidate the corresponding variable from all other CPUs' caches.
 Therefore, oddly enough, unsuccessful value-returning atomic RMW
 operations have many of the properties of a store, which means that the
-``\co{_relaxed()} RMW Operations'' line also applies to unsuccessful
+``\co{_relaxed()} RMW operation'' line also applies to unsuccessful
 value-returning atomic RMW operations.
 
 The \co{*_acquire} row covers \co{smp_load_acquire()},
Signature · 1 line
2.10.0
#1 lore raw

PATCH 2/2 debugging: Leave double dashes in description headings

A description in debugging chapter is using '\tco' identifier for command options which start with '--'. However, '--' inside '\tco' identifier is converted to a n-dash so that readers could misunderstood. To avoid such confusion, this commit avoids the conversion via an ugly walkaround.

---
 debugging/debugging.tex | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)
debugging/debugging.tex +7 -7
index 67e575c..5b2ce27 100644
@@ -2287,16 +2287,16 @@ and output consists of one line for each input line, with fields as follows:
 This script takes three optional arguments as follows:
 
 \begin{description}
-\item	[\tco{--divisor}\nf{:}] Number of segments to divide the list into,
-	for example, a divisor of four means that the first quarter
-	of the data elements will be assumed to be good.
+\item	[\tco{-}\tco{-divisor}\nf{:}] Number of segments to divide the list
+	into, for example, a divisor of four means that the first quarter of
+	the data elements will be assumed to be good.
 	This defaults to three.
-\item	[\tco{--relerr}\nf{:}] Relative measurement error.  The script assumes
-	that values that differ by less than this error are for all
+\item	[\tco{-}\tco{-relerr}\nf{:}] Relative measurement error.  The script
+	assumes that values that differ by less than this error are for all
 	intents and purposes equal.
 	This defaults to 0.01, which is equivalent to 1\,\%.
-\item	[\tco{--trendbreak}\nf{:}] Ratio of inter-element spacing constituting
-	a break in the trend of the data.
+\item	[\tco{-}\tco{-trendbreak}\nf{:}] Ratio of inter-element spacing
+	constituting a break in the trend of the data.
 	For example, if the average spacing in the data accepted so far
 	is 1.5, then if the trend-break ratio is 2.0, then if the next
 	data value differs from the last one by more than 3.0, this
Signature · 1 line
2.10.0
#2 lore raw
In reply to SeongJae Park
Quoted 1 line · SeongJae Park

Good catches, applied and pushed both, thank you!

Thanx, Paul

Quoted 27 lines
---
 memorder/memorder.tex | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
memorder/memorder.tex +2 -2
index cb4d037..56786fa 100644
@@ -541,13 +541,13 @@ Blank cells indicate that no ordering is supplied.
 The ``Store'' row also covers the store portion of an atomic RMW operation.
 In addition, the ``Load'' row covers the load
 component of a successful value-returning \co{_relaxed()} RMW atomic
-operation, although the combined ``\co{_relaxed()} RMW Operations''
+operation, although the combined ``\co{_relaxed()} RMW operation''
 line provides a convenient combined reference in the value-returning case.
 A CPU executing unsuccessful value-returning atomic RMW operations must
 invalidate the corresponding variable from all other CPUs' caches.
 Therefore, oddly enough, unsuccessful value-returning atomic RMW
 operations have many of the properties of a store, which means that the
-``\co{_relaxed()} RMW Operations'' line also applies to unsuccessful
+``\co{_relaxed()} RMW operation'' line also applies to unsuccessful
 value-returning atomic RMW operations.
 
 The \co{*_acquire} row covers \co{smp_load_acquire()},
Signature · 1 line
2.10.0