From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: michael.roth@amd.com, eblake@redhat.com, kwolf@redhat.com,
hreitz@redhat.com, pbonzini@redhat.com,
marcandre.lureau@redhat.com, arei.gonglei@huawei.com,
pizhenwei@bytedance.com, jsnow@redhat.com,
vsementsov@yandex-team.ru, eduardo@habkost.net,
marcel.apfelbaum@gmail.com, wangyanan55@huawei.com,
quintela@redhat.com, jasowang@redhat.com,
yuval.shaia.ml@gmail.com, stefanha@redhat.com, kraxel@redhat.com,
kkostiuk@redhat.com, qemu-block@nongnu.org
Subject: [PATCH 13/16] qapi: Replace ad hoc "since" documentation by member documentation
Date: Tue, 4 Apr 2023 13:59:09 +0200 [thread overview]
Message-ID: <20230404115912.2829251-14-armbru@redhat.com> (raw)
In-Reply-To: <20230404115912.2829251-1-armbru@redhat.com>
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>
---
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 20541cb319..172ef0ad96 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 1f1e148f01..3f9db0a718 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 419c188dd1..52495884c5 100644
--- a/qapi/run-state.json
+++ b/qapi/run-state.json
@@ -468,7 +468,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
next prev parent reply other threads:[~2023-04-04 12:03 UTC|newest]
Thread overview: 29+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-04-04 11:58 [PATCH 00/16] qapi qga/qapi-schema: Doc fixes Markus Armbruster
2023-04-04 11:58 ` [PATCH 01/16] qga/qapi-schema: Tidy up documentation of guest-fsfreeze-status Markus Armbruster
2023-04-04 17:03 ` Konstantin Kostiuk
2023-04-04 11:58 ` [PATCH 02/16] qga/qapi-schema: Fix a misspelled reference Markus Armbruster
2023-04-04 11:58 ` [PATCH 03/16] qapi: Fix misspelled references Markus Armbruster
2023-04-05 8:21 ` David Hildenbrand
2023-04-04 11:59 ` [PATCH 04/16] qapi: Fix up references to long gone error classes Markus Armbruster
2023-04-04 11:59 ` [PATCH 05/16] qapi/block-core: Clean up after removal of dirty bitmap @status Markus Armbruster
2023-04-11 20:56 ` John Snow
2023-04-04 11:59 ` [PATCH 06/16] qapi: @foo should be used to reference, not ``foo`` Markus Armbruster
2023-04-04 11:59 ` [PATCH 07/16] qapi: Tidy up examples Markus Armbruster
2023-04-04 11:59 ` [PATCH 08/16] qapi: Delete largely misleading "Stability Considerations" Markus Armbruster
2023-04-04 11:59 ` [PATCH 09/16] qapi: Fix bullet list markup in documentation Markus Armbruster
2023-04-04 11:59 ` [PATCH 10/16] qapi: Fix unintended definition lists " Markus Armbruster
2023-04-04 12:46 ` Peter Maydell
2023-04-04 11:59 ` [PATCH 11/16] qga/qapi-schema: Fix member documentation markup Markus Armbruster
2023-04-04 11:59 ` [PATCH 12/16] qapi: Fix argument " Markus Armbruster
2023-04-04 11:59 ` Markus Armbruster [this message]
2023-04-04 11:59 ` [PATCH 14/16] qapi: Fix misspelled section tags in doc comments Markus Armbruster
2023-04-04 11:59 ` [PATCH 15/16] qapi: Format since information the conventional way: (since X.Y) Markus Armbruster
2023-04-04 12:55 ` Vladimir Sementsov-Ogievskiy
2023-04-04 13:35 ` Markus Armbruster
2023-04-04 11:59 ` [PATCH 16/16] qapi storage-daemon/qapi: Fix documentation section structure Markus Armbruster
2023-04-04 13:12 ` Eric Blake
2023-04-25 4:59 ` Markus Armbruster
2023-04-04 13:19 ` zhenwei pi
2023-04-04 12:58 ` [PATCH 00/16] qapi qga/qapi-schema: Doc fixes Vladimir Sementsov-Ogievskiy
2023-04-28 9:41 ` Markus Armbruster
2023-04-04 13:06 ` Marc-André Lureau
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230404115912.2829251-14-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=arei.gonglei@huawei.com \
--cc=eblake@redhat.com \
--cc=eduardo@habkost.net \
--cc=hreitz@redhat.com \
--cc=jasowang@redhat.com \
--cc=jsnow@redhat.com \
--cc=kkostiuk@redhat.com \
--cc=kraxel@redhat.com \
--cc=kwolf@redhat.com \
--cc=marcandre.lureau@redhat.com \
--cc=marcel.apfelbaum@gmail.com \
--cc=michael.roth@amd.com \
--cc=pbonzini@redhat.com \
--cc=pizhenwei@bytedance.com \
--cc=qemu-block@nongnu.org \
--cc=qemu-devel@nongnu.org \
--cc=quintela@redhat.com \
--cc=stefanha@redhat.com \
--cc=vsementsov@yandex-team.ru \
--cc=wangyanan55@huawei.com \
--cc=yuval.shaia.ml@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).