Re: [PATCH] qsd: document vduse-blk exports

[Yongji Xie]

On Wed, May 25, 2022 at 8:19 PM Stefan Hajnoczi <stefanha@redhat.com> wrote:
>
> Document vduse-blk exports in qemu-storage-daemon --help and the
> qemu-storage-daemon(1) man page.
>
> Based-on: <20220523084611.91-1-xieyongji@bytedance.com>
> Cc: Xie Yongji <xieyongji@bytedance.com>
> Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
> ---
>  docs/tools/qemu-storage-daemon.rst   | 21 +++++++++++++++++++++
>  storage-daemon/qemu-storage-daemon.c |  8 ++++++++
>  2 files changed, 29 insertions(+)
>
> diff --git a/docs/tools/qemu-storage-daemon.rst 
> b/docs/tools/qemu-storage-daemon.rst
> index 8b97592663..1b461193e7 100644
> --- a/docs/tools/qemu-storage-daemon.rst
> +++ b/docs/tools/qemu-storage-daemon.rst
> @@ -77,6 +77,7 @@ Standard options:
>    --export 
> [type=]vhost-user-blk,id=<id>,node-name=<node-name>,addr.type=unix,addr.path=<socket-path>[,writable=on|off][,logical-block-size=<block-size>][,num-queues=<num-queues>]
>    --export 
> [type=]vhost-user-blk,id=<id>,node-name=<node-name>,addr.type=fd,addr.str=<fd>[,writable=on|off][,logical-block-size=<block-size>][,num-queues=<num-queues>]
>    --export 
> [type=]fuse,id=<id>,node-name=<node-name>,mountpoint=<file>[,growable=on|off][,writable=on|off][,allow-other=on|off|auto]
> +  --export 
> [type=]vduse-blk,id=<id>,node-name=<node-name>[,writable=on|off][,num-queues=<num-queues>][,queue-size=<queue-size>][,logical-block-size=<block-size>]
>
>    is a block export definition. ``node-name`` is the block node that should 
> be
>    exported. ``writable`` determines whether or not the export allows write
> @@ -110,6 +111,26 @@ Standard options:
>    ``allow-other`` to auto (the default) will try enabling this option, and on
>    error fall back to disabling it.
>
> +  The ``vduse-blk`` export type uses the ``id`` as the VDUSE device name.
> +  ``num-queues`` sets the number of virtqueues (the default is 1).
> +  ``queue-size`` sets the virtqueue descriptor table size (the default is 
> 256).
> +
> +  The instantiated VDUSE device must then be added to the vDPA bus using the
> +  vdpa(8) command from the iproute2 project::
> +
> +  # vdpa dev add <id> mgmtdev vduse

Should it be:

# vdpa dev add name <id> mgmtdev vduse

Thanks,
Yongji