[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v2 13/16] qapi: Replace ad hoc "since" documentation by member do
From: |
Markus Armbruster |
Subject: |
[PATCH v2 13/16] qapi: Replace ad hoc "since" documentation by member documentation |
Date: |
Tue, 25 Apr 2023 08:42:20 +0200 |
MemoryDeviceInfoKind, NetClientDriver, and GuestPanicAction mention
some members only in ad hoc since documentation. The generated
documentation shows these members as "Not documented".
Replace by formal member documentation.
Add actual documentation text for the GuestPanicAction members, to
match existing member documentation there. For the others, merely
move existing "since" information.
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>
---
qapi/machine.json | 11 ++++++++---
qapi/net.json | 21 ++++++++-------------
qapi/run-state.json | 6 +++++-
3 files changed, 21 insertions(+), 17 deletions(-)
diff --git a/qapi/machine.json b/qapi/machine.json
index 1a90376f4e..5a18913767 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -1260,6 +1260,14 @@
##
# @MemoryDeviceInfoKind:
#
+# @nvdimm: since 2.12
+#
+# @virtio-pmem: since 4.1
+#
+# @virtio-mem: since 5.1
+#
+# @sgx-epc: since 6.2.
+#
# Since: 2.1
##
{ 'enum': 'MemoryDeviceInfoKind',
@@ -1302,9 +1310,6 @@
#
# Union containing information about a memory device
#
-# nvdimm is included since 2.12. virtio-pmem is included since 4.1.
-# virtio-mem is included since 5.1. sgx-epc is included since 6.2.
-#
# Since: 2.1
##
{ 'union': 'MemoryDeviceInfo',
diff --git a/qapi/net.json b/qapi/net.json
index ec66b39b70..3606d9d27f 100644
--- a/qapi/net.json
+++ b/qapi/net.json
@@ -641,14 +641,15 @@
#
# Available netdev drivers.
#
-# Since: 2.7
+# @l2tpv3: since 2.1
+# @vhost-vdpa: since 5.1
+# @vmnet-host: since 7.1
+# @vmnet-shared: since 7.1
+# @vmnet-bridged: since 7.1
+# @stream: since 7.2
+# @dgram: since 7.2
#
-# @vhost-vdpa since 5.1
-# @vmnet-host since 7.1
-# @vmnet-shared since 7.1
-# @vmnet-bridged since 7.1
-# @stream since 7.2
-# @dgram since 7.2
+# Since: 2.7
##
{ 'enum': 'NetClientDriver',
'data': [ 'none', 'nic', 'user', 'tap', 'l2tpv3', 'socket', 'stream',
@@ -669,12 +670,6 @@
#
# Since: 1.2
#
-# 'l2tpv3' - since 2.1
-# 'vmnet-host' - since 7.1
-# 'vmnet-shared' - since 7.1
-# 'vmnet-bridged' - since 7.1
-# 'stream' since 7.2
-# 'dgram' since 7.2
##
{ 'union': 'Netdev',
'base': { 'id': 'str', 'type': 'NetClientDriver' },
diff --git a/qapi/run-state.json b/qapi/run-state.json
index bfc15ecad5..e5f5d31395 100644
--- a/qapi/run-state.json
+++ b/qapi/run-state.json
@@ -467,7 +467,11 @@
#
# @pause: system pauses
#
-# Since: 2.1 (poweroff since 2.8, run since 5.0)
+# @poweroff: system powers off (since 2.8)
+#
+# @run: system continues to run (since 5.0)
+#
+# Since: 2.1
##
{ 'enum': 'GuestPanicAction',
'data': [ 'pause', 'poweroff', 'run' ] }
--
2.39.2
- [PATCH v2 00/16] qapi qga/qapi-schema: Doc fixes, Markus Armbruster, 2023/04/25
- [PATCH v2 04/16] qapi: Fix up references to long gone error classes, Markus Armbruster, 2023/04/25
- [PATCH v2 02/16] qga/qapi-schema: Fix a misspelled reference, Markus Armbruster, 2023/04/25
- [PATCH v2 07/16] qapi: Tidy up examples, Markus Armbruster, 2023/04/25
- [PATCH v2 08/16] qapi: Delete largely misleading "Stability Considerations", Markus Armbruster, 2023/04/25
- [PATCH v2 14/16] qapi: Fix misspelled section tags in doc comments, Markus Armbruster, 2023/04/25
- [PATCH v2 10/16] qapi: Fix unintended definition lists in documentation, Markus Armbruster, 2023/04/25
- [PATCH v2 13/16] qapi: Replace ad hoc "since" documentation by member documentation,
Markus Armbruster <=
- [PATCH v2 11/16] qga/qapi-schema: Fix member documentation markup, Markus Armbruster, 2023/04/25
- [PATCH v2 09/16] qapi: Fix bullet list markup in documentation, Markus Armbruster, 2023/04/25
- [PATCH v2 03/16] qapi: Fix misspelled references, Markus Armbruster, 2023/04/25
- [PATCH v2 05/16] qapi/block-core: Clean up after removal of dirty bitmap @status, Markus Armbruster, 2023/04/25
- [PATCH v2 01/16] qga/qapi-schema: Tidy up documentation of guest-fsfreeze-status, Markus Armbruster, 2023/04/25
- [PATCH v2 15/16] qapi: Format since information the conventional way: (since X.Y), Markus Armbruster, 2023/04/25
- [PATCH v2 16/16] qapi storage-daemon/qapi: Fix documentation section structure, Markus Armbruster, 2023/04/25