From mboxrd@z Thu Jan  1 00:00:00 1970
Received: from eggs.gnu.org ([2001:4830:134:3::10]:52612)
	by lists.gnu.org with esmtp (Exim 4.71)
	(envelope-from <armbru@redhat.com>) id 1bzOIK-0000Hr-Ks
	for qemu-devel@nongnu.org; Wed, 26 Oct 2016 09:31:05 -0400
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
	(envelope-from <armbru@redhat.com>) id 1bzOIG-00087C-Mi
	for qemu-devel@nongnu.org; Wed, 26 Oct 2016 09:31:04 -0400
Received: from mx1.redhat.com ([209.132.183.28]:39288)
	by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32)
	(Exim 4.71) (envelope-from <armbru@redhat.com>) id 1bzOIG-000870-HN
	for qemu-devel@nongnu.org; Wed, 26 Oct 2016 09:31:00 -0400
Received: from int-mx14.intmail.prod.int.phx2.redhat.com
	(int-mx14.intmail.prod.int.phx2.redhat.com [10.5.11.27])
	(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
	(No client certificate requested)
	by mx1.redhat.com (Postfix) with ESMTPS id A3027C054908
	for <qemu-devel@nongnu.org>; Wed, 26 Oct 2016 13:30:59 +0000 (UTC)
From: Markus Armbruster <armbru@redhat.com>
References: <20160925181836.18293-1-marcandre.lureau@redhat.com>
	<20160925181836.18293-3-marcandre.lureau@redhat.com>
Date: Wed, 26 Oct 2016 15:30:57 +0200
In-Reply-To: <20160925181836.18293-3-marcandre.lureau@redhat.com>
	(=?utf-8?Q?=22Marc-Andr=C3=A9?=
	Lureau"'s message of "Sun, 25 Sep 2016 22:18:27 +0400")
Message-ID: <87insfme3y.fsf@dusky.pond.sub.org>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
Subject: Re: [Qemu-devel] [PATCH v2 02/11] qapi: fix schema symbol sections
List-Id: <qemu-devel.nongnu.org>
List-Unsubscribe: <https://lists.nongnu.org/mailman/options/qemu-devel>,
	<mailto:qemu-devel-request@nongnu.org?subject=unsubscribe>
List-Archive: <http://lists.nongnu.org/archive/html/qemu-devel/>
List-Post: <mailto:qemu-devel@nongnu.org>
List-Help: <mailto:qemu-devel-request@nongnu.org?subject=help>
List-Subscribe: <https://lists.nongnu.org/mailman/listinfo/qemu-devel>,
	<mailto:qemu-devel-request@nongnu.org?subject=subscribe>
To: =?utf-8?Q?Marc-Andr=C3=A9?= Lureau <marcandre.lureau@redhat.com>
Cc: qemu-devel@nongnu.org

Marc-Andr=C3=A9 Lureau <marcandre.lureau@redhat.com> writes:

> According to documentation, there needs to be '##' to start a symbol

Suggest to be explicit, and say "According to docs/qapi-code-gen.txt".

> section, that's also what the documentation parser expects.

Does the doc parser complain when its expectation isn't met?  I haven't
reviewed it, yet...

In my opinion, qapi-code-gen.txt should demand everything the doc parser
needs (it may demand more), and the doc parser should complain about
everything qapi-code-gen.txt demands and the schema doesn't provide.

> Signed-off-by: Marc-Andr=C3=A9 Lureau <marcandre.lureau@redhat.com>

The patch fixes all missing '##' at the beginning of definition comment
blocks.  Good.

qapi-code-gen.txt also demands '##' at the end.  Does the parser rely on
it?  Offenders:

diff --git a/qapi-schema.json b/qapi-schema.json
index fc732cb..0cc9ee6 100644
--- a/qapi-schema.json
+++ b/qapi-schema.json
@@ -780,6 +780,7 @@
 # command.
 #
 # Since: 2.5
+##
 { 'command': 'migrate-start-postcopy' }
=20
 ##
@@ -4429,7 +4430,7 @@
 #
 # @DIMM: memory slot
 # @CPU: logical CPU slot (since 2.7)
-#
+##
 { 'enum': 'ACPISlotType', 'data': [ 'DIMM', 'CPU' ] }
=20
 ##