Re: [PATCH v5 08/20] scripts/qapi/parser.py: improve doc comment indent handling

[Peter Maydell]

On Fri, 4 Sep 2020 at 10:03, Markus Armbruster <armbru@redhat.com> wrote:
> Peter Maydell <peter.maydell@linaro.org> writes:
> > Make the handling of indentation in doc comments more sophisticated,
> > so that when we see a section like:
> >
> > Notes: some text
> >        some more text
> >           indented line 3
> >
> > we save it for the doc-comment processing code as:
> >
> > some text
> > some more text
> >    indented line 3
> >
> > and when we see a section with the heading on its own line:
> >
> > Notes:
> >
> > some text
> > some more text
> >    indented text
> >
> > we also accept that and save it in the same form.
> >
> > The exception is that we always retain indentation as-is for Examples
> > sections, because these are literal text.
>
> Does docs/devel/qapi-code-gen.txt need an update?  Hmm, looks like you
> leave it to [PATCH 15] docs/devel/qapi-code-gen.txt: Update to new rST
> backend conventions.  Acceptable.  Mentioning it in the commit message
> now may make sense.

I've decided to pull the bits of patch 15 which document the
new indent rules into this patch, in the optimistic hope that
if the patchseries is OK up to this point but needs another
review round for subsequent parts we might be able to commit
this patch to master and stop further inadvertent breaches
of the new indent rules being committed. (Another couple have
already appeared in master since v5, so v6 will again start
with a patch fixing them up.)

thanks
-- PMM