summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorMarkus Armbruster <armbru@redhat.com>2023-04-28 12:54:19 +0200
committerMarkus Armbruster <armbru@redhat.com>2023-05-09 09:10:45 +0200
commit56266c6d1eb9a85a44e34b24eb359c6ac84887f5 (patch)
tree60a074a5485ba18f9219d8e028f4a305d357a1b8
parentf57e1d05bfaf2f41f0793280886ebf1db753794f (diff)
downloadfocaccia-qemu-56266c6d1eb9a85a44e34b24eb359c6ac84887f5.tar.gz
focaccia-qemu-56266c6d1eb9a85a44e34b24eb359c6ac84887f5.zip
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>
-rw-r--r--qapi/migration.json5
1 files 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',