Skip to content

Commit a6d01ef

Browse files
jeff-lien-sndkigaw
authored andcommitted
ocp: Update man page documentation for internal-log command
The man page documentation has been updated to document the change of -o for output-format and -f for output-file. Also there have been updates made to note new supported data areas. Signed-off-by: jeff-lien-sndk <[email protected]> Reviewed-by: brandon-paupore-sndk <[email protected]>
1 parent e8b8c7f commit a6d01ef

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

Documentation/nvme-ocp-internal-log.txt

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ SYNOPSIS
1414
'nvme ocp internal-log' <device>
1515
[--telemetry-log=<file> | -l <file>]
1616
[--string-log=<file> | -s <file>]
17-
[--output-file=<file> | -o <file>]
18-
[--output-format=<fmt> | -f <fmt>]
17+
[--output-file=<file> | -f <file>]
18+
[--output-format=<fmt> | -o <fmt>]
1919
[--data-area=<da> | -a <da>]
2020
[--telemetry-type=<type> | -t <type>]
2121

@@ -48,19 +48,20 @@ OPTIONS
4848
is specified, a live retrieval of payload on <device> will be
4949
performed.
5050

51-
-o <file>::
51+
-f <file>::
5252
--output-file=<file>::
53-
Filepath name to where human-readable output data will be saved to.
53+
Filepath name used as the prefix for the telemetry and string log bin files
54+
along with the human-readable parsed output file.
5455

55-
-f <fmt>::
56+
-o <fmt>::
5657
--output-format=<fmt>::
5758
Set the reporting format to 'normal', 'json'. Only one output format can be
5859
used at a time, the default value is 'json'.
5960

6061
-a <da>::
6162
--data-area=<da>::
62-
Retrieves the specific data area requested. Valid inputs are 1,2. If this
63-
option is not specified, the default value is 1.
63+
Retrieves the specific data area requested. Valid inputs are 1, 2, 3, or 4.
64+
If this option is not specified, the default value is 1.
6465

6566
-t <type>::
6667
--telemetry-type=<type>::

0 commit comments

Comments
 (0)