Re: [Qemu-devel] [PATCH 3/4] qapi: Document intended use of @name within alternate visits

[Marc-André Lureau]

On Thu, Apr 27, 2017 at 12:42 PM Markus Armbruster <address@hidden>
wrote:

> Signed-off-by: Markus Armbruster <address@hidden>
>

Reviewed-by: Marc-André Lureau <address@hidden>



> ---
>  include/qapi/visitor.h | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
>
> diff --git a/include/qapi/visitor.h b/include/qapi/visitor.h
> index 1a1b620..b0e233d 100644
> --- a/include/qapi/visitor.h
> +++ b/include/qapi/visitor.h
> @@ -63,8 +63,10 @@
>   * The @name parameter of visit_type_FOO() describes the relation
>   * between this QAPI value and its parent container.  When visiting
>   * the root of a tree, @name is ignored; when visiting a member of an
> - * object, @name is the key associated with the value; and when
> - * visiting a member of a list, @name is NULL.
> + * object, @name is the key associated with the value; when visiting a
> + * member of a list, @name is NULL; and when visiting the member of an
> + * alternate, @name should equal the name used for visiting the
> + * alternate.
>   *
>   * The visit_type_FOO() functions expect a non-null @obj argument;
>   * they allocate address@hidden during input visits, leave it unchanged on
> --
> 2.7.4
>
>
> --
Marc-André Lureau