[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 03/17] qapi: Fix misspelled references
From: |
Markus Armbruster |
Subject: |
[PULL 03/17] qapi: Fix misspelled references |
Date: |
Fri, 28 Apr 2023 12:28:47 +0200 |
query-cpu-definitions returns a list of CpuDefinitionInfo, but
documentation claims CpuDefInfo, which doesn't exist.
query-migrate-capabilities returns a list of
MigrationCapabilityStatus, but documentation claims
MigrationCapabilitiesStatus, which doesn't exist.
balloon and query-balloon can fail with KVMMissingCap, but
documentation claims KvmMissingCap, which doesn't exist.
Fix the documentation.
Fixes: e4e31c6324af (qapi: add query-cpu-definitions command (v2))
Fixes: bbf6da32b5bd (Add migration capabilities)
Fixes: d72f326431e2 (qapi: Convert balloon)
Fixes: 96637bcdf9e0 (qapi: Convert query-balloon)
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Reviewed-by: David Hildenbrand <david@redhat.com>
Message-Id: <20230425064223.820979-4-armbru@redhat.com>
Reviewed-by: Juan Quintela <quintela@redhat.com>
---
qapi/machine-target.json | 2 +-
qapi/machine.json | 4 ++--
qapi/migration.json | 2 +-
3 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/qapi/machine-target.json b/qapi/machine-target.json
index 2e267fa458..b94fbdb65e 100644
--- a/qapi/machine-target.json
+++ b/qapi/machine-target.json
@@ -331,7 +331,7 @@
#
# Return a list of supported virtual CPU definitions
#
-# Returns: a list of CpuDefInfo
+# Returns: a list of CpuDefinitionInfo
#
# Since: 1.2
##
diff --git a/qapi/machine.json b/qapi/machine.json
index 604b686e59..8c3c58c763 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -1029,7 +1029,7 @@
#
# Returns: - Nothing on success
# - If the balloon driver is enabled but not functional because the
KVM
-# kernel module cannot support it, KvmMissingCap
+# kernel module cannot support it, KVMMissingCap
# - If no balloon device is present, DeviceNotActive
#
# Notes: This command just issues a request to the guest. When it returns,
@@ -1067,7 +1067,7 @@
#
# Returns: - @BalloonInfo on success
# - If the balloon driver is enabled but not functional because the
KVM
-# kernel module cannot support it, KvmMissingCap
+# kernel module cannot support it, KVMMissingCap
# - If no balloon device is present, DeviceNotActive
#
# Since: 0.14
diff --git a/qapi/migration.json b/qapi/migration.json
index 2c35b7b9cf..91c1773739 100644
--- a/qapi/migration.json
+++ b/qapi/migration.json
@@ -531,7 +531,7 @@
#
# Returns information about the current migration capabilities status
#
-# Returns: @MigrationCapabilitiesStatus
+# Returns: @MigrationCapabilityStatus
#
# Since: 1.2
#
--
2.39.2
- [PULL 00/17] QAPI patches patches for 2023-04-28, Markus Armbruster, 2023/04/28
- [PULL 04/17] qapi: Fix up references to long gone error classes, Markus Armbruster, 2023/04/28
- [PULL 12/17] qapi: Fix argument documentation markup, Markus Armbruster, 2023/04/28
- [PULL 06/17] qapi: @foo should be used to reference, not ``foo``, Markus Armbruster, 2023/04/28
- [PULL 09/17] qapi: Fix bullet list markup in documentation, Markus Armbruster, 2023/04/28
- [PULL 03/17] qapi: Fix misspelled references,
Markus Armbruster <=
- [PULL 01/17] qga/qapi-schema: Tidy up documentation of guest-fsfreeze-status, Markus Armbruster, 2023/04/28
- [PULL 15/17] qapi: Format since information the conventional way: (since X.Y), Markus Armbruster, 2023/04/28
- [PULL 05/17] qapi/block-core: Clean up after removal of dirty bitmap @status, Markus Armbruster, 2023/04/28
- [PULL 13/17] qapi: Replace ad hoc "since" documentation by member documentation, Markus Armbruster, 2023/04/28
- [PULL 16/17] qapi storage-daemon/qapi: Fix documentation section structure, Markus Armbruster, 2023/04/28
- [PULL 08/17] qapi: Delete largely misleading "Stability Considerations", Markus Armbruster, 2023/04/28
- [PULL 14/17] qapi: Fix misspelled section tags in doc comments, Markus Armbruster, 2023/04/28
- [PULL 07/17] qapi: Tidy up examples, Markus Armbruster, 2023/04/28
- [PULL 02/17] qga/qapi-schema: Fix a misspelled reference, Markus Armbruster, 2023/04/28
- [PULL 11/17] qga/qapi-schema: Fix member documentation markup, Markus Armbruster, 2023/04/28