docs: clarify 'readahead' and 'timeout' for disks

Document the format of the 'readahead' and 'timeout' XML elements more
accurately.

Signed-off-by: Jonathon Jongsma <jjongsma@redhat.com>
Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
This commit is contained in:
Jonathon Jongsma 2022-06-15 11:21:58 -05:00
parent d375993ab3
commit 4260a642d3

View File

@ -2878,11 +2878,13 @@ paravirtualized driver is specified via the ``disk`` element.
more cookies. The cookie name and value must conform to the HTTP
specification. :since:`Since 6.2.0`
``readahead``
Specifies the size of the readahead buffer for protocols which support it.
(all 'curl' based drivers in qemu). The size is in bytes. Note that '0' is
considered as if the value is not provided. :since:`Since 6.2.0`
The ``readahead`` element has a ``size`` attribute which specifies the
size of the readahead buffer in bytes for protocols which support it.
Note that '0' is considered as if the value is not provided.
:since:`Since 6.2.0`
``timeout``
Specifies the connection timeout for protocols which support it. Note that
The ``timeout`` element has a ``seconds`` attribute which specifies the
connection timeout in seconds for protocols which support it. Note that
'0' is considered as if the value is not provided. :since:`Since 6.2.0`
``identity``
When using an ``nfs`` protocol, this is used to provide information on the