[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH v2 05/30] qga/qapi-schema.json: Fix indent level on doc comme
From: |
Peter Maydell |
Subject: |
Re: [PATCH v2 05/30] qga/qapi-schema.json: Fix indent level on doc comments |
Date: |
Fri, 14 Feb 2020 12:40:49 +0000 |
On Fri, 14 Feb 2020 at 12:36, Markus Armbruster <address@hidden> wrote:
>
> Peter Maydell <address@hidden> writes:
>
> > The texinfo doc generation doesn't care much about indentation
>
> Let's spell Texinfo with a capital T.
>
> > levels, but we would like to add a rST backend, and rST does care
> > about indentation.
>
> Nitpick: an rST *backend* should not care about the doc generator's
> *input* format. We actually intend to change the input format into a
> domain-specific dialect of rST, as you state in your cover letter: "This
> series switches all our QAPI doc comments over from texinfo format to
> rST."
>
> Perhaps:
>
> The current doc generation doesn't care much about indentation levels,
> but we would like to switch to an rST format, and rST does care about
> indentation.
Works for me. Let me know if you're OK just making this kind
of commit message tweak/minor fixup and sending a pull, or
if you want me to roll a v3.
thanks
-- PMM
- Re: [PATCH v2 01/30] configure: Allow user to specify sphinx-build binary, (continued)
[PATCH v2 02/30] configure: Check that sphinx-build is using Python 3, Peter Maydell, 2020/02/13
[PATCH v2 03/30] Makefile: Fix typo in dependency list for interop manpages, Peter Maydell, 2020/02/13
[PATCH v2 04/30] qga/qapi-schema.json: Fix missing '-' in GuestDiskBusType doc comment, Peter Maydell, 2020/02/13
[PATCH v2 07/30] qapi/block-core.json: Use literal block for ascii art, Peter Maydell, 2020/02/13
[PATCH v2 05/30] qga/qapi-schema.json: Fix indent level on doc comments, Peter Maydell, 2020/02/13
[PATCH v2 10/30] qapi: Remove hardcoded tabs, Peter Maydell, 2020/02/13
[PATCH v2 06/30] qga/qapi-schema.json: minor format fixups for rST, Peter Maydell, 2020/02/13
[PATCH v2 08/30] qapi: Use ':' after @argument in doc comments, Peter Maydell, 2020/02/13
[PATCH v2 11/30] qapi/ui.json: Put input-send-event body text in the right place, Peter Maydell, 2020/02/13
[PATCH v2 12/30] qapi/ui.json: Avoid `...' texinfo style quoting, Peter Maydell, 2020/02/13