Markus Armbruster <[email protected]> writes: > Fabiano Rosas <[email protected]> writes: > >> 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. >> >> Signed-off-by: Fabiano Rosas <[email protected]> >> --- >> qapi/migration.json | 152 +------------------------------------------- >> qapi/pragma.json | 3 +- >> 2 files changed, 3 insertions(+), 152 deletions(-) >> >> diff --git a/qapi/migration.json b/qapi/migration.json >> index 080968993a..452e6dedaa 100644 >> --- a/qapi/migration.json >> +++ b/qapi/migration.json >> @@ -734,157 +734,7 @@ >> ## >> # @MigrationParameter: >> # >> -# Migration parameters enumeration >> -# >> -# @announce-initial: Initial delay (in milliseconds) before sending >> -# the first announce (Since 4.0) > > [...] > >> -# @direct-io: Open migration files with O_DIRECT when possible. This >> -# only has effect if the @mapped-ram capability is enabled. >> -# (Since 9.1) >> +# Migration parameters enumeration. See @MigrationParameters for more info. > > Suggest something like > > # The enumeration values mirror the members of MigrationParameters, > # which see. > > I could compare the deleted docs with MigrationParameters docs, but I > doubt it's worthwhile: the type is only ever used internally. That it > appears in the QEMU QMP Reference Manual anyway is a defect. There are > quite a few more like it (list appended). > > If I remember correctly, John Snow's doc generator work will fix this > defect.
Until then, this patch has a drawback: the manual now shows all the members as "Not documented" . Ugly and a bit embarrassing. Maybe even confusing. [...]
