Re: [PATCH] qapi/block: fix nbd-server-add spec

[Nir Soffer]

On Thu, Dec 19, 2019 at 4:34 PM Vladimir Sementsov-Ogievskiy
<address@hidden> wrote:
>
> "NAME" here may be interpreted like it should match @name, which is
> export name. But it was never mentioned in such way. Make it obvious,
> that actual "<dirty-bitmap-export-name>" (see docs/interop/nbd.txt)
> will match @bitmap parameter.

But this is wrong, dirty-bitmap-export-name does not mean the actual bitmap
name but the name exposed to the NBD client, which can be anything.

> Fixes: 5fcbeb06812685a2
> Signed-off-by: Vladimir Sementsov-Ogievskiy <address@hidden>
> ---
>
> Hi all.
>
> This patch follows discussion on Nir's patch
>  [PATCH] block: nbd: Fix dirty bitmap context name
>  ( https://lists.gnu.org/archive/html/qemu-devel/2019-12/msg04309.html )
>
> Let's just fix qapi spec now.

But qapi documents a better behavior for users. We should fix the code instead
to mach the docs.

With this we still have the issue of leaking internal bitmap name to
users who do not
control the name, and do not care about it.

>  qapi/block.json | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/qapi/block.json b/qapi/block.json
> index 145c268bb6..8042ef78f0 100644
> --- a/qapi/block.json
> +++ b/qapi/block.json
> @@ -255,7 +255,8 @@
>
>  # @bitmap: Also export the dirty bitmap reachable from @device, so the
>  #          NBD client can use NBD_OPT_SET_META_CONTEXT with
> -#          "qemu:dirty-bitmap:NAME" to inspect the bitmap. (since 4.0)
> +#          "qemu:dirty-bitmap:BITMAP" to inspect the bitmap (BITMAP here
> +#          matches @bitmap parameter). (since 4.0)
>  #
>  # Returns: error if the server is not running, or export with the same name
>  #          already exists.
> --
> 2.21.0
>