diff mbox series

[PULL,07/17] qapi: Tidy up a slightly awkward TODO comment

Message ID 20230509080011.3231661-8-armbru@redhat.com
State New
Headers show
Series [PULL,01/17] docs/devel/qapi-code-gen: Clean up use of quotes a bit | expand

Commit Message

Markus Armbruster May 9, 2023, 8 a.m. UTC 
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 | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
diff mbox series

Patch

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',