diff options
| author | Markus Armbruster <armbru@redhat.com> | 2023-04-25 08:42:20 +0200 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2023-04-28 11:48:34 +0200 |
| commit | 86bf13aea39e32adb8f068a4d14e2ad16edb725c (patch) | |
| tree | 0136855ed801a6a23631a9bfa22dc978aa677461 /qapi | |
| parent | 91577c47257a4459e7fa679f719c20b5093d4e4e (diff) | |
| download | qemu-86bf13aea39e32adb8f068a4d14e2ad16edb725c.zip qemu-86bf13aea39e32adb8f068a4d14e2ad16edb725c.tar.gz qemu-86bf13aea39e32adb8f068a4d14e2ad16edb725c.tar.bz2 | |
qapi: Replace ad hoc "since" documentation by member documentation
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>
Message-Id: <20230425064223.820979-14-armbru@redhat.com>
Diffstat (limited to 'qapi')
| -rw-r--r-- | qapi/machine.json | 11 | ||||
| -rw-r--r-- | qapi/net.json | 21 | ||||
| -rw-r--r-- | qapi/run-state.json | 6 |
3 files changed, 21 insertions, 17 deletions
diff --git a/qapi/machine.json b/qapi/machine.json index 1a90376..5a18913 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 ec66b39..3606d9d 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 bfc15ec..e5f5d31 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' ] } |