From: Jonathon Jongsma Date: Wed, 15 Jun 2022 16:21:58 +0000 (-0500) Subject: docs: clarify 'readahead' and 'timeout' for disks X-Git-Tag: v8.5.0-rc1~3 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4260a642d3de4330d38f08d2dc06c4ed9aeb8282;p=thirdparty%2Flibvirt.git docs: clarify 'readahead' and 'timeout' for disks Document the format of the 'readahead' and 'timeout' XML elements more accurately. Signed-off-by: Jonathon Jongsma Reviewed-by: Michal Privoznik --- diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index 991d45672a..62a94890f0 100644 --- a/docs/formatdomain.rst +++ b/docs/formatdomain.rst @@ -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