qapi: Tidy up a slightly awkward TODO comment
authorMarkus Armbruster <armbru@redhat.com>
Fri, 28 Apr 2023 10:54:19 +0000 (12:54 +0200)
committerMarkus Armbruster <armbru@redhat.com>
Tue, 9 May 2023 07:10:45 +0000 (09:10 +0200)
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>
qapi/migration.json

index 82000adce46f33b04ed5b1e426335dedb614f196..11c09800c2088e9166dd34d16e4f42f553ab58b5 100644 (file)
 # 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',