linux-rt-users.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 0/2] rt-tests: Housekeeping
@ 2016-05-13 13:11 John Kacur
  2016-05-13 13:11 ` [PATCH 1/2] rt-tests: Add missing option to hwlatdetect man page John Kacur
  2016-05-13 13:11 ` [PATCH 2/2] rt-tests: Housekeeping fix some spelling errors John Kacur
  0 siblings, 2 replies; 3+ messages in thread
From: John Kacur @ 2016-05-13 13:11 UTC (permalink / raw)
  To: rt-users; +Cc: Clark Williams, John Kacur

Just doing a little housekeeping before releasing rt-tests-1.0

John Kacur (2):
  rt-tests: Add missing option to hwlatdetect man page
  rt-tests: Housekeeping fix some spelling errors.

 src/backfire/sendme.8         |  2 +-
 src/hwlatdetect/hwlatdetect.8 | 12 ++++++++----
 src/pi_tests/pi_stress.8      |  2 +-
 src/pmqtest/pmqtest.8         |  4 ++--
 src/ptsematest/ptsematest.8   |  6 +++---
 src/signaltest/signaltest.8   |  2 +-
 src/sigwaittest/sigwaittest.8 |  8 ++++----
 src/svsematest/svsematest.8   |  6 +++---
 8 files changed, 23 insertions(+), 19 deletions(-)

-- 
2.4.11


^ permalink raw reply	[flat|nested] 3+ messages in thread

* [PATCH 1/2] rt-tests: Add missing option to hwlatdetect man page
  2016-05-13 13:11 [PATCH 0/2] rt-tests: Housekeeping John Kacur
@ 2016-05-13 13:11 ` John Kacur
  2016-05-13 13:11 ` [PATCH 2/2] rt-tests: Housekeeping fix some spelling errors John Kacur
  1 sibling, 0 replies; 3+ messages in thread
From: John Kacur @ 2016-05-13 13:11 UTC (permalink / raw)
  To: rt-users; +Cc: Clark Williams, John Kacur

Add --watch to the man page. Correct a few spelling errors at the same
time.

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

diff --git a/src/hwlatdetect/hwlatdetect.8 b/src/hwlatdetect/hwlatdetect.8
index 2904e5fd8fde..645fb7d8e6c1 100644
--- a/src/hwlatdetect/hwlatdetect.8
+++ b/src/hwlatdetect/hwlatdetect.8
@@ -18,13 +18,13 @@ hwlatdetect \- program to control the kernel hardware latency detection module
 .B hwlatdetect
 .RI "[ \-\-duration=<time> ] [\-\-threshold=<usecs> ] \
 [\-\-window=<time interval> ] [\-\-width=<time interval> ] [\-\-report=<path> ] \
-[\-\-cleanup ] [\-\-debug ] [\-\-quiet ]
+[\-\-cleanup ] [\-\-debug ] [\-\-quiet ] [--watch]
 
 .\" .SH DESCRIPTION
 .\" This manual page documents briefly the
 .\" .B hwlatdetect commands.
 .\" .PP
-.\" \fI<whatever>\fP escape sequences to invode bold face and italics, respectively.
+.\" \fI<whatever>\fP escape sequences to invoke bold face and italics, respectively.
 .\" \fBhwlatdetect\fP is a program that...
 .SH DESCRIPTION
 \fBhwlatdetect\fP is a program that controls the kernel hardware
@@ -38,7 +38,7 @@ written for use by the "RT" patch since the Real Time kernel is highly
 latency sensitive. 
 
 SMIs are usually not serviced by the Linux kernel, which typically does not
-even know that they are occuring. SMIs are instead are set up by BIOS code
+even know that they are occurring. SMIs are instead are set up by BIOS code
 and are serviced by BIOS code, usually for "critical" events such as
 management of thermal sensors and fans. Sometimes though, SMIs are used for
 other tasks and those tasks can spend an inordinate amount of time in the
@@ -68,7 +68,7 @@ optional suffix may be specified to indicate minutes, hours or days.
 .TP
 .B \-\-threshold=<microsecond value>
 Specify the TSC gap used to detect an SMI. Any gap value greater than
-<theshold> is considered to be the result of an SMI occuring. 
+<threshold> is considered to be the result of an SMI occurring. 
 
 .TP
 .B \-\-window=<time value>{us,ms,s,m,d}
@@ -92,6 +92,10 @@ Turn on debug prints
 .TP
 .B \-\-quiet
 Turn off all information prints
+.TP
+.B \-\-watch
+print sample data to stdout as it arrives
+
 .\" .SH SEE ALSO
 .\" .BR bar (1),
 .\" .BR baz (1).
-- 
2.4.11


^ permalink raw reply related	[flat|nested] 3+ messages in thread

* [PATCH 2/2] rt-tests: Housekeeping fix some spelling errors.
  2016-05-13 13:11 [PATCH 0/2] rt-tests: Housekeeping John Kacur
  2016-05-13 13:11 ` [PATCH 1/2] rt-tests: Add missing option to hwlatdetect man page John Kacur
@ 2016-05-13 13:11 ` John Kacur
  1 sibling, 0 replies; 3+ messages in thread
From: John Kacur @ 2016-05-13 13:11 UTC (permalink / raw)
  To: rt-users; +Cc: Clark Williams, John Kacur

Fix a number of errors like procesor->processor, specifed->specified and
cylictest->cyclictest.

Note, Uwe Kleine-König <ukleinek@debian.org> pointed out some of these
spelling errors previously.

Signed-off-by: John Kacur <jkacur@redhat.com>
---
 src/backfire/sendme.8         | 2 +-
 src/pi_tests/pi_stress.8      | 2 +-
 src/pmqtest/pmqtest.8         | 4 ++--
 src/ptsematest/ptsematest.8   | 6 +++---
 src/signaltest/signaltest.8   | 2 +-
 src/sigwaittest/sigwaittest.8 | 8 ++++----
 src/svsematest/svsematest.8   | 6 +++---
 7 files changed, 15 insertions(+), 15 deletions(-)

diff --git a/src/backfire/sendme.8 b/src/backfire/sendme.8
index b9857ab6eba8..05f3a1c14d8b 100644
--- a/src/backfire/sendme.8
+++ b/src/backfire/sendme.8
@@ -12,7 +12,7 @@ The program \fBsendme\fR uses the \fBbackfire\fR driver to send a signal from dr
 .SH "OPTIONS"
 .TP
 .B \-a, \-\-affinity[=PROC]
-Run on procesor number PROC. If PROC is not specified, run on current processor.
+Run on processor number PROC. If PROC is not specified, run on current processor.
 .TP
 .B \-b, \-\-breaktrace=USEC
 Send break trace command when latency > USEC. This is a debugging option to control the latency tracer in the realtime preemption patch.
diff --git a/src/pi_tests/pi_stress.8 b/src/pi_tests/pi_stress.8
index 4fecab5b7bd4..c92b4bdf5609 100644
--- a/src/pi_tests/pi_stress.8
+++ b/src/pi_tests/pi_stress.8
@@ -38,7 +38,7 @@ code paths for POSIX mutexes, in both the Linux kernel and the C
 library. It runs as a realtime-priority task and launches
 .IR "inversion machine"
 thread groups. Each inversion group causes a
-.IR "priorty inversion"
+.IR "priority inversion"
 condition that will deadlock if 
 .IR "priority inheritance"
 doesn't work.
diff --git a/src/pmqtest/pmqtest.8 b/src/pmqtest/pmqtest.8
index 6e9719815165..05421e01e70b 100644
--- a/src/pmqtest/pmqtest.8
+++ b/src/pmqtest/pmqtest.8
@@ -12,7 +12,7 @@ The program \fBpmqtest\fR starts pairs of threads that are synchronized via mq_s
 .SH "OPTIONS"
 .TP
 .B \-a, \-\-affinity[=PROC]
-Run on procesor number PROC. If PROC is not specified, run on current processor.
+Run on processor number PROC. If PROC is not specified, run on current processor.
 .TP
 .B \-b, \-\-breaktrace=USEC
 Send break trace command when latency > USEC. This is a debugging option to control the latency tracer in the realtime preemption patch.
@@ -37,7 +37,7 @@ Set the priority of the process.
 Test mode for symmetric multi-processing, implies -a and -t and uses the same priority on all threads.
 .TP
 .B \-t, \-\-threads[=NUM]
-Set the number of test threads (default is 1, if this option is not given). If NUM is specified, create NUM test threads. If NUM is not specifed, NUM is set to the number of available CPUs.
+Set the number of test threads (default is 1, if this option is not given). If NUM is specified, create NUM test threads. If NUM is not specified, NUM is set to the number of available CPUs.
 .TP
 .B \-T, \-\-timeout=TO
 Use mq_timedreceive() instead of mq_receive() and specify timeout TO in seconds.
diff --git a/src/ptsematest/ptsematest.8 b/src/ptsematest/ptsematest.8
index 001e80936349..9d835337ec27 100644
--- a/src/ptsematest/ptsematest.8
+++ b/src/ptsematest/ptsematest.8
@@ -12,14 +12,14 @@ The program \fBptsematest\fR starts two threads that are synchronized via pthrea
 .SH "OPTIONS"
 .TP
 .B \-a, \-\-affinity[=PROC]
-Run on procesor number PROC. If PROC is not specified, run on current processor.
+Run on processor number PROC. If PROC is not specified, run on current processor.
 .TP
 .B \-b, \-\-breaktrace=USEC
 Send break trace command when latency > USEC. This is a debugging option to control the latency tracer in the realtime preemption patch.
 It is useful to track down unexpected large latencies of a system.
 .TP
 .B \-d, \-\-distance=DIST
-Set the distance of thread intervals in microseconds (default is 500 us). When  cylictest is called with the -t option and more than one thread is created, then this distance value is added to the interval of the threads: Interval(thread N) = Interval(thread N-1) + DIST
+Set the distance of thread intervals in microseconds (default is 500 us). When  cyclictest is called with the -t option and more than one thread is created, then this distance value is added to the interval of the threads: Interval(thread N) = Interval(thread N-1) + DIST
 .TP
 .B \-i, \-\-interval=INTV
 Set the base interval of the thread(s) in microseconds (default is 1000 us). This sets the interval of the first thread. See also -d.
@@ -31,7 +31,7 @@ Set the number of loops. The default is 0 (endless). This option is useful for a
 Set the priority of the process.
 .TP
 .B \-t, \-\-threads[=NUM]
-Set the number of test threads (default is 1, if this option is not given). If NUM is specified, create NUM test threads. If NUM is not specifed, NUM is set to the number of available CPUs.
+Set the number of test threads (default is 1, if this option is not given). If NUM is specified, create NUM test threads. If NUM is not specified, NUM is set to the number of available CPUs.
 .SH "EXAMPLES"
 The following example was running on a 4-way processor:
 .LP
diff --git a/src/signaltest/signaltest.8 b/src/signaltest/signaltest.8
index d6c11c213e11..634d392a6da5 100644
--- a/src/signaltest/signaltest.8
+++ b/src/signaltest/signaltest.8
@@ -11,7 +11,7 @@ These programs follow the usual GNU command line syntax, with long options
 starting with two dashes ('\-\-').
 .TP
 .B \-b, \-\-breaktrace=USEC
-Send break trace command whn latency > USEC
+Send break trace command when latency > USEC
 .TP
 .B \-l, \-\-loops=LOOPS
 Number of loops: default=0 (endless)
diff --git a/src/sigwaittest/sigwaittest.8 b/src/sigwaittest/sigwaittest.8
index 89a97f1e7557..2290ca2c76bc 100644
--- a/src/sigwaittest/sigwaittest.8
+++ b/src/sigwaittest/sigwaittest.8
@@ -8,18 +8,18 @@ sigwaittest [-a|-a PROC] [-b USEC] [-d DIST] [-f] [-i INTV] [-l loops] [-p PRIO]
 .br
 .SH "DESCRIPTION"
 .LP
-The program \fBsigwaittest\fR starts two threads or, optionally, forks two processes that are synchonized via signals and measures the latency between sending a signal and returning from sigwait().
+The program \fBsigwaittest\fR starts two threads or, optionally, forks two processes that are synchronized via signals and measures the latency between sending a signal and returning from sigwait().
 .SH "OPTIONS"
 .TP
 .B \-a, \-\-affinity[=PROC]
-Run on procesor number PROC. If PROC is not specified, run on current processor.
+Run on processor number PROC. If PROC is not specified, run on current processor.
 .TP
 .B \-b, \-\-breaktrace=USEC
 Send break trace command when latency > USEC. This is a debugging option to control the latency tracer in the realtime preemption patch.
 It is useful to track down unexpected large latencies of a system.
 .TP
 .B \-d, \-\-distance=DIST
-Set the distance of thread intervals in microseconds (default is 500 us). When  cylictest is called with the -t option and more than one thread is created, then this distance value is added to the interval of the threads: Interval(thread N) = Interval(thread N-1) + DIST
+Set the distance of thread intervals in microseconds (default is 500 us). When  cyclictest is called with the -t option and more than one thread is created, then this distance value is added to the interval of the threads: Interval(thread N) = Interval(thread N-1) + DIST
 .TP
 .B \-f, \-\-fork
 Instead of creating threads (which is the default), fork new processes
@@ -34,7 +34,7 @@ Set the number of loops. The default is 0 (endless). This option is useful for a
 Set the priority of the process.
 .TP
 .B \-t, \-\-threads[=NUM]
-Set the number of test threads (default is 1, if this option is not given). If NUM is specified, create NUM test threads. If NUM is not specifed, NUM is set to the number of available CPUs.
+Set the number of test threads (default is 1, if this option is not given). If NUM is specified, create NUM test threads. If NUM is not specified, NUM is set to the number of available CPUs.
 .SH "EXAMPLES"
 The following example was running on a 4-way CPU:
 .LP
diff --git a/src/svsematest/svsematest.8 b/src/svsematest/svsematest.8
index 93b163ea4dc0..0d4eaf3bb7ff 100644
--- a/src/svsematest/svsematest.8
+++ b/src/svsematest/svsematest.8
@@ -12,14 +12,14 @@ The program \fBsvsematest\fR starts two threads or, optionally, forks two proces
 .SH "OPTIONS"
 .TP
 .B \-a, \-\-affinity[=PROC]
-Run on procesor number PROC. If PROC is not specified, run on current processor.
+Run on processor number PROC. If PROC is not specified, run on current processor.
 .TP
 .B \-b, \-\-breaktrace=USEC
 Send break trace command when latency > USEC. This is a debugging option to control the latency tracer in the realtime preemption patch.
 It is useful to track down unexpected large latencies of a system.
 .TP
 .B \-d, \-\-distance=DIST
-Set the distance of thread intervals in microseconds (default is 500 us). When  cylictest is called with the -t option and more than one thread is created, then this distance value is added to the interval of the threads: Interval(thread N) = Interval(thread N-1) + DIST
+Set the distance of thread intervals in microseconds (default is 500 us). When  cyclictest is called with the -t option and more than one thread is created, then this distance value is added to the interval of the threads: Interval(thread N) = Interval(thread N-1) + DIST
 .TP
 .B \-f, \-\-fork
 Instead of creating threads (which is the default), fork new processes
@@ -34,7 +34,7 @@ Set the number of loops. The default is 0 (endless). This option is useful for a
 Set the priority of the process.
 .TP
 .B \-t, \-\-threads[=NUM]
-Set the number of test threads (default is 1, if this option is not given). If NUM is specified, create NUM test threads. If NUM is not specifed, NUM is set to the number of available CPUs.
+Set the number of test threads (default is 1, if this option is not given). If NUM is specified, create NUM test threads. If NUM is not specified, NUM is set to the number of available CPUs.
 .SH "EXAMPLES"
 The following example was running on a 4-way CPU:
 .LP
-- 
2.4.11

--
To unsubscribe from this list: send the line "unsubscribe linux-rt-users" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

^ permalink raw reply related	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2016-05-13 13:12 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2016-05-13 13:11 [PATCH 0/2] rt-tests: Housekeeping John Kacur
2016-05-13 13:11 ` [PATCH 1/2] rt-tests: Add missing option to hwlatdetect man page John Kacur
2016-05-13 13:11 ` [PATCH 2/2] rt-tests: Housekeeping fix some spelling errors John Kacur

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).