From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:59350) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dY8GI-0000b8-Ua for qemu-devel@nongnu.org; Thu, 20 Jul 2017 06:00:51 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dY8GE-0003rL-6m for qemu-devel@nongnu.org; Thu, 20 Jul 2017 06:00:50 -0400 Received: from mx1.redhat.com ([209.132.183.28]:50220) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1dY8GD-0003qo-Tj for qemu-devel@nongnu.org; Thu, 20 Jul 2017 06:00:46 -0400 From: Markus Armbruster References: <20170714190827.4083-1-eblake@redhat.com> <20170714190827.4083-4-eblake@redhat.com> Date: Thu, 20 Jul 2017 12:00:42 +0200 In-Reply-To: <20170714190827.4083-4-eblake@redhat.com> (Eric Blake's message of "Fri, 14 Jul 2017 14:08:25 -0500") Message-ID: <87fudrmnqt.fsf@dusky.pond.sub.org> MIME-Version: 1.0 Content-Type: text/plain Subject: Re: [Qemu-devel] [PATCH 3/5] qapi: Visitor documentation tweak List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Eric Blake Cc: qemu-devel@nongnu.org, Michael Roth Eric Blake writes: > 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 > --- > include/qapi/visitor.h | 14 +++++++------- > 1 file changed, 7 insertions(+), 7 deletions(-) > > diff --git a/include/qapi/visitor.h b/include/qapi/visitor.h > index b0a048f..dc09cc7 100644 > --- a/include/qapi/visitor.h > +++ b/include/qapi/visitor.h > @@ -60,13 +60,13 @@ > * 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; 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 @name parameter of visit_type_FOO() and visit_start_OBJECT() Our terminology is horrible: JSON object / QDict / QAPI complex type (struct or union) JSON array / QList / QAPI array or list (used interchangeably) JSON value / QObject / QAPI I'm-not-even-sure-what Because of this mess, nobody knows what you mean when you say OBJECT. visit_start_BAR()? > + * 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; 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 Reviewed-by: Markus Armbruster