linux-rt-users.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: John Kacur <jkacur@redhat.com>
To: Clark Williams <williams@redhat.com>
Cc: RT <linux-rt-users@vger.kernel.org>
Subject: Re: [PATCH] rt-tests: Update the cyclictest man page
Date: Mon, 25 Apr 2016 18:36:29 +0200 (CEST)	[thread overview]
Message-ID: <alpine.LFD.2.20.1604251834030.6896@riemann> (raw)
In-Reply-To: <20160425111913.14c5573c@sluggy.hsv.redhat.com>



On Mon, 25 Apr 2016, Clark Williams wrote:

> On Mon, 25 Apr 2016 16:17:11 +0200 (CEST)
> John Kacur <jkacur@redhat.com> wrote:
> 
> > From 7e007ac70a83f62583d25b10ad2df0430306bf32 Mon Sep 17 00:00:00 2001
> > From: John Kacur <jkacur@redhat.com>
> > Date: Mon, 25 Apr 2016 16:08:28 +0200
> > Subject: [PATCH] rt-tests: Update the cyclictest man page
> > 
> > We have done a good job keeping cyclictest help up-to-date, but we have
> > not been actively updating the man page.
> > 
> > There were many missing options, as well as options that don't exist
> > anymore. To be more precise, some short form options had been removed,
> > but there are still corresponding long-version options.
> > 
> > This patch contains a considerable amount of updates to the man-page to
> > keep it in sync, and in some cases it also updates the cyclictest help
> > where needed. For example, the cyclictest help options were not always
> > in the proper order. In some cases I changed the wording to make it more
> > closely correspond to the man page
> > 
> > Signed-off-by: John Kacur <jkacur@redhat.com>
> > ---
> >  src/cyclictest/cyclictest.8 | 169 ++++++++++++++++++++++++--------------------
> >  src/cyclictest/cyclictest.c |  35 ++++-----
> >  2 files changed, 110 insertions(+), 94 deletions(-)
> 
> Looks good to me John. I did see one spelling issue:
> 
> > +Sned break trace command when latency > USEC
> 
> Thanks for cleaning the man page up. I'm afraid I neglected it.
> 
> Clark
> 

I ran spell on the cyclictest.8 and caught a few more spelling errors, 
I'll fold the following patch into the previous one and add your ack

Thanks

>From 6ce4dbc6e530835af8725977207af052522fb9eb Mon Sep 17 00:00:00 2001
From: John Kacur <jkacur@redhat.com>
Date: Mon, 25 Apr 2016 18:35:14 +0200
Subject: [PATCH] Fix some spelling error in the cyclictest manpage

Signed-off-by: John Kacur <jkacur@redhat.com>
---
 src/cyclictest/cyclictest.8 | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/src/cyclictest/cyclictest.8 b/src/cyclictest/cyclictest.8
index 120dae23860e..1d26ecefd010 100644
--- a/src/cyclictest/cyclictest.8
+++ b/src/cyclictest/cyclictest.8
@@ -34,7 +34,7 @@ A summary of options is included below.
 .\" For a complete description, see the Info files.
 .TP
 .B \-a, \-\-affinity[=PROC-SET]
-Run threads on the set of procesors given by PROC-SET.  If PROC-SET is not
+Run threads on the set of processors given by PROC-SET.  If PROC-SET is not
 specified, all processors will be used.  Threads will be assigned to processors
 in the set in numeric order, in a round\-robin fashion.
 .br
@@ -50,7 +50,7 @@ if specified, must be a single CPU number.
 Align thread wakeups to a specific offset in microseconds
 .TP
 .B \-b, \-\-breaktrace=USEC
-Sned break trace command when latency > USEC
+Send break trace command when latency > USEC
 .TP
 .B \-B, \-\-preemptirqs
 Both preempt and irqsoff tracing (used with -b)
@@ -89,7 +89,7 @@ Dump latency histogram to stdout after the run. US is the max latency time to be
 Same as -h except that an additional histogram column is displayed at the right that contains summary data of all thread histograms. If cyclictest runs a single thread only, the -H option is equivalent to -h.
 .TP
 .B \-\-histfile=<path>
-Dump the latecny histogram to <path> instead of stdout.
+Dump the latency histogram to <path> instead of stdout.
 .TP
 .B \-i, \-\-interval=INTV
 Set the base interval of the thread(s) in microseconds (default is 1000us). This sets the interval of the first thread. See also \-d.
@@ -123,7 +123,7 @@ Show results in nanoseconds instead of microseconds, which is the default unit.
 Oscilloscope mode, reduce verbose output by RED.
 .TP
 .B \-O, \-\-traceopt=TRACING_OPTION
-Used to pass tracing options to ftrace tracers. May be invoked mutiple
+Used to pass tracing options to ftrace tracers. May be invoked multiple
 times for multiple trace options. For example trace options look at /sys/kernel/debug/tracing/trace_options
 .TP
 .B \-p, \-\-prio=PRIO
-- 
2.4.11


      reply	other threads:[~2016-04-25 16:36 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-04-25 14:17 [PATCH] rt-tests: Update the cyclictest man page John Kacur
2016-04-25 16:19 ` Clark Williams
2016-04-25 16:36   ` John Kacur [this message]

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=alpine.LFD.2.20.1604251834030.6896@riemann \
    --to=jkacur@redhat.com \
    --cc=linux-rt-users@vger.kernel.org \
    --cc=williams@redhat.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).