diff mbox series

[rt-tests,v1,16/23] pmqtest: Add --json to man page

Message ID 20210519170945.21941-17-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/pmqtest/pmqtest.8 | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

Comments

John Kacur May 22, 2021, 3:42 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/pmqtest/pmqtest.8 | 5 ++++-

>  1 file changed, 4 insertions(+), 1 deletion(-)

> 

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

> index 36678d0c5026..4fbcc5c27ce2 100644

> --- a/src/pmqtest/pmqtest.8

> +++ b/src/pmqtest/pmqtest.8

> @@ -4,7 +4,7 @@

>  \fBpmqtest\fR \- Start pairs of threads and measure the latency of interprocess communication with POSIX messages queues

>  .SH "SYNTAX"

>  .LP

> -pmqtest [-a|-a PROC] [-b USEC] [-d DIST] [-D TIME] [-f TO] [-h] [-i INTV] [-l LOOPS] [-p PRIO] [-q] [-S] [-t|-t NUM]

> +pmqtest [-a|-a PROC] [-b USEC] [-d DIST] [-D TIME] [-f TO] [-h] [-i INTV] [--json FILENAME] [-l LOOPS] [-p PRIO] [-q] [-S] [-t|-t NUM]

>  .br

>  .SH "DESCRIPTION"

>  .LP

> @@ -35,6 +35,9 @@ Set an artificial delay of the send function to force timeout of the receiver, r

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

>  .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. pmqtest 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/pmqtest/pmqtest.8 b/src/pmqtest/pmqtest.8
index 36678d0c5026..4fbcc5c27ce2 100644
--- a/src/pmqtest/pmqtest.8
+++ b/src/pmqtest/pmqtest.8
@@ -4,7 +4,7 @@ 
 \fBpmqtest\fR \- Start pairs of threads and measure the latency of interprocess communication with POSIX messages queues
 .SH "SYNTAX"
 .LP
-pmqtest [-a|-a PROC] [-b USEC] [-d DIST] [-D TIME] [-f TO] [-h] [-i INTV] [-l LOOPS] [-p PRIO] [-q] [-S] [-t|-t NUM]
+pmqtest [-a|-a PROC] [-b USEC] [-d DIST] [-D TIME] [-f TO] [-h] [-i INTV] [--json FILENAME] [-l LOOPS] [-p PRIO] [-q] [-S] [-t|-t NUM]
 .br
 .SH "DESCRIPTION"
 .LP
@@ -35,6 +35,9 @@  Set an artificial delay of the send function to force timeout of the receiver, r
 .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.
 .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. pmqtest is stopped once the number of timer intervals has been reached.
 .TP