Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
qapi: Tidy up a slightly awkward TODO comment
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>
Message-Id: <20230428105429.1687850-8-armbru@redhat.com>
Reviewed-by: Ani Sinha <anisinha@redhat.com>
Reviewed-by: Juan Quintela <quintela@redhat.com>
  • Loading branch information
Markus Armbruster committed May 9, 2023
1 parent f57e1d0 commit 56266c6
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions qapi/migration.json
Expand Up @@ -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',
Expand Down

0 comments on commit 56266c6

Please sign in to comment.