diff options
author | Markus Armbruster <armbru@redhat.com> | 2024-06-28 13:27:56 +0200 |
---|---|---|
committer | Michael Tokarev <mjt@tls.msk.ru> | 2024-07-08 22:55:53 +0300 |
commit | 55b151b6a67c0fc4c4cbdabc5bc4509ad0b81f30 (patch) | |
tree | 492126f1e0f2fcb6250958554ad9271bbcd037e3 /hw/display/pl110_template.h | |
parent | 8f7bb1266f33c72b5085efda4d69a82b4941af71 (diff) |
sphinx/qapidoc: Fix to generate doc for explicit, unboxed arguments
When a command's arguments are specified as an explicit type T,
generated documentation points to the members of T.
Example:
##
# @announce-self:
#
# Trigger generation of broadcast RARP frames to update network
[...]
##
{ 'command': 'announce-self', 'boxed': true,
'data' : 'AnnounceParameters'}
generates
"announce-self" (Command)
-------------------------
Trigger generation of broadcast RARP frames to update network
[...]
Arguments
~~~~~~~~~
The members of "AnnounceParameters"
Except when the command takes its arguments unboxed , i.e. it doesn't
have 'boxed': true, we generate *nothing*. A few commands have a
reference in their doc comment to compensate, but most don't.
Example:
##
# @blockdev-snapshot-sync:
#
# Takes a synchronous snapshot of a block device.
#
# For the arguments, see the documentation of BlockdevSnapshotSync.
[...]
##
{ 'command': 'blockdev-snapshot-sync',
'data': 'BlockdevSnapshotSync',
'allow-preconfig': true }
generates
"blockdev-snapshot-sync" (Command)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Takes a synchronous snapshot of a block device.
For the arguments, see the documentation of BlockdevSnapshotSync.
[...]
Same for event data.
Fix qapidoc.py to generate the reference regardless of boxing. Delete
now redundant references in the doc comments.
Fixes: 4078ee5469e5 (docs/sphinx: Add new qapi-doc Sphinx extension)
Cc: qemu-stable@nongnu.org
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240628112756.794237-1-armbru@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
(cherry picked from commit e389929d19a543ea5b34d02553b355f9f1c03162)
Signed-off-by: Michael Tokarev <mjt@tls.msk.ru>
(Mjt: context fixups in qapi/block-core.json due to missing
v8.2.0-1951-g2746f060be18 "qapi: Move error documentation to new "Errors" sections"
v8.2.0-1952-g53d5c36d8de3 "qapi: Delete useless "Returns" sections")
Diffstat (limited to 'hw/display/pl110_template.h')
0 files changed, 0 insertions, 0 deletions