From: Keith Busch Date: Fri, 12 Oct 2018 19:03:07 +0000 (-0600) Subject: Update documentation X-Git-Tag: v1.7~48 X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=79121c2c84a6f74a0f2ef97877d1875bbbfc6eca;p=users%2Fsagi%2Fnvme-cli.git Update documentation Signed-off-by: Keith Busch --- diff --git a/Documentation/nvme-wdc-cap-diag.1 b/Documentation/nvme-wdc-cap-diag.1 index d3bf0800..25cac608 100644 --- a/Documentation/nvme-wdc-cap-diag.1 +++ b/Documentation/nvme-wdc-cap-diag.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-cap-diag .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 09/05/2018 +.\" Date: 10/12/2018 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-CAP\-DIAG" "1" "09/05/2018" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-CAP\-DIAG" "1" "10/12/2018" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,7 +32,7 @@ nvme-wdc-cap-diag \- Retrieve WDC device\*(Aqs diagnostic log and save to file\& .SH "SYNOPSIS" .sp .nf -\fInvme wdc cap\-diag\fR [\-\-output\-file=, \-o ] +\fInvme wdc cap\-diag\fR [\-\-output\-file=, \-o ] [\-\-transfer\-size=, \-s ] .fi .SH "DESCRIPTION" .sp @@ -47,6 +47,11 @@ This will only work on WDC devices supporting this feature\&. Results for any ot .RS 4 Output file; defaults to device serial number followed by "cap_diag" suffix .RE +.PP +\-s , \-\-transfer\-size= +.RS 4 +Transfer size; defaults to 0x10000 (65536 decimal) bytes +.RE .SH "EXAMPLES" .sp .RS 4 @@ -111,6 +116,48 @@ Gets the capture diagnostics log from the device and saves to defined file with .RE .\} .RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +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): +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme wdc cap\-diag /dev/nvme0 \-s 0x10000 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Gets the capture diagnostics log from the device transferring the data in 16k chunks and saves to default file in current directory (e\&.g\&. STM00019F3F9internal_fw_log\&.bin): +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme wdc cap\-diag /dev/nvme0 \-s 16384 +.fi +.if n \{\ +.RE +.\} +.RE .SH "NVME" .sp Part of the nvme\-user suite\&. diff --git a/Documentation/nvme-wdc-cap-diag.html b/Documentation/nvme-wdc-cap-diag.html index eff25994..befa3a8c 100644 --- a/Documentation/nvme-wdc-cap-diag.html +++ b/Documentation/nvme-wdc-cap-diag.html @@ -746,7 +746,7 @@ nvme-wdc-cap-diag(1) Manual Page

SYNOPSIS

-
nvme wdc cap-diag <device> [--output-file=<FILE>, -o <FILE>]
+
nvme wdc cap-diag <device> [--output-file=<FILE>, -o <FILE>] [--transfer-size=<SIZE>, -s <SIZE>]
@@ -776,6 +776,17 @@ Results for any other device are undefined.

Output file; defaults to device serial number followed by "cap_diag" suffix

+
+-s <SIZE> +
+
+--transfer-size=<SIZE> +
+
+

+ Transfer size; defaults to 0x10000 (65536 decimal) bytes +

+
@@ -810,6 +821,24 @@ Gets the capture diagnostics log from the device and saves to defined file with
# 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): +

    +
    +
    +
    # nvme wdc cap-diag /dev/nvme0 -s 0x10000
    +
    +
  • +
  • +

    +Gets the capture diagnostics log from the device transferring the data in 16k chunks and saves to default file in current directory (e.g. STM00019F3F9internal_fw_log.bin): +

    +
    +
    +
    # nvme wdc cap-diag /dev/nvme0 -s 16384
    +
    +
  • @@ -823,7 +852,7 @@ Gets the capture diagnostics log from the device and saves to defined file with

    diff --git a/Documentation/nvme-wdc-vs-internal-log.1 b/Documentation/nvme-wdc-vs-internal-log.1 new file mode 100644 index 00000000..be8bc33d --- /dev/null +++ b/Documentation/nvme-wdc-vs-internal-log.1 @@ -0,0 +1,163 @@ +'\" t +.\" Title: nvme-wdc-vs-internal-log +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/12/2018 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-WDC\-VS\-INTER" "1" "10/12/2018" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nvme-wdc-vs-internal-log \- Retrieve WDC device\*(Aqs internal firmware log and save to file\&. +.SH "SYNOPSIS" +.sp +.nf +\fInvme wdc vs\-internal\-log\fR [\-\-output\-file=, \-o ] [\-\-transfer\-size=, \-s ] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, sends the WDC Vendor Specific Internal Log request and saves the result to a file\&. +.sp +The parameter is mandatory NVMe character device (ex: /dev/nvme0)\&. +.sp +This will only work on WDC devices supporting this feature\&. Results for any other device are undefined\&. +.SH "OPTIONS" +.PP +\-o , \-\-output\-file= +.RS 4 +Output file; defaults to device serial number followed by "\fIinternal_fw_log\fR_