OpenE2K
/
qemu-e2k
13
4
Fork 0
Code Issues 4 Pull Requests Projects 2 Releases Activity

docs: Consistent typography for options of qemu-nbd 

Prefer the :option:`--name` form when cross-referencing other options
from the qemu-nbd documentation.

Signed-off-by: Eric Blake <eblake@redhat.com>
Message-Id: <20220314203818.3681277-2-eblake@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
This commit is contained in:
Eric Blake 2022-03-14 15:38:16 -05:00
parent 80f00ca280
commit a2c2d44ae1
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/tools/qemu-nbd.rst
View File

@ -27,7 +27,7 @@ Options
.. program:: qemu-nbd .. program:: qemu-nbd
*filename* is a disk image filename, or a set of block *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. *dev* is an NBD device.
@ -165,9 +165,9 @@ driver options if ``--image-opts`` is specified.
.. option:: --tls-creds=ID .. option:: --tls-creds=ID
Enable mandatory TLS encryption for the server by setting the ID Enable mandatory TLS encryption for the server by setting the ID
of the TLS credentials object previously created with the --object of the TLS credentials object previously created with the
option; or provide the credentials needed for connecting as a client :option:`--object` option; or provide the credentials needed for
in list mode. connecting as a client in list mode.
.. option:: --tls-hostname=hostname .. option:: --tls-hostname=hostname
@ -176,11 +176,11 @@ driver options if ``--image-opts`` is specified.
against information in the server provided certificate. Sometimes against information in the server provided certificate. Sometimes
it might be required to override the hostname used to perform this 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 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 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 server. This can also be used if accessing NBD over a UNIX socket
where there is no inherent hostname available. This is only permitted 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 .. option:: --fork