diff mbox series

[rt-tests,v1,13/23] cyclictest: Add --json to man page

Message ID 20210519170945.21941-14-dwagner@suse.de
State New
Headers show
Series Rename --output to --json | expand

Commit Message

Daniel Wagner May 19, 2021, 5:09 p.m. UTC
Add the newly introduced --json command line to the man page.

Signed-off-by: Daniel Wagner <dwagner@suse.de>
---
 src/cyclictest/cyclictest.8 | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

Comments

John Kacur May 22, 2021, 3:38 a.m. UTC | #1
On Wed, 19 May 2021, Daniel Wagner wrote:

> Add the newly introduced --json command line to the man page.

> 

> Signed-off-by: Daniel Wagner <dwagner@suse.de>

> ---

>  src/cyclictest/cyclictest.8 | 7 +++++--

>  1 file changed, 5 insertions(+), 2 deletions(-)

> 

> diff --git a/src/cyclictest/cyclictest.8 b/src/cyclictest/cyclictest.8

> index 44b5d0dbcc4a..4fe42e502535 100644

> --- a/src/cyclictest/cyclictest.8

> +++ b/src/cyclictest/cyclictest.8

> @@ -17,8 +17,8 @@ cyclictest \- High resolution test program

>  .SH SYNOPSIS

>  .SY cyclictest

>  .RI "[ \-hfmnqrsvMS ] [\-a " proc " ] [\-A " align " ] [\-b " usec " ] [\-c " clock " ] [\-d " dist " ] \

> -[\-h " histogram " ] [\-i " intv " ] [\-l " loop " ] [\-o " red " ] [\-p " prio " ] \

> -[\-t " num " ] [\-D " time "] [\-w] [\-W] [\-y " policy " ] [ \-S | \-U ]"

> +[\-h " histogram " ] [\-i " intv " ] [\-\-json " filename " ] [\-l " loop " ] [\-o " red " ] \

> +[\-p " prio " ] [\-t " num " ] [\-D " time "] [\-w] [\-W] [\-y " policy " ] [ \-S | \-U ]"

>  

>  .\" .SH DESCRIPTION

>  .\" This manual page documents briefly the

> @@ -85,6 +85,9 @@ Dump the latency histogram to <path> instead of stdout.

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

>  .TP

> +.B \-\-json=FILENAME

> +Write final results into FILENAME, JSON formatted.

> +.TP

>  .B \-l, \-\-loops=LOOPS

>  Set the number of loops. The default is 0 (endless). This option is useful for automated tests with a given number of test cycles. Cyclictest is stopped once the number of timer intervals has been reached.

>  .TP

> -- 

> 2.31.1

> 

> 

Signed-off-by: John Kacur <jkacur@redhat.com>
diff mbox series

Patch

diff --git a/src/cyclictest/cyclictest.8 b/src/cyclictest/cyclictest.8
index 44b5d0dbcc4a..4fe42e502535 100644
--- a/src/cyclictest/cyclictest.8
+++ b/src/cyclictest/cyclictest.8
@@ -17,8 +17,8 @@  cyclictest \- High resolution test program
 .SH SYNOPSIS
 .SY cyclictest
 .RI "[ \-hfmnqrsvMS ] [\-a " proc " ] [\-A " align " ] [\-b " usec " ] [\-c " clock " ] [\-d " dist " ] \
-[\-h " histogram " ] [\-i " intv " ] [\-l " loop " ] [\-o " red " ] [\-p " prio " ] \
-[\-t " num " ] [\-D " time "] [\-w] [\-W] [\-y " policy " ] [ \-S | \-U ]"
+[\-h " histogram " ] [\-i " intv " ] [\-\-json " filename " ] [\-l " loop " ] [\-o " red " ] \
+[\-p " prio " ] [\-t " num " ] [\-D " time "] [\-w] [\-W] [\-y " policy " ] [ \-S | \-U ]"
 
 .\" .SH DESCRIPTION
 .\" This manual page documents briefly the
@@ -85,6 +85,9 @@  Dump the latency histogram to <path> instead of stdout.
 .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.
 .TP
+.B \-\-json=FILENAME
+Write final results into FILENAME, JSON formatted.
+.TP
 .B \-l, \-\-loops=LOOPS
 Set the number of loops. The default is 0 (endless). This option is useful for automated tests with a given number of test cycles. Cyclictest is stopped once the number of timer intervals has been reached.
 .TP