From: Leonardo da Cunha <leonardo.da.cunha@solidigm.com>
Date: Fri, 21 Mar 2025 00:11:38 +0000 (-0700)
Subject: documentation: Updated solidigm parse-telemetry-log source-file.
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=ee7c3b238127997330c98accf50e2f746f51f714;p=users%2Fsagi%2Fnvme-cli.git

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

diff --git a/Documentation/nvme-solidigm-parse-telemetry-log.txt b/Documentation/nvme-solidigm-parse-telemetry-log.txt
index 38a678bd..d152e448 100644
--- a/Documentation/nvme-solidigm-parse-telemetry-log.txt
+++ b/Documentation/nvme-solidigm-parse-telemetry-log.txt
@@ -33,17 +33,18 @@ OPTIONS
 
 -d <num>::
 --data-area=<num>::
-    Pick which telemetry data area to report. Default is 3 to fetch areas 1-3.
+    Pick which telemetry data area to report. Default is 1, or 3 if a config file is specified.
     Valid options are 1, 2, 3, 4.
 
 -j <file>::
 --config-file=<file>::
     Specify a JSON configuration file for custom parsing of the telemetry log.
 
--s::
---source-file::
-    Indicates that the <device> argument is a binary file containing a log dump
-    instead of a block or character device.
+-s <file>::
+--source-file=<file>::
+    Specifies a binary file containing a telemetry log dump to parse instead of
+    retrieving the log from a device. When this option is used, no device argument
+    should be provided.
 
 EXAMPLES
 --------
@@ -74,7 +75,7 @@ EXAMPLES
 * Parse a telemetry log from a binary file:
 +
 ------------
-# nvme solidigm parse-telemetry-log telemetry_dump.bin -s
+# nvme solidigm parse-telemetry-log -s telemetry_dump.bin
 ------------
 
 OUTPUT