]> git.ipfire.org Git - thirdparty/qemu.git/commit
qapi/migration: Don't document MigrationParameter
authorFabiano Rosas <farosas@suse.de>
Mon, 15 Dec 2025 21:59:53 +0000 (18:59 -0300)
committerPeter Xu <peterx@redhat.com>
Tue, 23 Dec 2025 14:24:34 +0000 (09:24 -0500)
commit2220c2b9ef7f0032d45c3ac7e4f50271c0e4ce36
tree9a55cbe218f7913f67ebed376c6ec262a8bdce5c
parent691a83657297719d01b0c7ef0df3d51d3f5f3370
qapi/migration: Don't document MigrationParameter

The MigrationParameter (singular) enumeration is not part of the
migration QMP API, it's only used for nicely converting HMP strings
into MigrationParameters (plural) members and for providing readline
completion.

Documenting this enum only serves to duplicate documentation between
MigrationParameter and MigrationParameters.

Add an exception to QAPIs pragma.json and stop documenting it.

The generated "QEMU QMP Reference Manual" now lists the enum members
as "Not documented."  Tolerable.

Acked-by: Markus Armbruster <armbru@redhat.com>
Acked-by: Peter Xu <peterx@redhat.com>
Signed-off-by: Fabiano Rosas <farosas@suse.de>
Link: https://lore.kernel.org/r/20251215220041.12657-8-farosas@suse.de
Signed-off-by: Peter Xu <peterx@redhat.com>
qapi/migration.json
qapi/pragma.json