[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH v2 06/30] qga/qapi-schema.json: minor format fixups for rST

From: Markus Armbruster
Subject: Re: [PATCH v2 06/30] qga/qapi-schema.json: minor format fixups for rST
Date: Fri, 14 Feb 2020 13:46:50 +0100
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/26.3 (gnu/linux)

Peter Maydell <address@hidden> writes:

> rST format requires a blank line before the start of a bulleted
> or enumerated list. Two places in qapi-schema.json were missing
> this blank line.

Relies on the previous commit message's "we would like to add a rST
backend" to establish context.  Suggest:

  We would like to switch the doc comments to rST format, and rST

> Some places were using an indented line as a sort of single-item
> bulleted list, which in the texinfo output comes out all run
> onto a single line; use a real bulleted list instead.

The old text tempts developers to add additional items the same way, and
the all items run together.  So this makes sense on its own.

> Some places unnecessarily indented lists, which confuses rST.
> guest-fstrim:minimum's documentation was indented the
> right amount to share a line with @minimum, but wasn't
> actually doing so.
> The indent on the bulleted list in the guest-set-vcpus
> Returns section meant rST misindented it.
> Changes to the generated texinfo are very minor (the new
> bulleted lists, and a few extra blank lines).
> Signed-off-by: Peter Maydell <address@hidden>

I checked the plain text output, and it's fine.

Preferably with the commit message tweak I suggested
Reviewed-by: Markus Armbruster <address@hidden>

reply via email to

[Prev in Thread] Current Thread [Next in Thread]