diff options
| author | Markus Armbruster <armbru@redhat.com> | 2017-04-27 10:41:25 +0200 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2017-05-09 09:14:40 +0200 |
| commit | ed0ba0f47e8cb6d924db0a54090bbb7b095fe9ea (patch) | |
| tree | 8db0c0dc4180d6f343a30d8735a0322906e247f6 /include/qapi | |
| parent | 6c02258e143700314ebf268dae47eb23db17d1cf (diff) | |
qapi: Document intended use of @name within alternate visits
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <1493282486-28338-4-git-send-email-armbru@redhat.com>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Diffstat (limited to 'include/qapi')
| -rw-r--r-- | include/qapi/visitor.h | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/include/qapi/visitor.h b/include/qapi/visitor.h index 1a1b62012b..b0e233df76 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 *@obj during input visits, leave it unchanged on |