From: Kevin Wolf <kwolf@redhat.com>
To: qemu-block@nongnu.org
Cc: kwolf@redhat.com, pbonzini@redhat.com, qemu-devel@nongnu.org,
timao@redhat.com
Subject: [PATCH 5/5] docs: Only mention gluster in the man page when available
Date: Mon, 31 Jan 2022 18:04:11 +0100 [thread overview]
Message-ID: <20220131170411.125198-6-kwolf@redhat.com> (raw)
In-Reply-To: <20220131170411.125198-1-kwolf@redhat.com>
If gluster is disabled in the build, the man page shouldn't contain
information on how to use the gluster block driver.
This patch is best viewed with whitespace changes ignored.
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
---
docs/system/device-url-syntax.rst.inc | 64 ++++++++++++++-------------
1 file changed, 33 insertions(+), 31 deletions(-)
diff --git a/docs/system/device-url-syntax.rst.inc b/docs/system/device-url-syntax.rst.inc
index d55622847a..79270c8709 100644
--- a/docs/system/device-url-syntax.rst.inc
+++ b/docs/system/device-url-syntax.rst.inc
@@ -89,44 +89,46 @@ special URL syntax.
Currently authentication must be done using ssh-agent. Other
authentication methods may be supported in future.
-``GlusterFS``
- GlusterFS is a user space distributed file system. QEMU supports the
- use of GlusterFS volumes for hosting VM disk images using TCP, Unix
- Domain Sockets and RDMA transport protocols.
+.. only:: not DISABLE_GLUSTERFS
- Syntax for specifying a VM disk image on GlusterFS volume is
+ ``GlusterFS``
+ GlusterFS is a user space distributed file system. QEMU supports the
+ use of GlusterFS volumes for hosting VM disk images using TCP, Unix
+ Domain Sockets and RDMA transport protocols.
- .. parsed-literal::
+ Syntax for specifying a VM disk image on GlusterFS volume is
- URI:
- gluster[+type]://[host[:port]]/volume/path[?socket=...][,debug=N][,logfile=...]
+ .. parsed-literal::
- JSON:
- 'json:{"driver":"qcow2","file":{"driver":"gluster","volume":"testvol","path":"a.img","debug":N,"logfile":"...",
- "server":[{"type":"tcp","host":"...","port":"..."},
- {"type":"unix","socket":"..."}]}}'
+ URI:
+ gluster[+type]://[host[:port]]/volume/path[?socket=...][,debug=N][,logfile=...]
- Example
+ JSON:
+ 'json:{"driver":"qcow2","file":{"driver":"gluster","volume":"testvol","path":"a.img","debug":N,"logfile":"...",
+ "server":[{"type":"tcp","host":"...","port":"..."},
+ {"type":"unix","socket":"..."}]}}'
- .. parsed-literal::
+ Example
+
+ .. parsed-literal::
- URI:
- |qemu_system| --drive file=gluster://192.0.2.1/testvol/a.img,
- file.debug=9,file.logfile=/var/log/qemu-gluster.log
-
- JSON:
- |qemu_system| 'json:{"driver":"qcow2",
- "file":{"driver":"gluster",
- "volume":"testvol","path":"a.img",
- "debug":9,"logfile":"/var/log/qemu-gluster.log",
- "server":[{"type":"tcp","host":"1.2.3.4","port":24007},
- {"type":"unix","socket":"/var/run/glusterd.socket"}]}}'
- |qemu_system| -drive driver=qcow2,file.driver=gluster,file.volume=testvol,file.path=/path/a.img,
- file.debug=9,file.logfile=/var/log/qemu-gluster.log,
- file.server.0.type=tcp,file.server.0.host=1.2.3.4,file.server.0.port=24007,
- file.server.1.type=unix,file.server.1.socket=/var/run/glusterd.socket
-
- See also http://www.gluster.org.
+ URI:
+ |qemu_system| --drive file=gluster://192.0.2.1/testvol/a.img,
+ file.debug=9,file.logfile=/var/log/qemu-gluster.log
+
+ JSON:
+ |qemu_system| 'json:{"driver":"qcow2",
+ "file":{"driver":"gluster",
+ "volume":"testvol","path":"a.img",
+ "debug":9,"logfile":"/var/log/qemu-gluster.log",
+ "server":[{"type":"tcp","host":"1.2.3.4","port":24007},
+ {"type":"unix","socket":"/var/run/glusterd.socket"}]}}'
+ |qemu_system| -drive driver=qcow2,file.driver=gluster,file.volume=testvol,file.path=/path/a.img,
+ file.debug=9,file.logfile=/var/log/qemu-gluster.log,
+ file.server.0.type=tcp,file.server.0.host=1.2.3.4,file.server.0.port=24007,
+ file.server.1.type=unix,file.server.1.socket=/var/run/glusterd.socket
+
+ See also http://www.gluster.org.
.. only:: not DISABLE_CURL
--
2.31.1
prev parent reply other threads:[~2022-01-31 17:16 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-01-31 17:04 [PATCH 0/5] docs: Don't document disabled features Kevin Wolf
2022-01-31 17:04 ` [PATCH 1/5] docs: Pass disabled configure options to sphinx Kevin Wolf
2022-01-31 17:53 ` Daniel P. Berrangé
2022-01-31 17:04 ` [PATCH 2/5] docs: Only mention iscsi in the man page when available Kevin Wolf
2022-01-31 18:57 ` Peter Maydell
2022-02-01 8:40 ` Kevin Wolf
2022-01-31 17:04 ` [PATCH 3/5] docs: Only mention ssh " Kevin Wolf
2022-01-31 17:04 ` [PATCH 4/5] docs: Only mention curl " Kevin Wolf
2022-01-31 17:04 ` Kevin Wolf [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220131170411.125198-6-kwolf@redhat.com \
--to=kwolf@redhat.com \
--cc=pbonzini@redhat.com \
--cc=qemu-block@nongnu.org \
--cc=qemu-devel@nongnu.org \
--cc=timao@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).