Skip to contentSkip to conversation

nbd: Document the NBD-specific uri parameter.

PATCH In review Richard W.M. Jones 2 participants 3 messages Aug 2, 2019

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 nbd: Document the NBD-specific uri parameter.

Is this sufficient documentation?

The existing examples/nbd.fio file shows you how you can test nbdkit and qemu-nbd, two common NBD servers.

Rich.

#1 lore raw

PATCH 1/1 nbd: Document the NBD-specific uri parameter.

---
 HOWTO | 11 ++++++++++-
 fio.1 | 16 ++++++++++++++++
 2 files changed, 26 insertions(+), 1 deletion(-)
HOWTO +10 -1
index 955ea43c..41b959d1 100644
@@ -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
 ~~~~~~~~~
 
fio.1 +16 -0
index 30b17f02..97371d77 100644
@@ -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
Signature · 1 line
2.22.0
#2 lore raw
In reply to Richard W.M. Jones
Quoted 4 lines · Richard W.M. Jones

Is this sufficient documentation?

The existing examples/nbd.fio file shows you how you can test nbdkit and qemu-nbd, two common NBD servers.

Yep, that should do. Thanks.

Signature · 1 line
Jens Axboe