[PATCH 3/5] docs: Only mention ssh in the man page when available

Kevin Wolf posted 5 patches 4 years ago
[PATCH 3/5] docs: Only mention ssh in the man page when available
Posted by Kevin Wolf 4 years ago
If libssh is disabled in the build, the man page shouldn't contain
information on how to use the ssh 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 | 18 ++++++++++--------
 1 file changed, 10 insertions(+), 8 deletions(-)

diff --git a/docs/system/device-url-syntax.rst.inc b/docs/system/device-url-syntax.rst.inc
index c882bce418..84a8145292 100644
--- a/docs/system/device-url-syntax.rst.inc
+++ b/docs/system/device-url-syntax.rst.inc
@@ -74,18 +74,20 @@ special URL syntax.
 
       |qemu_system| --drive file=nbd:unix:/tmp/nbd-socket
 
-``SSH``
-   QEMU supports SSH (Secure Shell) access to remote disks.
+.. only:: not DISABLE_LIBSSH
 
-   Examples:
+    ``SSH``
+       QEMU supports SSH (Secure Shell) access to remote disks.
 
-   .. parsed-literal::
+       Examples:
+
+       .. parsed-literal::
 
-      |qemu_system| -drive file=ssh://user@host/path/to/disk.img
-      |qemu_system| -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img
+          |qemu_system| -drive file=ssh://user@host/path/to/disk.img
+          |qemu_system| -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img
 
-   Currently authentication must be done using ssh-agent. Other
-   authentication methods may be supported in future.
+       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
-- 
2.31.1