qapi: Document intended use of @name within alternate visits

Backports commit ed0ba0f47e8cb6d924db0a54090bbb7b095fe9ea from qemu
This commit is contained in:
Markus Armbruster 2018-03-03 17:37:10 -05:00 committed by Lioncash
parent 5ab0d5af81
commit e9174563be
No known key found for this signature in database
GPG Key ID: 4E3C3CC1031BA9C7

View File

@ -65,8 +65,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