diff mbox series

[v3,1/3] docs: Consistent typography for options of qemu-nbd

Message ID 20220314203818.3681277-2-eblake@redhat.com
State New
Headers show
Series nbd: MULTI_CONN for shared writable exports | expand

Commit Message

Eric Blake March 14, 2022, 8:38 p.m. UTC 
Prefer the :option:`--name` form when cross-referencing other options
from the qemu-nbd documentation.

Signed-off-by: Eric Blake <eblake@redhat.com>
---
 docs/tools/qemu-nbd.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

Comments

Daniel P. Berrangé March 17, 2022, 8:15 a.m. UTC | #1 
On Mon, Mar 14, 2022 at 03:38:16PM -0500, Eric Blake wrote:
> Prefer the :option:`--name` form when cross-referencing other options
> from the qemu-nbd documentation.
> 
> Signed-off-by: Eric Blake <eblake@redhat.com>
> ---
>  docs/tools/qemu-nbd.rst | 12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)

Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>


With regards,
Daniel
diff mbox series

Patch

diff --git a/docs/tools/qemu-nbd.rst b/docs/tools/qemu-nbd.rst
index 2b8c90c35498..4c950f61998e 100644
--- a/docs/tools/qemu-nbd.rst
+++ b/docs/tools/qemu-nbd.rst
@@ -27,7 +27,7 @@  Options
 .. program:: qemu-nbd

 *filename* is a disk image filename, or a set of block
-driver options if ``--image-opts`` is specified.
+driver options if :option:`--image-opts` is specified.

 *dev* is an NBD device.

@@ -165,9 +165,9 @@  driver options if ``--image-opts`` is specified.
 .. option:: --tls-creds=ID

   Enable mandatory TLS encryption for the server by setting the ID
-  of the TLS credentials object previously created with the --object
-  option; or provide the credentials needed for connecting as a client
-  in list mode.
+  of the TLS credentials object previously created with the
+  :option:`--object` option; or provide the credentials needed for
+  connecting as a client in list mode.

 .. option:: --tls-hostname=hostname

@@ -176,11 +176,11 @@  driver options if ``--image-opts`` is specified.
   against information in the server provided certificate. Sometimes
   it might be required to override the hostname used to perform this
   check. For example, if the NBD client is using a tunnel from localhost
-  to connect to the remote server, the `--tls-hostname` option should
+  to connect to the remote server, the :option:`--tls-hostname` option should
   be used to set the officially expected hostname of the remote NBD
   server. This can also be used if accessing NBD over a UNIX socket
   where there is no inherent hostname available. This is only permitted
-  when acting as a NBD client with the `--list` option.
+  when acting as a NBD client with the :option:`--list` option.

 .. option:: --fork