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>
This commit is contained in:
parent
91577c4725
commit
86bf13aea3
@ -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',
|
||||
|
@ -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' },
|
||||
|
@ -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' ] }
|
||||
|
Loading…
x
Reference in New Issue
Block a user