[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH v3 01/12] qapi/qapi-schema.json: Put headers in their own doc
From: |
Richard Henderson |
Subject: |
Re: [PATCH v3 01/12] qapi/qapi-schema.json: Put headers in their own doc-comment blocks |
Date: |
Thu, 27 Feb 2020 05:53:06 -0800 |
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.4.1 |
On 2/25/20 6:04 AM, Peter Maydell wrote:
> Our current QAPI doc-comment markup allows section headers
> (introduced with a leading '=' or '==') anywhere in any documentation
> comment. This works for texinfo because the texi generator simply
> prints a texinfo heading directive at that point in the output
> stream. For rST generation, since we're assembling a tree of
> docutils nodes, this is awkward because a new section implies
> starting a new section node at the top level of the tree and
> generating text into there.
>
> New section headings in the middle of the documentation of a command
> or event would be pretty nonsensical, and in fact we only ever output
> new headings using 'freeform' doc comment blocks whose only content
> is the single line of the heading, with two exceptions, which are in
> the introductory freeform-doc-block at the top of
> qapi/qapi-schema.json.
>
> Split that doc-comment up so that the heading lines are in their own
> doc-comment. This will allow us to tighten the specification to
> insist that heading lines are always standalone, rather than
> requiring the rST document generator to look at every line in a doc
> comment block and handle headings in odd places.
>
> This change makes no difference to the generated texi.
>
> Signed-off-by: Peter Maydell <address@hidden>
> ---
> qapi/qapi-schema.json | 12 +++++++++---
> 1 file changed, 9 insertions(+), 3 deletions(-)
Reviewed-by: Richard Henderson <address@hidden>
r~
- [PATCH v3 00/12] Convert QAPI doc comments to generate rST instead of texinfo, Peter Maydell, 2020/02/25
- [PATCH v3 01/12] qapi/qapi-schema.json: Put headers in their own doc-comment blocks, Peter Maydell, 2020/02/25
- Re: [PATCH v3 01/12] qapi/qapi-schema.json: Put headers in their own doc-comment blocks,
Richard Henderson <=
- [PATCH v3 02/12] qapi/machine.json: Escape a literal '*' in doc comment, Peter Maydell, 2020/02/25
- [PATCH v3 03/12] tests/qapi/doc-good.json: Clean up markup, Peter Maydell, 2020/02/25
- [PATCH v3 04/12] scripts/qapi: Move doc-comment whitespace stripping to doc.py, Peter Maydell, 2020/02/25
- [PATCH v3 05/12] scripts/qapi/parser.py: improve doc comment indent handling, Peter Maydell, 2020/02/25
- [PATCH v3 09/12] qapi: Use rST markup for literal blocks, Peter Maydell, 2020/02/25
- [PATCH v3 06/12] docs/sphinx: Add new qapi-doc Sphinx extension, Peter Maydell, 2020/02/25