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. > # > # Features: > # > diff --git a/qapi/pragma.json b/qapi/pragma.json > index 023a2ef7bc..58133907b6 100644 > --- a/qapi/pragma.json > +++ b/qapi/pragma.json > @@ -76,7 +76,8 @@ > 'X86CPURegister32', > 'XDbgBlockGraph', > 'YankInstanceType', > - 'blockdev-reopen' ], > + 'blockdev-reopen', > + 'MigrationParameter'], Please keep this list sorted alphabetically. > # Externally visible types whose member names may use uppercase > 'member-name-exceptions': [ # visible in: > 'ACPISlotType', # query-acpi-ospm-status Types documented in the QEMU QMP Reference Manual that don't occur in QMP introspection: AcpiTableOptions BiosAtaTranslation BlockChildInfo BlockGraphInfo BlockMeasureInfo BootConfiguration COLOMessage CXLFMWProperties CXLFixedMemoryWindowOptions CacheLevelAndType CompatPolicy CompatPolicyInput CompatPolicyOutput CompressionStats CpuTopologyLevel DummyBlockCoreForceArrays DummyForceArrays DummyVirtioForceArrays EndianMode FailoverStatus FloppyDriveType GranuleMode IOThreadVirtQueueMapping ImageCheck JobVerb LostTickPolicy MapEntry MemorySizeConfiguration MigrationParameter MonitorMode MonitorOptions NbdServerOptions NotifyVmexitOption OffAutoPCIBAR OnOffSplit PCIELinkSpeed PCIELinkWidth QCryptoAkCipherAlgo QCryptoAkCipherKeyType QCryptoAkCipherOptions QCryptoAkCipherOptionsRSA QCryptoBlockInfo QCryptoBlockOpenOptions QCryptoRSAPaddingAlgo QCryptodevBackendAlgoType QapiErrorClass SMPConfiguration SgxEPC SgxEPCProperties SmbiosEntryPointType SmpCacheProperties SmpCachePropertiesWrapper UefiVarStore UefiVariable VMAppleVirtioBlkVariant X86CPUFeatureWordInfo X86CPURegister32
