From: Keith Busch Date: Wed, 22 May 2019 22:42:55 +0000 (-0600) Subject: Spin documentation X-Git-Tag: v1.9~52 X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=b969cf0b67995035a17ed89812d695b7f954f39c;p=users%2Fsagi%2Fnvme-cli.git Spin documentation New man pages provided for 3rd party plugin. Signed-off-by: Keith Busch --- diff --git a/Documentation/nvme-virtium-save-smart-to-vtview-log.1 b/Documentation/nvme-virtium-save-smart-to-vtview-log.1 new file mode 100644 index 00000000..394b7d74 --- /dev/null +++ b/Documentation/nvme-virtium-save-smart-to-vtview-log.1 @@ -0,0 +1,138 @@ +'\" t +.\" Title: nvme-virtium-save-smart-to-vtview-log +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 05/22/2019 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-VIRTIUM\-SAVE\" "1" "05/22/2019" "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-virtium-save-smart-to-vtview-log \- Periodically save smart attributes into a log file (csv format)\&. +.SH "SYNOPSIS" +.sp +.nf +\fInvme virtium save\-smart\-to\-vtview\-log\fR [\-\-run\-time= | \-r ] + [\-\-freq= | \-f ] + [\-\-output\-file= | \-o ] + [\-\-test\-name= | \-n ] +.fi +.SH "DESCRIPTION" +.sp +This command automates the process of collecting SMART data periodically and saving the data in a ready\-to\-analyze format\&. Each entry is saved with timestamp and in csv format\&. Users can use excel to analyze the data\&. Some examples of use cases are collecting SMART data for temperature characterization, collecting data to calculate endurance, or collecting SMART data during a test or during normal operation\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.sp +On success, the command generates a log file, which contains an entry for identify device (current features & settings) and periodic entries of SMART data\&. +.sp +This command runs for the time specified by the option , and collects SMART data at the frequency specified by the option \&. If the output file name is not specified, this command will generate a file name that include model string and serial number of the device\&. +.sp +If the test\-name option is specified, it will be recorded in the log file and be used as part of the log file name\&. +.SH "OPTIONS" +.PP +\-r , \-\-run\-tim= +.RS 4 +(optional) Number of hours to log data (default = 20 hours) +.RE +.PP +\-f , \-\-freq= +.RS 4 +(optional) How often you want to log SMART data (0\&.25 = 15\*(Aq , 0\&.5 = 30\*(Aq , 1 = 1 hour, 2 = 2 hours, etc\&.)\&. Default = 10 hours\&. +.RE +.PP +\-o , \-\-output\-file= +.RS 4 +(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 will be generated as \-\-\&.txt\&. +.RE +.PP +\-n , \-\-test\-name= +.RS 4 +(optional) Name of the test you are doing\&. We use this string as part of the name of the log file\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Temperature characterization: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme virtium save\-smart\-to\-vtview\-log /dev/yourDevice \-\-run\-time=100 \-\-record\-frequency=0\&.25 \-\-test\-name=burn\-in\-at\-(\-40) +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Endurance testing: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme virtium save\-smart\-to\-vtview\-log /dev/yourDevice \-\-run\-time=100 \-\-record\-frequency=1 \-\-test\-name=Endurance\-test\-JEDEG\-219\-workload +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Just logging: Default logging is run for 20 hours and log every 10 hours\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme virtium save\-smart\-to\-vtview\-log /dev/yourDevice +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-virtium-save-smart-to-vtview-log.html b/Documentation/nvme-virtium-save-smart-to-vtview-log.html new file mode 100644 index 00000000..ae106891 --- /dev/null +++ b/Documentation/nvme-virtium-save-smart-to-vtview-log.html @@ -0,0 +1,879 @@ + + + + + +nvme-virtium-save-smart-to-vtview-log(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme virtium save-smart-to-vtview-log <device> [--run-time=<NUM> | -r <NUM>]
+                        [--freq=<NUM> | -f <NUM>]
+                        [--output-file=<FILE> | -o <FILE>]
+                        [--test-name=<NAME> | -n <NAME>]
+
+
+
+
+
+

DESCRIPTION

+
+

This command automates the process of collecting SMART data periodically and +saving the data in a ready-to-analyze format. Each entry is saved +with timestamp and in csv format. Users can use excel to analyze the data. +Some examples of use cases are collecting SMART data for temperature characterization, +collecting data to calculate endurance, or collecting SMART data during a test +or during normal operation.

+

The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

+

On success, the command generates a log file, which contains an entry for identify device +(current features & settings) and periodic entries of SMART data.

+

This command runs for the time specified by the option <run-time>, and collects SMART data +at the frequency specified by the option <freq>. If the output file name is not specified, +this command will generate a file name that include model string and serial number of the device.

+

If the test-name option is specified, it will be recorded in the log file and be used as part +of the log file name.

+
+
+
+

OPTIONS

+
+
+
+-r <NUM> +
+
+--run-tim=<NUM> +
+
+

+ (optional) Number of hours to log data (default = 20 hours) +

+
+
+-f <NUM> +
+
+--freq=<NUM> +
+
+

+ (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> +
+
+--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 will be generated + as <model string>-<serial number>-<test name>.txt. +

+
+
+-n <NAME> +
+
+--test-name=<NAME> +
+
+

+ (optional) Name of the test you are doing. We use this string as part of the name of the log file. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Temperature characterization: +

    +
    +
    +
    # nvme virtium save-smart-to-vtview-log /dev/yourDevice --run-time=100 --record-frequency=0.25 --test-name=burn-in-at-(-40)
    +
    +
    • +
  • +

    +Endurance testing: +

    +
    +
    +
    # nvme virtium save-smart-to-vtview-log /dev/yourDevice --run-time=100 --record-frequency=1 --test-name=Endurance-test-JEDEG-219-workload
    +
    +
    • +
  • +

    +Just logging: Default logging is run for 20 hours and log every 10 hours. +

    +
    +
    +
    # nvme virtium save-smart-to-vtview-log /dev/yourDevice
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-virtium-show-identify.1 b/Documentation/nvme-virtium-show-identify.1 new file mode 100644 index 00000000..df1f14d0 --- /dev/null +++ b/Documentation/nvme-virtium-show-identify.1 @@ -0,0 +1,71 @@ +'\" t +.\" Title: nvme-virtium-show-identify +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 05/22/2019 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-VIRTIUM\-SHOW\" "1" "05/22/2019" "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-virtium-show-identify \- Show a complete detail of identify device information in json format\&. +.SH "SYNOPSIS" +.sp +.nf +\fInvme virtium show\-identify\fR +.fi +.SH "DESCRIPTION" +.sp +This command prints complete detail of the identify device information\&. The details include settings and description of each feature\&. The descriptions are based on NVM Express Revision 1\&.3c specification\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.sp +On success, the command prints identify device in human readable format\&. +.SH "OPTIONS" +.sp +none +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Show Identify Device: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme virtium show\-identify /dev/nvme0n1 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-virtium-show-identify.html b/Documentation/nvme-virtium-show-identify.html new file mode 100644 index 00000000..9238dd3e --- /dev/null +++ b/Documentation/nvme-virtium-show-identify.html @@ -0,0 +1,801 @@ + + + + + +nvme-virtium-show-identify(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme virtium show-identify <device>
+
+
+
+
+
+

DESCRIPTION

+
+

This command prints complete detail of the identify device information. The +details include settings and description of each feature. The descriptions are +based on NVM Express Revision 1.3c specification.

+

The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

+

On success, the command prints identify device in human readable format.

+
+
+
+

OPTIONS

+
+

none

+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Show Identify Device: +

    +
    +
    +
    # nvme virtium show-identify /dev/nvme0n1
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + +