From: Keith Busch Date: Mon, 20 Jun 2016 23:03:43 +0000 (-0600) Subject: Update help on IO command parameters X-Git-Tag: v0.8~4 X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=fa5cb34068fc6dfbc835fd89d018b8809715c0af;p=users%2Fsagi%2Fnvme-cli.git Update help on IO command parameters The block count has always been 0's based, but you'd never know that without reading the code. Signed-off-by: Keith Busch --- diff --git a/Documentation/nvme-read.1 b/Documentation/nvme-read.1 index d1b6f497..73bc5e8b 100644 --- a/Documentation/nvme-read.1 +++ b/Documentation/nvme-read.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-read .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 05/16/2016 +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 06/20/2016 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-READ" "1" "05/16/2016" "NVMe" "NVMe Manual" +.TH "NVME\-READ" "1" "06/20/2016" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -56,6 +56,11 @@ The Read command reads the logical blocks specified by the command from the medi Start block\&. .RE .PP +\-\-block\-count, \-c +.RS 4 +The number of blocks to transfer\&. This is a zeroes based value to align with the kernel\(cqs use of this field\&. (ie\&. 0 means transfer 1 block)\&. +.RE +.PP \-\-latency, \-t .RS 4 Print out the latency the IOCTL took (in us)\&. diff --git a/Documentation/nvme-read.html b/Documentation/nvme-read.html index 72ad8dec..7b6f5cdf 100644 --- a/Documentation/nvme-read.html +++ b/Documentation/nvme-read.html @@ -435,7 +435,7 @@ thead, p.table.header { p.table { margin-top: 0; } -/* Because the table frame attribute is overridden by CSS in most browsers. */ +/* Because the table frame attribute is overriden by CSS in most browsers. */ div.tableblock > table[frame="void"] { border-style: none; } @@ -793,6 +793,19 @@ by default if you don’t provide a file.

+--block-count +
+
+-c +
+
+

+ The number of blocks to transfer. This is a zeroes based value to + align with the kernel’s use of this field. (ie. 0 means transfer + 1 block). +

+
+
--latency
@@ -822,7 +835,7 @@ by default if you don’t provide a file.

diff --git a/Documentation/nvme-read.txt b/Documentation/nvme-read.txt index cd2f75ee..6b3da9da 100644 --- a/Documentation/nvme-read.txt +++ b/Documentation/nvme-read.txt @@ -34,6 +34,12 @@ OPTIONS -s :: Start block. +--block-count:: +-c:: + The number of blocks to transfer. This is a zeroes based value to + align with the kernel's use of this field. (ie. 0 means transfer + 1 block). + --latency:: -t:: Print out the latency the IOCTL took (in us). diff --git a/Documentation/nvme-write.1 b/Documentation/nvme-write.1 index 6b15530f..5bfefd79 100644 --- a/Documentation/nvme-write.1 +++ b/Documentation/nvme-write.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-write .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 05/14/2016 +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 06/20/2016 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WRITE" "1" "05/14/2016" "NVMe" "NVMe Manual" +.TH "NVME\-WRITE" "1" "06/20/2016" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -56,6 +56,11 @@ The Write command writes the logical blocks specified by the command to the medi Start block\&. .RE .PP +\-\-block\-count, \-c +.RS 4 +The number of blocks to transfer\&. This is a zeroes based value to align with the kernel\(cqs use of this field\&. (ie\&. 0 means transfer 1 block)\&. +.RE +.PP \-\-latency, \-t .RS 4 Print out the latency the IOCTL took (in us)\&. diff --git a/Documentation/nvme-write.html b/Documentation/nvme-write.html index 52cb07fb..e33eb526 100644 --- a/Documentation/nvme-write.html +++ b/Documentation/nvme-write.html @@ -793,6 +793,19 @@ if you don’t provide a file.

+--block-count +
+
+-c +
+
+

+ The number of blocks to transfer. This is a zeroes based value to + align with the kernel’s use of this field. (ie. 0 means transfer + 1 block). +

+
+
--latency
@@ -822,7 +835,7 @@ if you don’t provide a file.

diff --git a/Documentation/nvme-write.txt b/Documentation/nvme-write.txt index ee3b6735..2af90998 100644 --- a/Documentation/nvme-write.txt +++ b/Documentation/nvme-write.txt @@ -34,6 +34,12 @@ OPTIONS -s :: Start block. +--block-count:: +-c:: + The number of blocks to transfer. This is a zeroes based value to + align with the kernel's use of this field. (ie. 0 means transfer + 1 block). + --latency:: -t:: Print out the latency the IOCTL took (in us). diff --git a/nvme.c b/nvme.c index cfeac844..b6d967c0 100644 --- a/nvme.c +++ b/nvme.c @@ -2097,7 +2097,7 @@ static int submit_io(int opcode, char *command, const char *desc, __u16 control = 0; const char *start_block = "64-bit addr of first block to access"; - const char *block_count = "number of blocks on device to access"; + const char *block_count = "number of blocks (zeroes based) on device to access"; const char *data_size = "size of data in bytes"; const char *metadata_size = "size of metadata in bytes"; const char *ref_tag = "reference tag (for end to end PI)";