All of lore.kernel.org
 help / color / mirror / Atom feed
From: SeongJae Park <sj@kernel.org>
To: paulmck@kernel.org
Cc: perfbook@vger.kernel.org, SeongJae Park <sj38.park@gmail.com>
Subject: [PATCH 3/5] debugging: Use \co{} for rcutorture
Date: Sun,  5 Feb 2023 10:21:26 -0800	[thread overview]
Message-ID: <20230205182128.19044-4-sj@kernel.org> (raw)
In-Reply-To: <20230205182128.19044-1-sj@kernel.org>

From: SeongJae Park <sj38.park@gmail.com>

Some sentences in debugging.tex encloses 'rcutorture' with while some
others don't.  Use \co{} consistently.

Signed-off-by: SeongJae Park <sj38.park@gmail.com>
---
 debugging/debugging.tex | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/debugging/debugging.tex b/debugging/debugging.tex
index 3ce74469..1903c5db 100644
--- a/debugging/debugging.tex
+++ b/debugging/debugging.tex
@@ -697,7 +697,7 @@ what it knows is almost always way more than your head can hold.
 For this reason, high-quality test suites normally come with sophisticated
 scripts to analyze the voluminous output.
 But beware---scripts will only notice what you tell them to.
-My rcutorture scripts are a case in point:
+My \co{rcutorture} scripts are a case in point:
 Early versions of those scripts were quite satisfied with a test run
 in which RCU \IXpl{grace period} stalled indefinitely.
 This of course resulted in the scripts being modified to detect RCU
@@ -1252,14 +1252,14 @@ of time you spent testing.
 Functional tests tend to be discrete.
 
 On the other hand, if my patch involved RCU, I would probably run
-rcutorture, which is a kernel module that, strangely enough, tests RCU\@.
+\co{rcutorture}, which is a kernel module that, strangely enough, tests RCU\@.
 Unlike booting the kernel, where the appearance of a login prompt
-signals the successful end of a discrete test, rcutorture will happily
+signals the successful end of a discrete test, \co{rcutorture} will happily
 continue torturing RCU until either the kernel crashes or until you
 tell it to stop.
-The duration of the rcutorture test is usually of more
+The duration of the \co{rcutorture} test is usually of more
 interest than the number of times you started and stopped it.
-Therefore, rcutorture is an example of a continuous test, a category
+Therefore, \co{rcutorture} is an example of a continuous test, a category
 that includes many stress tests.
 
 Statistics for discrete tests are simpler and more familiar than those
@@ -1845,7 +1845,7 @@ If the program is structured such that it is difficult or impossible
 to apply much stress to a subsystem that is under suspicion,
 a useful anti-heisenbug is a stress test that tests that subsystem in
 isolation.
-The Linux kernel's rcutorture module takes exactly this approach with RCU\@:
+The Linux kernel's \co{rcutorture} module takes exactly this approach with RCU\@:
 Applying more stress to RCU than is feasible in a production environment
 increases the probability that RCU bugs will be found during testing
 rather than in production.\footnote{
@@ -1918,7 +1918,7 @@ delay might be counted as a near miss.\footnote{
 \end{figure}
 
 For example, a low-probability bug in RCU priority boosting occurred
-roughly once every hundred hours of focused rcutorture testing.
+roughly once every hundred hours of focused \co{rcutorture} testing.
 Because it would take almost 500 hours of failure-free testing to be
 99\,\% certain that the bug's probability had been significantly reduced,
 the \co{git bisect} process
-- 
2.17.1


  parent reply	other threads:[~2023-02-05 18:21 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-02-05 18:21 [PATCH 0/5] debugging: Trivial fixups SeongJae Park
2023-02-05 18:21 ` [PATCH 1/5] debugging: Use \co{} for 'time' output examples SeongJae Park
2023-02-06  2:31   ` Akira Yokosawa
2023-02-11 17:03     ` SeongJae Park
2023-02-05 18:21 ` [PATCH 2/5] debugging: Use \co{} for 'git' and 'Fixes:' SeongJae Park
2023-02-06  2:38   ` Akira Yokosawa
2023-02-11 17:04     ` SeongJae Park
2023-02-05 18:21 ` SeongJae Park [this message]
2023-02-06  2:48   ` [PATCH 3/5] debugging: Use \co{} for rcutorture Akira Yokosawa
2023-02-06 17:40     ` Paul E. McKenney
2023-02-05 18:21 ` [PATCH 4/5] debugging: Remove unnecessary space in a sentence SeongJae Park
2023-02-06  2:53   ` Akira Yokosawa
2023-02-11 17:05     ` SeongJae Park
2023-02-05 18:21 ` [PATCH 5/5] debugging/debugging: s/remainder of a section/following sections/ SeongJae Park
2023-02-06  3:01   ` Akira Yokosawa
2023-02-06 17:33     ` Paul E. McKenney
2023-02-11 17:06       ` SeongJae Park

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230205182128.19044-4-sj@kernel.org \
    --to=sj@kernel.org \
    --cc=paulmck@kernel.org \
    --cc=perfbook@vger.kernel.org \
    --cc=sj38.park@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.