Re: [Qemu-devel] [PATCH v2 12/16] docs/devel/qapi-code-gen: Reorder sections for readability

[Eric Blake]

On 9/10/19 1:37 AM, Markus Armbruster wrote:
> 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 <address@hidden>
> ---
>  docs/devel/qapi-code-gen.txt | 436 ++++++++++++++++++-----------------
>  1 file changed, 221 insertions(+), 215 deletions(-)

Large patch, but mostly just shuffling sections.

Reviewed-by: Eric Blake <address@hidden>

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3226
Virtualization:  qemu.org | libvirt.org

signature.asc
Description: OpenPGP digital signature