diff mbox series

[rt-tests,v1,14/23] oslat: Add --json to man page

Message ID 20210519170945.21941-15-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/oslat/oslat.8 | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

Comments

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

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

> 

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

> index b481d8d82783..4b28abd24425 100644

> --- a/src/oslat/oslat.8

> +++ b/src/oslat/oslat.8

> @@ -5,8 +5,9 @@ oslat \- OS Latency Detector

>  .SH SYNOPSIS

>  .SY oslat

>  .RI "[ \-shvz ] [ \-b " bucket-size " ] [ \-B " bias " ] [ \-c " cpu-list " ] \

> -[ \-C " cpu-main-thread " ] [ \-f " rt-prio " ] [ \-m " workload-mem " ] \

> -[\-t " runtime " ] [ \-T " trace-threshold " ] [ \-w " workload " ]"

> +[ \-C " cpu-main-thread " ] [ \-f " rt-prio " ] [ \-\-json " filename " ] \

> +[ \-m " workload-mem " ] [\-t " runtime " ] [ \-T " trace-threshold " ] \

> +[ \-w " workload " ]"

>  .SH DESCRIPTION

>  .B oslat

>  is an open source userspace polling mode stress program to detect OS level

> @@ -30,6 +31,9 @@ Specify which CPU the main thread runs on.  Default is cpu0.

>  Using specific SCHED_FIFO priority (1-99).  Otherwise use the default

>  priority, normally it will be SCHED_OTHER.

>  .TP

> +.B \-\-json=FILENAME

> +Write final results into FILENAME, JSON formatted.

> +.TP

>  .B \-m, \-\-workload-mem=SIZE

>  Size of the memory to use for the workload (e.g., 4K, 1M).

>  Total memory usage will be this value multiplies 2*N,

> -- 

> 2.31.1

> 

> 

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

Patch

diff --git a/src/oslat/oslat.8 b/src/oslat/oslat.8
index b481d8d82783..4b28abd24425 100644
--- a/src/oslat/oslat.8
+++ b/src/oslat/oslat.8
@@ -5,8 +5,9 @@  oslat \- OS Latency Detector
 .SH SYNOPSIS
 .SY oslat
 .RI "[ \-shvz ] [ \-b " bucket-size " ] [ \-B " bias " ] [ \-c " cpu-list " ] \
-[ \-C " cpu-main-thread " ] [ \-f " rt-prio " ] [ \-m " workload-mem " ] \
-[\-t " runtime " ] [ \-T " trace-threshold " ] [ \-w " workload " ]"
+[ \-C " cpu-main-thread " ] [ \-f " rt-prio " ] [ \-\-json " filename " ] \
+[ \-m " workload-mem " ] [\-t " runtime " ] [ \-T " trace-threshold " ] \
+[ \-w " workload " ]"
 .SH DESCRIPTION
 .B oslat
 is an open source userspace polling mode stress program to detect OS level
@@ -30,6 +31,9 @@  Specify which CPU the main thread runs on.  Default is cpu0.
 Using specific SCHED_FIFO priority (1-99).  Otherwise use the default
 priority, normally it will be SCHED_OTHER.
 .TP
+.B \-\-json=FILENAME
+Write final results into FILENAME, JSON formatted.
+.TP
 .B \-m, \-\-workload-mem=SIZE
 Size of the memory to use for the workload (e.g., 4K, 1M).
 Total memory usage will be this value multiplies 2*N,