[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-devel] [PATCH v7 03/21] qapi: make TODOs named-sections
From: |
Markus Armbruster |
Subject: |
Re: [Qemu-devel] [PATCH v7 03/21] qapi: make TODOs named-sections |
Date: |
Tue, 10 Jan 2017 10:11:53 +0100 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/25.1 (gnu/linux) |
Marc-André Lureau <address@hidden> writes:
> Have the TODO in the TAG: format, so they will stand out in the
> generated documentation.
I expect TODO without colon to creep back. Right now, we have three
with and three without colon. Whack-a-mole is a stupid game, but since
these moles are fairly harmless, I don't care.
The commit message is sub-optimal, though. At this point, there is no
generated documentation, and we have no concept of "named-sections".
Let's instead say
qapi: Format TODO comments more consistently
Consistently put a colon after TODO. This will make the TODOs stand
out in the documentation we're going to generate.
With that
Reviewed-by: Markus Armbruster <address@hidden>
Alternatively, delay the patch until after we generate documentation.
- [Qemu-devel] [PATCH v7 00/21] qapi doc generation (whole version, squashed), Marc-André Lureau, 2017/01/09
- [Qemu-devel] [PATCH v7 03/21] qapi: make TODOs named-sections, Marc-André Lureau, 2017/01/09
- Re: [Qemu-devel] [PATCH v7 03/21] qapi: make TODOs named-sections,
Markus Armbruster <=
- [Qemu-devel] [PATCH v7 04/21] qapi: improve device_add schema, Marc-André Lureau, 2017/01/09
- [Qemu-devel] [PATCH v7 01/21] qapi: replace 'o' for list items, Marc-André Lureau, 2017/01/09
- [Qemu-devel] [PATCH v7 02/21] qapi: move QKeyCode doc body at the top, Marc-André Lureau, 2017/01/09
- [Qemu-devel] [PATCH v7 06/21] qga/schema: improve guest-set-vcpus Returns: section, Marc-André Lureau, 2017/01/09
- [Qemu-devel] [PATCH v7 05/21] qapi: improve TransactionAction doc, Marc-André Lureau, 2017/01/09
- [Qemu-devel] [PATCH v7 07/21] qapi: avoid interleaving sections and parameters, Marc-André Lureau, 2017/01/09
- [Qemu-devel] [PATCH v7 08/21] qapi: move experimental note down, Marc-André Lureau, 2017/01/09