]> git.proxmox.com Git - mirror_qemu.git/commit
docs/devel/qapi-code-gen: Reorder sections for readability
authorMarkus Armbruster <armbru@redhat.com>
Fri, 13 Sep 2019 20:13:45 +0000 (22:13 +0200)
committerMarkus Armbruster <armbru@redhat.com>
Tue, 24 Sep 2019 12:07:22 +0000 (14:07 +0200)
commitf5821f526289badd667bcc288e5deaf5417466df
tree3a1d8658c9fa3ef4ecb863b4e59e109ffd91a408
parent398969fe1c6f696e19d0f317dd055c6b17e2cee6
docs/devel/qapi-code-gen: Reorder sections for readability

Section "QMP/Guest agent schema" starts with a brief introduction,
then subsection "Comments", then subsection "Schema overview" (more
elaborate introduction), and only then talks about schema entities
like types, commands, and so forth.

Subsection "Comments" is long and tiring: almost 500 words, mostly
about doc comments.  Move the doc comment part to its own subsection
"Documentation comments" at the very end of "QMP/Guest agent schema".

Subsection "Schema overview" explains naming rules at considerable
length: 250 words.  Move this part to its own subsection "Naming rules
and reserved names" right after the subsections on schema entities.

Subsection "Enumeration types" is wedged between "Struct types" and
"Union types".  Move it before "Struct types".

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-Id: <20190913201349.24332-13-armbru@redhat.com>
docs/devel/qapi-code-gen.txt