Document timeout value usage

Add to man page and clarify value is in milliseconds.

Signed-off-by: Keith Busch <keith.busch@intel.com>

diff --git a/Documentation/nvme-format.1 b/Documentation/nvme-format.1
index fbde4b880afd3e82df92b6b690896f3cd7ca0f8b..a161c0bb63508ce97f2108ded63215c3b1462acb 100644 (file)
--- a/Documentation/nvme-format.1
+++ b/Documentation/nvme-format.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-format
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\"      Date: 10/21/2016
+.\"      Date: 10/26/2016
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-FORMAT" "1" "10/21/2016" "NVMe" "NVMe Manual"
+.TH "NVME\-FORMAT" "1" "10/26/2016" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -39,6 +39,7 @@ nvme-format \- Format an NVMe device
                     [\-\-pi=<pi> | \-i <pi>]
                     [\-\-ms=<ms> | \-m <ms>]
                     [\-\-reset | \-r ]
+                    [\-\-timeout | \-t ]
 .fi
 .SH "DESCRIPTION"
 .sp
@@ -157,6 +158,11 @@ Metadata Settings: This field is set to \(oq1\(cq if the metadata is transferred
 .RS 4
 Issue a reset after successful format\&. Must use the character device for this\&.
 .RE
+.PP
+\-t <timeout>, \-\-timeout=<timeout>
+.RS 4
+Override default timeout value\&. In milliseconds\&.
+.RE
 .SH "EXAMPLES"
 .sp
 .RS 4

diff --git a/Documentation/nvme-format.html b/Documentation/nvme-format.html
index e047511ec7bcfd58de9fac403b7dde2afe6dd063..f20e2427d4d1adcdfc4befafaa85e527b9ff19ad 100644 (file)
--- a/Documentation/nvme-format.html
+++ b/Documentation/nvme-format.html
@@ -752,7 +752,8 @@ nvme-format(1) Manual Page
                     [--pil=<pil> | -p <pil>]\r
                     [--pi=<pi> | -i <pi>]\r
                     [--ms=<ms> | -m <ms>]\r
-                    [--reset | -r ]</pre>\r
+                    [--reset | -r ]\r
+                    [--timeout | -t ]</pre>\r
 <div class="attribution">\r
 </div></div>\r
 </div>\r
@@ -946,6 +947,17 @@ cellspacing="0" cellpadding="4">
         device for this.\r
 </p>\r
 </dd>\r
+<dt class="hdlist1">\r
+-t &lt;timeout&gt;\r
+</dt>\r
+<dt class="hdlist1">\r
+--timeout=&lt;timeout&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+        Override default timeout value. In milliseconds.\r
+</p>\r
+</dd>\r
 </dl></div>\r
 </div>\r
 </div>\r
@@ -985,7 +997,7 @@ information:
 <div id="footnotes"><hr /></div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 2016-09-22 12:09:58 EDT\r
+Last updated 2016-10-26 15:41:15 EDT\r
 </div>\r
 </div>\r
 </body>\r

diff --git a/Documentation/nvme-format.txt b/Documentation/nvme-format.txt
index fee7799a9d768c9d0b2f4a22cb3569424f9961c8..a74a0dcbcd9cf3c1d89f98d0ce3182680446b022 100644 (file)
--- a/Documentation/nvme-format.txt
+++ b/Documentation/nvme-format.txt
@@ -15,6 +15,7 @@ SYNOPSIS
                    [--pi=<pi> | -i <pi>]
                    [--ms=<ms> | -m <ms>]
                    [--reset | -r ]
+                   [--timeout | -t ]
 
 DESCRIPTION
 -----------
@@ -107,6 +108,10 @@ cryptographically. This is accomplished by deleting the encryption key.
        Issue a reset after successful format. Must use the character
        device for this.
 
+-t <timeout>::
+--timeout=<timeout>::
+       Override default timeout value. In milliseconds.
+
 EXAMPLES
 --------
 * Format the device using all defaults:

diff --git a/nvme.c b/nvme.c
index 220a57a8212012f51a13fb4cdc1e53e51a6a5215..a9e78aae50a9bf67827904f5b51a47ca3f4bda14 100644 (file)
--- a/nvme.c
+++ b/nvme.c
@@ -1456,7 +1456,7 @@ static int format(int argc, char **argv, struct command *cmd, struct plugin *plu
        const char *pi = "[0-3]: protection info off/Type 1/Type 2/Type 3";
        const char *ms = "[0-1]: extended format off/on";
        const char *reset = "Automatically reset the controller after successful format";
-       const char *timeout = "timeout value";
+       const char *timeout = "timeout value, in milliseconds";
        int err;
 
        struct config {
@@ -2563,7 +2563,7 @@ static int passthru(int argc, char **argv, int ioctl_cmd, const char *desc, stru
        const char *namespace_id = "desired namespace";
        const char *data_len = "data I/O length (bytes)";
        const char *metadata_len = "metadata seg. length (bytes)";
-       const char *timeout = "timeout value";
+       const char *timeout = "timeout value, in milliseconds";
        const char *cdw2 = "command dword 2 value";
        const char *cdw3 = "command dword 3 value";
        const char *cdw10 = "command dword 10 value";