Skip to content

Commit ee7c3b2

Browse files
lgdacunhigaw
authored andcommitted
documentation: Updated solidigm parse-telemetry-log source-file.
Source-file was a flag, now is gets a filename. Signed-off-by: Leonardo da Cunha <leonardo.da.cunha@solidigm.com>
1 parent a3e9352 commit ee7c3b2

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

Documentation/nvme-solidigm-parse-telemetry-log.txt

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,17 +33,18 @@ OPTIONS
3333

3434
-d <num>::
3535
--data-area=<num>::
36-
Pick which telemetry data area to report. Default is 3 to fetch areas 1-3.
36+
Pick which telemetry data area to report. Default is 1, or 3 if a config file is specified.
3737
Valid options are 1, 2, 3, 4.
3838

3939
-j <file>::
4040
--config-file=<file>::
4141
Specify a JSON configuration file for custom parsing of the telemetry log.
4242

43-
-s::
44-
--source-file::
45-
Indicates that the <device> argument is a binary file containing a log dump
46-
instead of a block or character device.
43+
-s <file>::
44+
--source-file=<file>::
45+
Specifies a binary file containing a telemetry log dump to parse instead of
46+
retrieving the log from a device. When this option is used, no device argument
47+
should be provided.
4748

4849
EXAMPLES
4950
--------
@@ -74,7 +75,7 @@ EXAMPLES
7475
* Parse a telemetry log from a binary file:
7576
+
7677
------------
77-
# nvme solidigm parse-telemetry-log telemetry_dump.bin -s
78+
# nvme solidigm parse-telemetry-log -s telemetry_dump.bin
7879
------------
7980

8081
OUTPUT

0 commit comments

Comments
 (0)