All of lore.kernel.org
 help / color / mirror / Atom feed
From: Markus Armbruster <armbru@redhat.com>
To: "Marc-André Lureau" <marcandre.lureau@redhat.com>
Cc: qemu-devel@nongnu.org
Subject: Re: [Qemu-devel] [PATCH v2 02/11] qapi: fix schema symbol sections
Date: Wed, 26 Oct 2016 15:30:57 +0200	[thread overview]
Message-ID: <87insfme3y.fsf@dusky.pond.sub.org> (raw)
In-Reply-To: <20160925181836.18293-3-marcandre.lureau@redhat.com> ("Marc-André Lureau"'s message of "Sun, 25 Sep 2016 22:18:27 +0400")

Marc-André 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é 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' }
 
 ##
@@ -4429,7 +4430,7 @@
 #
 # @DIMM: memory slot
 # @CPU: logical CPU slot (since 2.7)
-#
+##
 { 'enum': 'ACPISlotType', 'data': [ 'DIMM', 'CPU' ] }
 
 ##

  reply	other threads:[~2016-10-26 13:31 UTC|newest]

Thread overview: 29+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-09-25 18:18 [Qemu-devel] [PATCH v2 00/11] qapi doc generation (whole version, squashed) Marc-André Lureau
2016-09-25 18:18 ` [Qemu-devel] [PATCH v2 01/11] qapi: add qapi2texi script Marc-André Lureau
2016-10-28 16:44   ` Markus Armbruster
2016-10-28 19:56     ` Eric Blake
2016-11-02  9:25     ` Marc-André Lureau
2016-11-03 13:46       ` Markus Armbruster
2016-11-03 16:24         ` Marc-André Lureau
2016-09-25 18:18 ` [Qemu-devel] [PATCH v2 02/11] qapi: fix schema symbol sections Marc-André Lureau
2016-10-26 13:30   ` Markus Armbruster [this message]
2016-11-04 12:11     ` Marc-André Lureau
2016-09-25 18:18 ` [Qemu-devel] [PATCH v2 03/11] qapi: fix missing symbol @prefix Marc-André Lureau
2016-10-26 13:37   ` Markus Armbruster
2016-11-04 12:05     ` Marc-André Lureau
2016-09-25 18:18 ` [Qemu-devel] [PATCH v2 04/11] qapi: fix @ACPI sections Marc-André Lureau
2016-10-26 13:38   ` Markus Armbruster
2016-09-25 18:18 ` [Qemu-devel] [PATCH v2 05/11] docs: add qapi texi template Marc-André Lureau
2016-10-27 14:55   ` Markus Armbruster
2016-11-04 13:27     ` Marc-André Lureau
2016-11-08 14:04       ` Markus Armbruster
2016-09-25 18:18 ` [Qemu-devel] [PATCH v2 06/11] build-sys: add qapi doc generation targets Marc-André Lureau
2016-10-27 16:16   ` Markus Armbruster
2016-09-25 18:18 ` [Qemu-devel] [PATCH v2 07/11] (SQUASHED) qmp-commands docs move to schema Marc-André Lureau
2016-09-25 18:18 ` [Qemu-devel] [PATCH v2 08/11] qapi: add some sections in docs and fix Marc-André Lureau
2016-09-25 18:18 ` [Qemu-devel] [PATCH v2 09/11] qga: fix guest-get-memory-block-info doc Marc-André Lureau
2016-10-27 16:58   ` Markus Armbruster
2016-09-25 18:18 ` [Qemu-devel] [PATCH v2 10/11] texi2pod: learn quotation, deftp and deftypefn Marc-André Lureau
2016-09-25 18:18 ` [Qemu-devel] [PATCH v2 11/11] build-sys: make and install the generated schema docs Marc-André Lureau
2016-10-26  9:36 ` [Qemu-devel] [PATCH v2 00/11] qapi doc generation (whole version, squashed) Markus Armbruster
2016-11-02 12:11   ` Markus Armbruster

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87insfme3y.fsf@dusky.pond.sub.org \
    --to=armbru@redhat.com \
    --cc=marcandre.lureau@redhat.com \
    --cc=qemu-devel@nongnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.