Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Documentation/nvme-intel-internal-log.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ SYNOPSIS
[--region=<NUM>, r <NUM>]
[--nlognum=<NUM>, m <NUM>]
[--namespace-id=<NUM>, -n <NUM>]
[--output-file=<FILE>, -o <FILE>]
[--output-file=<FILE>, -O <FILE>]
[<global-options>]

DESCRIPTION
Expand Down Expand Up @@ -40,7 +40,7 @@ OPTIONS
--namespace-id=<NUM>::
Namespace to use.

-o <FILE>::
-O <FILE>::
--output-file=<FILE>::
Output file; defaults to device name provided

Expand Down
6 changes: 3 additions & 3 deletions Documentation/nvme-sndk-namespace-resize.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ SYNOPSIS
--------
[verse]
'nvme sndk namespace-resize' <device> [--nsid=<NAMESPACE ID>, -n <NAMSPACE ID>]
[--op_option=<OP OPTION>, -o <OP OPTION>]
[--op_option=<OP OPTION>, -O <OP OPTION>]
[<global-options>]

DESCRIPTION
Expand All @@ -29,7 +29,7 @@ OPTIONS
--namespace-id=<NAMESPACE_ID>::
Namespace ID; ID of the namespace to resize

-o <OP OPTION>::
-O <OP OPTION>::
--op-option=<OP OPTION>::
Overprovisioning Option; defaults to 0xF
Valid Values:
Expand All @@ -46,7 +46,7 @@ EXAMPLES
* Resizes namespace 1 to 50% of the original TNVMCAP reported value:
+
------------
# nvme sndk namespace-resize /dev/nvme0 -n 1 -o 3
# nvme sndk namespace-resize /dev/nvme0 -n 1 -O 3
------------
* Resizes namespace 2 to 7% of the original TNVMCAP reported value:
+
Expand Down
8 changes: 4 additions & 4 deletions Documentation/nvme-sndk-vs-error-reason-identifier.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ nvme-sndk-vs-error-reason-identifier - Retrieve sndk device's telemetry log erro
SYNOPSIS
--------
[verse]
'nvme sndk vs-error-reason-identifier' <device> [--log-id=<NUM>, -i <NUM>] [--file=<FILE>, -o <FILE>]
'nvme sndk vs-error-reason-identifier' <device> [--log-id=<NUM>, -i <NUM>] [--file=<FILE>, -O <FILE>]
[<global-options>]

DESCRIPTION
Expand All @@ -33,7 +33,7 @@ OPTIONS
Use id 8 for the controller initiated log page.
The default is 7/host generated

-o <FILE>::
-O <FILE>::
--output-file=<FILE>::
Output file; defaults to "<device serial number>_error_reason_identifier_host_<date>_<time>.bin" for
the host generated log or "<device serial number>_error_reason_identifier_ctlr_<date>_<time>.bin" for
Expand All @@ -46,12 +46,12 @@ EXAMPLES
* Retrieves the host generated error reason identifier field and save it in file host_gen_error_reason_id.bin.
+
--------
# nvme sndk vs-error-reason-identifier /dev/nvme0 -i 7 -o host_gen_error_reason_id.bin
# nvme sndk vs-error-reason-identifier /dev/nvme0 -i 7 -O host_gen_error_reason_id.bin
--------
* Retrieves the controller initiated error reason identifier field and save it in file ctlr_init_error_reason_id.bin.
+
--------
# nvme sndk vs-error-reason-identifier /dev/nvme0 -i 8 -o ctlr_init_error_reason_id.bin
# nvme sndk vs-error-reason-identifier /dev/nvme0 -i 8 -O ctlr_init_error_reason_id.bin
--------

NVME
Expand Down
20 changes: 10 additions & 10 deletions Documentation/nvme-sndk-vs-internal-log.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ nvme-sndk-vs-internal-log - Retrieve sndk device's internal firmware log and sav
SYNOPSIS
--------
[verse]
'nvme sndk vs-internal-log' <device> [--output-file=<FILE>, -o <FILE>]
'nvme sndk vs-internal-log' <device> [--output-file=<FILE>, -O <FILE>]
[--transfer-size=<SIZE>, -s <SIZE>]
[--data-area=<DATA AREA>, -d <DATA_AREA>]
[--file-size=<FILE SIZE>, -f <FILE SIZE>]
Expand All @@ -29,7 +29,7 @@ Results for any other device are undefined.

OPTIONS
-------
-o <FILE>::
-O <FILE>::
--output-file=<FILE>::
Output file; defaults to device serial number followed by
"_internal_fw_log_<date>_<time>.bin" suffix
Expand Down Expand Up @@ -86,12 +86,12 @@ EXAMPLES
* Gets the internal firmware log from the device and saves to defined file in current directory (e.g. test.bin):
+
------------
# nvme sndk vs-internal-log /dev/nvme0 -o test.bin
# nvme sndk vs-internal-log /dev/nvme0 -O test.bin
------------
* Gets the internal firmware log from the device and saves to defined file with pathname (e.g. /tmp/test):
+
------------
# nvme sndk vs-internal-log /dev/nvme0 -o /tmp/test
# nvme sndk vs-internal-log /dev/nvme0 -O /tmp/test
------------
* Gets the internal firmware log from the device transferring the data in 64k chunks and saves to default file in current directory (e.g. STM00019F3F9_internal_fw_log_20171127_100754.bin):
+
Expand All @@ -106,24 +106,24 @@ EXAMPLES
* Gets the internal firmware log up to data area 3 from the device in 3 files of 0x1000000 bytes:
+
------------
# nvme sndk vs-internal-log /dev/nvme0 -d 3 -f 0x1000000 -t 0x0000000 -o /tmp/sn340_dui_data_1.bin
# nvme sndk vs-internal-log /dev/nvme0 -d 3 -f 0x1000000 -t 0x1000000 -o /tmp/sn340_dui_data_2.bin
# nvme sndk vs-internal-log /dev/nvme0 -d 3 -f 0x1000000 -t 0x2000000 -o /tmp/sn340_dui_data_3.bin
# nvme sndk vs-internal-log /dev/nvme0 -d 3 -f 0x1000000 -t 0x0000000 -O /tmp/sn340_dui_data_1.bin
# nvme sndk vs-internal-log /dev/nvme0 -d 3 -f 0x1000000 -t 0x1000000 -O /tmp/sn340_dui_data_2.bin
# nvme sndk vs-internal-log /dev/nvme0 -d 3 -f 0x1000000 -t 0x2000000 -O /tmp/sn340_dui_data_3.bin
------------
* Gets the host telemetry log page to data area 3 from the device and stores it in file host-telem-log-da3.bin:
+
------------
# nvme sndk vs-internal-log /dev/nvme1 -t host -o host-telem-log-da3.bin -d 3
# nvme sndk vs-internal-log /dev/nvme1 -t host -O host-telem-log-da3.bin -d 3
------------
* Gets the controller telemetry log page to data area 3 from the device and stores it in file ctlr-telem-log-da3.bin:
+
------------
# nvme sndk vs-internal-log /dev/nvme1 -t controller -o ctlr-telem-log-da3.bin -d 3
# nvme sndk vs-internal-log /dev/nvme1 -t controller -O ctlr-telem-log-da3.bin -d 3
------------
* Gets both host and controller telemetry log pages to data area 3 from the device and packages them in a tar file:
+
------------
# nvme sndk vs-internal-log /dev/nvme1 -t both -o both-telem-log-da3.tar -d 3
# nvme sndk vs-internal-log /dev/nvme1 -t both -O both-telem-log-da3.tar -d 3
------------

NVME
Expand Down
4 changes: 2 additions & 2 deletions Documentation/nvme-toshiba-vs-internal-log.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ SYNOPSIS
--------
[verse]
'nvme toshiba vs-internal-log ' <device>
[--output-file=<FILE>, -o <FILE>] (optional)
[--output-file=<FILE>, -O <FILE>] (optional)
[--saved-log, -s] (optional)
[<global-options>]

Expand All @@ -35,7 +35,7 @@ A progress runner is included when data is written to file and a page count is i
OPTIONS
-------

-o <FILE>::
-O <FILE>::
--output-file=<FILE>::
Output binary file. Defaults to text-formatted dump to stdout

Expand Down
4 changes: 2 additions & 2 deletions Documentation/nvme-toshiba-vs-smart-add-log.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ SYNOPSIS
[verse]
'nvme toshiba vs-smart-add-log ' <device> [--log=<NUM>, -l <NUM>]
[--namespace-id=<NUM>, -n <NUM>]
[--output-file=<FILE>, -o <FILE>]
[--output-file=<FILE>, -O <FILE>]
[<global-options>]

DESCRIPTION
Expand Down Expand Up @@ -40,7 +40,7 @@ OPTIONS
-n <NUM>::
--namespace-id=<NUM>::

-o <FILE>::
-O <FILE>::
--output-file=<FILE>::
Output binary file. Defaults to text-formatted dump to stdout

Expand Down
4 changes: 2 additions & 2 deletions Documentation/nvme-virtium-save-smart-to-vtview-log.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ SYNOPSIS
[verse]
'nvme virtium save-smart-to-vtview-log' <device> [--run-time=<NUM> | -r <NUM>]
[--freq=<NUM> | -f <NUM>]
[--output-file=<FILE> | -o <FILE>]
[--output-file=<FILE> | -O <FILE>]
[--test-name=<NAME> | -n <NAME>]
[<global-options>]

Expand Down Expand Up @@ -49,7 +49,7 @@ OPTIONS
(optional) How often you want to log SMART data (0.25 = 15', 0.5 = 30',
1 = 1 hour, 2 = 2 hours, etc.). Default = 10 hours.

-o <FILE>::
-O <FILE>::
--output-file=<FILE>::
(optional) Name of the log file (give it a name that easy for you to
remember what the test is). You can leave it blank too, the file name
Expand Down
8 changes: 4 additions & 4 deletions Documentation/nvme-wdc-cap-diag.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ nvme-wdc-cap-diag - Retrieve WDC device's diagnostic log and save to file.
SYNOPSIS
--------
[verse]
'nvme wdc cap-diag' <device> [--output-file=<FILE>, -o <FILE>] [--transfer-size=<SIZE>, -s <SIZE>]
'nvme wdc cap-diag' <device> [--output-file=<FILE>, -O <FILE>] [--transfer-size=<SIZE>, -s <SIZE>]
[<global-options>]

DESCRIPTION
Expand All @@ -24,7 +24,7 @@ Results for any other device are undefined.

OPTIONS
-------
-o <FILE>::
-O <FILE>::
--output-file=<FILE>::
Output file; defaults to device serial number followed by "cap_diag" suffix

Expand All @@ -44,12 +44,12 @@ EXAMPLES
* Gets the capture diagnostics log from the device and saves to defined file in current directory (e.g. testSTM00019F3F9cap_diag.bin):
+
------------
# nvme wdc cap-diag /dev/nvme0 -o test
# nvme wdc cap-diag /dev/nvme0 -O test
------------
* Gets the capture diagnostics log from the device and saves to defined file with pathname (e.g. /tmp/testSTM00019F3F9cap_diag.bin):
+
------------
# nvme wdc cap-diag /dev/nvme0 -o /tmp/test
# nvme wdc cap-diag /dev/nvme0 -O /tmp/test
------------
* Gets the capture diagnostics log from the device transferring the data in 64k chunks and saves to default file in current directory (e.g. STM00019F3F9internal_fw_log.bin):
+
Expand Down
8 changes: 4 additions & 4 deletions Documentation/nvme-wdc-drive-log.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ nvme-wdc-drive-log - Retrieve WDC device's drive log and save to file.
SYNOPSIS
--------
[verse]
'nvme wdc drive-log' <device> [--output-file=<FILE>, -o <FILE>]
'nvme wdc drive-log' <device> [--output-file=<FILE>, -O <FILE>]
[<global-options>]

DESCRIPTION
Expand All @@ -25,7 +25,7 @@ Results for any other device are undefined.

OPTIONS
-------
-o <FILE>::
-O <FILE>::
--output-file=<FILE>::
Output file; defaults to device serial number followed by "drive_log" suffix

Expand All @@ -41,12 +41,12 @@ EXAMPLES
* Gets the drive log from the device and saves to defined file in current directory (e.g. testSTM00019F3F9drive_log.bin):
+
------------
# nvme wdc drive-log /dev/nvme0 -o test
# nvme wdc drive-log /dev/nvme0 -O test
------------
* Gets the drive log from the device and saves to defined file with pathname (e.g. /tmp/testSTM00019F3F9drive_log.bin):
+
------------
# nvme wdc drive-log /dev/nvme0 -o /tmp/test
# nvme wdc drive-log /dev/nvme0 -O /tmp/test
------------

NVME
Expand Down
8 changes: 4 additions & 4 deletions Documentation/nvme-wdc-enc-get-log.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ SYNOPSIS
--------
[verse]
'nvme wdc enc-get-log' <device> [--log-id=<NUM>, -l <NUM>]
[--output-file=<FILE>, -o <FILE>]
[--output-file=<FILE>, -O <FILE>]
[--transfer-size=<SIZE>, -s <SIZE>]
[<global-options>]

Expand All @@ -33,7 +33,7 @@ On success it returns the enclosure log data, error code otherwise.

OPTIONS
-------
-o <FILE>::
-O <FILE>::
--output-file=<FILE>::
Output file pathname

Expand All @@ -50,12 +50,12 @@ EXAMPLES
size(0x2000) and saves to defined file in current directory:
+
------------
# nvme wdc enc-get-log /dev/nvme0 -l 0xd1 -o d1_log.bin -s 0x2000
# nvme wdc enc-get-log /dev/nvme0 -l 0xd1 -O d1_log.bin -s 0x2000
------------
* Gets the enclosure log from the device based on the log id(0xd2) with default transfer size(0x1000) and saves to defined file in current directory:
+
------------
# nvme wdc enc-get-log /dev/nvme0 -l 0xd2 -o d1_log.bin
# nvme wdc enc-get-log /dev/nvme0 -l 0xd2 -O d1_log.bin
------------

NVME
Expand Down
8 changes: 4 additions & 4 deletions Documentation/nvme-wdc-get-crash-dump.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ nvme-wdc-get-crash-dump - Retrieve WDC device's crash dump.
SYNOPSIS
--------
[verse]
'nvme wdc get-crash-dump' <device> [--output-file=<FILE>, -o <FILE>]
'nvme wdc get-crash-dump' <device> [--output-file=<FILE>, -O <FILE>]
[<global-options>]

DESCRIPTION
Expand All @@ -26,7 +26,7 @@ Results for any other device are undefined.

OPTIONS
-------
-o <FILE>::
-O <FILE>::
--output-file=<FILE>::
Output file; defaults to device serial number followed by "crash_dump" suffix

Expand All @@ -42,12 +42,12 @@ EXAMPLES
* Gets the crash dump from the device and saves to defined file in current directory (e.g. testSTM00019F3F9crash_dump.bin):
+
------------
# nvme wdc get-crash-dump /dev/nvme0 -o test
# nvme wdc get-crash-dump /dev/nvme0 -O test
------------
* Gets the crash dump from the device and saves to defined file with pathname (e.g. /tmp/testSTM00019F3F9crash_dump.bin):
+
------------
# nvme wdc get-crash-dump /dev/nvme0 -o /tmp/test
# nvme wdc get-crash-dump /dev/nvme0 -O /tmp/test
------------

NVME
Expand Down
8 changes: 4 additions & 4 deletions Documentation/nvme-wdc-get-pfail-dump.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ nvme-wdc-get-pfail-dump - Retrieve WDC device's pfail crash dump.
SYNOPSIS
--------
[verse]
'nvme wdc get-pfail-dump' <device> [--output-file=<FILE>, -o <FILE>]
'nvme wdc get-pfail-dump' <device> [--output-file=<FILE>, -O <FILE>]
[<global-options>]

DESCRIPTION
Expand All @@ -26,7 +26,7 @@ Results for any other device are undefined.

OPTIONS
-------
-o <FILE>::
-O <FILE>::
--output-file=<FILE>::
Output file; defaults to device serial number followed by "pfail_dump" suffix

Expand All @@ -44,12 +44,12 @@ EXAMPLES
(e.g. testSTM00019F3F9_pfail_dump.bin):
+
------------
# nvme wdc get-pfail-dump /dev/nvme0 -o test
# nvme wdc get-pfail-dump /dev/nvme0 -O test
------------
* Gets the pfail crash dump from the device and saves to defined file with pathname (e.g. /tmp/testSTM00019F3F9_pfail_dump.bin):
+
------------
# nvme wdc get-pfail-dump /dev/nvme0 -o /tmp/test
# nvme wdc get-pfail-dump /dev/nvme0 -O /tmp/test
------------

NVME
Expand Down
6 changes: 3 additions & 3 deletions Documentation/nvme-wdc-namespace-resize.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ SYNOPSIS
--------
[verse]
'nvme wdc namespace-resize' <device> [--nsid=<NAMESPACE ID>, -n <NAMSPACE ID>]
[--op_option=<OP OPTION>, -o <OP OPTION>]
[--op_option=<OP OPTION>, -O <OP OPTION>]
[<global-options>]

DESCRIPTION
Expand All @@ -29,7 +29,7 @@ OPTIONS
--namespace-id=<NAMESPACE_ID>::
Namespace ID; ID of the namespace to resize

-o <OP OPTION>::
-O <OP OPTION>::
--op-option=<OP OPTION>::
Overprovisioning Option; defaults to 0xF
Valid Values:
Expand All @@ -46,7 +46,7 @@ EXAMPLES
* Resizes namespace 1 to 50% of the original TNVMCAP reported value:
+
------------
# nvme wdc namespace-resize /dev/nvme0 -n 1 -o 3
# nvme wdc namespace-resize /dev/nvme0 -n 1 -O 3
------------
* Resizes namespace 2 to 7% of the original TNVMCAP reported value:
+
Expand Down
Loading