qapi-schema: Document how generated documentation is ordered
commit211e5063be7ffc34ed1daaa4a1aa5f5cfb039995
authorMarkus Armbruster <armbru@redhat.com>
Thu, 24 Aug 2017 19:13:53 +0000 (24 21:13 +0200)
committerMarkus Armbruster <armbru@redhat.com>
Mon, 4 Sep 2017 11:09:12 +0000 (4 13:09 +0200)
treea8cf84e8b53617444621e2939e19c465581cc7c4
parentcbb654052600c376d5ee3401c98a25d09d11a154
qapi-schema: Document how generated documentation is ordered

Documentation generated with qapi2texi.py is in source order, with
included sub-schemas inserted at the first include directive
(subsequent include directives have no effect).  To get a sane and
stable order, it's best to include each sub-schema just once, or
include it first in qapi-schema.json.  Document that.

While there, drop a few redundant comments.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Message-Id: <1503602048-12268-2-git-send-email-armbru@redhat.com>
qapi-schema.json