[Qemu-devel] [PATCH v6 01/15] qapi: Visitor documentation tweak

[Eric Blake]

Make it clear that the name parameter to visit_start_struct()
has the same semantics as for visit_start_int().

Signed-off-by: Eric Blake <address@hidden>

---
v6: split into separate patch
---
 include/qapi/visitor.h | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/include/qapi/visitor.h b/include/qapi/visitor.h
index 6c77a91..4dd7532 100644
--- a/include/qapi/visitor.h
+++ b/include/qapi/visitor.h
@@ -60,11 +60,12 @@
  * visitors are declared here; the remaining visitors are generated in
  * qapi-visit.h.
  *
- * 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.
+ * The @name parameter of visit_type_FOO() and visit_start_OBJECT()
+ * 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.
  *
  * FIXME: Clients must pass NULL for @name when visiting a member of a
  * list, but this leads to poor error messages; it might be nicer to
-- 
2.7.4