[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH 07/17] qapi: Tidy up a slightly awkward TODO comment
From: |
Juan Quintela |
Subject: |
Re: [PATCH 07/17] qapi: Tidy up a slightly awkward TODO comment |
Date: |
Fri, 28 Apr 2023 20:02:59 +0200 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/28.2 (gnu/linux) |
Markus Armbruster <armbru@redhat.com> wrote:
> MigrateSetParameters has a TODO comment sitting right behind its doc
> comment. I wrote it this way to keep it out of the manual, but that
> reason is not obvious.
>
> The previous commit (sphinx/qapidoc: Do not emit TODO sections into
> user manuals) lets me move it into the doc comment as a TODO section.
>
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Juan Quintela <quintela@redhat.com>
> ---
> qapi/migration.json | 5 +++--
> 1 file changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/qapi/migration.json b/qapi/migration.json
> index 82000adce4..11c09800c2 100644
> --- a/qapi/migration.json
> +++ b/qapi/migration.json
> @@ -945,10 +945,11 @@
> # Features:
> # @unstable: Member @x-checkpoint-delay is experimental.
> #
> +# TODO: either fuse back into MigrationParameters, or make
> +# MigrationParameters members mandatory
> +#
> # Since: 2.4
2.4 was released in 2015-08-11
There is no hope for something that has been experimental since then.
- [PATCH 02/17] docs/devel/qapi-code-gen: Turn FIXME admonitions into comments, (continued)
- [PATCH 02/17] docs/devel/qapi-code-gen: Turn FIXME admonitions into comments, Markus Armbruster, 2023/04/28
- [PATCH 13/17] qapi: Relax doc string @name: description indentation rules, Markus Armbruster, 2023/04/28
- [PATCH 11/17] qapi: Fix argument description indentation stripping, Markus Armbruster, 2023/04/28
- [PATCH 04/17] meson: Fix to make QAPI generator output depend on main.py, Markus Armbruster, 2023/04/28
- [PATCH 07/17] qapi: Tidy up a slightly awkward TODO comment, Markus Armbruster, 2023/04/28
- [PATCH 14/17] qapi: Section parameter @indent is no longer used, drop, Markus Armbruster, 2023/04/28
- [PATCH 03/17] qapi: Fix crash on stray double quote character, Markus Armbruster, 2023/04/28
- [PATCH 10/17] tests/qapi-schema/doc-good: Improve argument description tests, Markus Armbruster, 2023/04/28
- [PATCH 09/17] tests/qapi-schema/doc-good: Improve a comment, Markus Armbruster, 2023/04/28
- [PATCH 15/17] docs/devel/qapi-code-gen: Update doc comment conventions, Markus Armbruster, 2023/04/28