| Message ID | 20200925162316.21205-12-peter.maydell@linaro.org |
|---|---|
| State | New |
| Headers | show |
| Series | Convert QAPI doc comments to generate rST instead of texinfo | expand |
Peter Maydell <peter.maydell@linaro.org> writes: > Add some section headings to the QGA json; this is purely so that we > have some H1 headings, as otherwise each command ends up being > visible in the interop/ manual's table of contents. In an ideal > world there might be a proper 'Introduction' section the way there is > in qapi/qapi-schema.json. Definitely. > Reviewed-by: Richard Henderson <richard.henderson@linaro.org> > Signed-off-by: Peter Maydell <peter.maydell@linaro.org> > --- > qga/qapi-schema.json | 8 +++++--- > 1 file changed, 5 insertions(+), 3 deletions(-) > > diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json > index d2ea7446db6..cec98c7e065 100644 > --- a/qga/qapi-schema.json > +++ b/qga/qapi-schema.json > @@ -2,14 +2,16 @@ > # vim: filetype=python > > ## > -# > -# General note concerning the use of guest agent interfaces: > +# = General note concerning the use of guest agent interfaces > # > # "unsupported" is a higher-level error than the errors that individual > # commands might document. The caller should always be prepared to receive > # QERR_UNSUPPORTED, even if the given command doesn't specify it, or doesn't > # document any failure mode at all. > -# > +## > + > +## > +# = QEMU guest agent protocol commands and structs > ## > > { 'pragma': { 'doc-required': true } } Good enough for now. Reviewed-by: Markus Armbruster <armbru@redhat.com>
diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json index d2ea7446db6..cec98c7e065 100644 --- a/qga/qapi-schema.json +++ b/qga/qapi-schema.json @@ -2,14 +2,16 @@ # vim: filetype=python ## -# -# General note concerning the use of guest agent interfaces: +# = General note concerning the use of guest agent interfaces # # "unsupported" is a higher-level error than the errors that individual # commands might document. The caller should always be prepared to receive # QERR_UNSUPPORTED, even if the given command doesn't specify it, or doesn't # document any failure mode at all. -# +## + +## +# = QEMU guest agent protocol commands and structs ## { 'pragma': { 'doc-required': true } }