On Tue, Sep 22, 2026 at 10:53 AM Markus Armbruster <[email protected]> wrote: > > John Snow <[email protected]> writes: > > > Note that these intro conversions introduce a new intro/details split > > point. This new split point may or may not change the rendered output > > depending on if any documentation is generated for this definition. > > Uh, we generate documentation for *all* definitions.
I meant ... generated from the definition itself and inserted. We don't "generate" documentation for every doc block. > > > > > Signed-off-by: John Snow <[email protected]> > > --- > > qga/qapi-schema.json | 11 ++++------- > > 1 file changed, 4 insertions(+), 7 deletions(-) > > > > diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json > > index b592b14a011..19b0958b84e 100644 > > --- a/qga/qapi-schema.json > > +++ b/qga/qapi-schema.json > > @@ -401,8 +401,7 @@ > > > > ## > > # @guest-fsfreeze-status: > > -# > > -# Get guest fsfreeze state. > > +# Get guest fsfreeze state. > > # > > # .. note:: This may fail to properly report the current state as a > > # result of some other guest processes having issued an fs > > This one does affect rendered docs: the auto-generated Returns moves > from below the note to above, where it belongs. > > > @@ -925,9 +924,8 @@ > > > > ## > > # @GuestNVMeSmart: > > -# > > -# NVMe smart information, based on NVMe specification, section > > -# <SMART / Health Information (Log Identifier 02h)> > > +# NVMe smart information, based on NVMe specification, section > > +# <SMART / Health Information (Log Identifier 02h)> > > # > > # TODO: document members briefly > > # > > @@ -1816,8 +1814,7 @@ > > > > ## > > # @guest-get-load: > > -# > > -# Retrieve CPU process load information > > +# Retrieve CPU process load information > > # > > # .. note:: Windows does not have load average API, so QGA emulates it > > # by calculating the average CPU usage in the last 1, 5, 15 minutes > > These don't. > > A possible commit message correction: > > Note that these intro conversions introduce a new intro/details split > point. Only the first one affects the rendered output. Sure.
