diff mbox series

[PULL,5/9] docs: Update preferred NBD device syntax

Message ID 20190905182132.3563-6-eblake@redhat.com (mailing list archive)
State New, archived
Headers show
Series [PULL,1/9] nbd: Advertise multi-conn for shared read-only connections | expand

Commit Message

Eric Blake Sept. 5, 2019, 6:21 p.m. UTC 
Mention the preferred URI form, especially since NBD is trying to
standardize that form: https://lists.debian.org/nbd/2019/06/msg00012.html

Signed-off-by: Eric Blake <eblake@redhat.com>
Message-Id: <20190903145634.20237-1-eblake@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
---
 qemu-doc.texi | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/qemu-doc.texi b/qemu-doc.texi
index 577d1e837640..ec460f1d7af5 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -297,9 +297,16 @@  qemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1

 @item NBD
 QEMU supports NBD (Network Block Devices) both using TCP protocol as well
-as Unix Domain Sockets.
+as Unix Domain Sockets.  With TCP, the default port is 10809.

-Syntax for specifying a NBD device using TCP
+Syntax for specifying a NBD device using TCP, in preferred URI form:
+``nbd://<server-ip>[:<port>]/[<export>]''
+
+Syntax for specifying a NBD device using Unix Domain Sockets; remember
+that '?' is a shell glob character and may need quoting:
+``nbd+unix:///[<export>]?socket=<domain-socket>''
+
+Older syntax that is also recognized:
 ``nbd:<server-ip>:<port>[:exportname=<export>]''

 Syntax for specifying a NBD device using Unix Domain Sockets