Re: [PATCH 2/5] docs: differentiate between block driver create and runtime opts

[Eric Blake]

On Wed, Feb 01, 2023 at 04:12:31PM -0500, Stefan Hajnoczi wrote:
> Options available with qemu-img create -o ... are called create options.
> They affect how the image file is created on disk.
> 
> Options available with --blockdev ... are called runtime options. They
> affect how the open blockdev behaves.
> 
> The documentation makes no distinction is made between the two. For

s/is made //

> example, the preallocation filter driver talks about the runtime options
> while the image format drivers talk about the create options.
> 
> Be explicit about create vs runtime options.
> 
> Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
> ---
>  docs/system/qemu-block-drivers.rst.inc | 26 ++++++++++++++------------
>  1 file changed, 14 insertions(+), 12 deletions(-)
> 
> diff --git a/docs/system/qemu-block-drivers.rst.inc 
> b/docs/system/qemu-block-drivers.rst.inc
> index dfe5d2293d..be6eec1eb6 100644
> --- a/docs/system/qemu-block-drivers.rst.inc
> +++ b/docs/system/qemu-block-drivers.rst.inc
> @@ -6,9 +6,11 @@ any of the tools (like ``qemu-img``). This includes the 
> preferred formats
>  raw and qcow2 as well as formats that are supported for compatibility with
>  older QEMU versions or other hypervisors.
>  
> -Depending on the image format, different options can be passed to
> -``qemu-img create`` and ``qemu-img convert`` using the ``-o`` option.
> -This section describes each format and the options that are supported for it.
> +Depending on the image format, different options can be passed to ``qemu-img
> +create`` and ``qemu-img convert`` using the ``-o`` option. These are called
> +*create options*. Image formats also support different ``--blockdev`` 
> options.
> +These are called *runtime options*. This section describes each format and 
> the
> +options that are supported for it.
>  

Reviewed-by: Eric Blake <eblake@redhat.com>

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3266
Virtualization:  qemu.org | libvirt.org