nbd: Document the NBD-specific uri parameter

Signed-off-by: Richard W.M. Jones <rjones@redhat.com>
Signed-off-by: Jens Axboe <axboe@kernel.dk>

diff --git a/HOWTO b/HOWTO
index 955ea43cedbe3726a8c18739a4f20e1ef16e7cdd..41b959d176dd2f3a52b6db81d76ac67adebe9f6e 100644 (file)
--- a/HOWTO
+++ b/HOWTO
@@ -1999,7 +1999,7 @@ I/O engine
                **libiscsi**
                        Read and write iscsi lun with libiscsi.
                **nbd**
-                       Synchronous read and write a Network Block Device (NBD).
+                       Read and write a Network Block Device (NBD).
 
 I/O engine specific parameters
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -2301,6 +2301,15 @@ with the caveat that when used on the command line, they must come after the
        turns on verbose logging from libcurl, 2 additionally enables
        HTTP IO tracing. Default is **0**
 
+.. option:: uri=str : [nbd]
+
+       Specify the NBD URI of the server to test.  The string
+       is a standard NBD URI
+       (see https://github.com/NetworkBlockDevice/nbd/tree/master/doc).
+       Example URIs: nbd://localhost:10809
+       nbd+unix:///?socket=/tmp/socket
+       nbds://tlshost/exportname
+
 I/O depth
 ~~~~~~~~~
 

diff --git a/fio.1 b/fio.1
index 30b17f02f1b1dc0f852687bca18e56e2bc93d13e..97371d7767a1dd93d23a987bcbe22ade0b810ee3 100644 (file)
--- a/fio.1
+++ b/fio.1
@@ -2022,6 +2022,22 @@ blocksize=8k will write 16 sectors with each command. fio will still
 generate 8k of data for each command butonly the first 512 bytes will
 be used and transferred to the device. The writefua option is ignored
 with this selection.
+.RE
+.RE
+.TP
+.BI (nbd)uri \fR=\fPstr
+Specify the NBD URI of the server to test.
+The string is a standard NBD URI (see
+\fIhttps://github.com/NetworkBlockDevice/nbd/tree/master/doc\fR).
+Example URIs:
+.RS
+.RS
+.TP
+\fInbd://localhost:10809\fR
+.TP
+\fInbd+unix:///?socket=/tmp/socket\fR
+.TP
+\fInbds://tlshost/exportname\fR
 
 .SS "I/O depth"
 .TP