Re: [PATCH 07/17] qapi: Tidy up a slightly awkward TODO comment

[Ani Sinha <anisinha@redhat.com>]

[-- Attachment #1: Type: text/plain, Size: 1269 bytes --]

On Fri, Apr 28, 2023 at 4:24 PM 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: Ani Sinha <anisinha@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
>  ##
> -# TODO either fuse back into MigrationParameters, or make
> -# MigrationParameters members mandatory
>  { 'struct': 'MigrateSetParameters',
>    'data': { '*announce-initial': 'size',
>              '*announce-max': 'size',
> --
> 2.39.2
>
>

[-- Attachment #2: Type: text/html, Size: 1987 bytes --]