qemu-block
[Top][All Lists]
Advanced

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

Re: [PATCH 00/13] qapi: convert "Note" and "Example" sections to rST


From: Markus Armbruster
Subject: Re: [PATCH 00/13] qapi: convert "Note" and "Example" sections to rST
Date: Wed, 26 Jun 2024 07:35:23 +0200
User-agent: Gnus/5.13 (Gnus v5.13)

You asked for a summary of my review findings.  Here it is:

* PATCH 01: DO-NOT-MERGE, not reviewed

* PATCH 02, 05..07, 10..12: R-by or A-by

* PATCH 03: R-by with straightforward minor adjustments

* PATCH 04, 08: R-by with commit message and doc tweaks

* PATCH 09:

  - Commit message tweaks

  - You convert "Note:" even in free-form doc, where it isn't
    recognized; separate patch or mention in commit message

  - You silently move one note; don't, separate patch, or mention in
    commit message

  - Tweak doc-interleaved-section.json

  - A few more notes need to start with a capital letter and / or end
    with a period

  - I don't like the indentation change

* PATCH 12: Want a positive test

* PATCH 13:

  - One hunk should be squashed into PATCH 09

  - Accidentally duplicated example should be dropped

  - You convert "Example:" even in free-form doc, where it isn't
    recognized; separate patch or mention in commit message

  - Sphinx doesn't recognize a .. code-block: directive in doc-good.json

  - doc-good.txt loses "Example"

  - Generated HTML looks somehwat ugly

Feel free to leave reverting indentation changes to me.  Same for
starting notes with a capital letter and ending them with a period.

I'm willing to accept ugly HTML along with a promise of future
improvement :)




reply via email to

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