Skip to content

Commit 3063bda

Browse files
ocp: Update/Fix Man page for telemetry-string-log command
Renamed nvme-ocp-telemetry-string-log-page.txt to nvme-ocp-telemetry-string-log.txt so it now matches the command name. Added the output-filename options to man page documentation. Signed-off-by: jeff-lien-sndk <[email protected]>
1 parent 703e1f8 commit 3063bda

File tree

3 files changed

+13
-5
lines changed

3 files changed

+13
-5
lines changed

Documentation/cmd-plugins.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,9 @@ linknvme:nvme-micron-temperature-stats[1]::
4949
linknvme:nvme-ocp-internal-log[1]::
5050
Retrieves and parses OCP Telemetry DA1 and DA2 logs.
5151

52+
linknvme:nvme-ocp-telemetry-string-log[1]::
53+
Retrieves and parses OCP Telemetry String Log page.
54+
5255
linknvme:nvme-netapp-ontapdevices[1]::
5356
Display information about ONTAP devices
5457

Documentation/meson.build

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ adoc_sources = [
104104
'nvme-ocp-set-plp-health-check-interval',
105105
'nvme-ocp-set-telemetry-profile',
106106
'nvme-ocp-smart-add-log',
107-
'nvme-ocp-telemetry-string-log-page',
107+
'nvme-ocp-telemetry-string-log',
108108
'nvme-ocp-unsupported-reqs-log',
109109
'nvme-ocp-internal-log',
110110
'nvme-persistent-event-log',

Documentation/nvme-ocp-telemetry-string-log-page.txt renamed to Documentation/nvme-ocp-telemetry-string-log.txt

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1-
nvme-ocp-telemetry-string-log-page(1)
2-
=====================================
1+
nvme-ocp-telemetry-string-log(1)
2+
================================
33

44
NAME
55
----
6-
nvme-ocp-telemetry-string-log-page - Retrieve OCP Telemetry String Log page
6+
nvme-ocp-telemetry-string-log - Retrieve OCP Telemetry String Log page
77

88
SYNOPSIS
99
--------
1010
[verse]
11-
'nvme ocp telemetry-str-log' <device> [--output-format=<fmt> | -o <fmt>]
11+
'nvme ocp telemetry-string-log' <device>
12+
[--output-format=<fmt> | -o <fmt>]
13+
[--output-file=<file> | -f <file>]
1214

1315
DESCRIPTION
1416
-----------
@@ -28,6 +30,9 @@ OPTIONS
2830
--output-format=<fmt>::
2931
This option will set the reporting format to normal, json, or binary.
3032
Only one output format can be used at a time.
33+
-f <file>::
34+
--output-file=<file>::
35+
Filepath name to where binary output data will be saved to.
3136

3237

3338
EXAMPLES

0 commit comments

Comments
 (0)