motorhead/qemu
1
0
Fork 0
mirror of https://github.com/Motorhead1991/qemu.git synced 2025-08-06 01:03:55 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: disambiguate references in qapi-domain.rst

Browse source 
Before we enable the QGA and QSD namespaces, we need to disambiguate
some of the references that would become ambiguous as a result!

Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250313044312.189276-11-jsnow@redhat.com>
Acked-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:
John Snow 2025-03-13 00:43:11 -04:00 • committed by Markus Armbruster
parent 602c90beae
commit d85f7efe1f
1 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/devel/qapi-domain.rst
View file

@ -385,13 +385,13 @@ Type names in references can be surrounded by brackets, like
``[typename]``, to indicate an array of that type. The cross-reference ``[typename]``, to indicate an array of that type. The cross-reference
will apply only to the type name between the brackets. For example; will apply only to the type name between the brackets. For example;
``:qapi:type:`[Qcow2BitmapInfoFlags]``` renders to: ``:qapi:type:`[Qcow2BitmapInfoFlags]``` renders to:
:qapi:type:`[Qcow2BitmapInfoFlags]` :qapi:type:`[QMP:Qcow2BitmapInfoFlags]`
To indicate an optional argument/member in a field list, the type name To indicate an optional argument/member in a field list, the type name
can be suffixed with ``?``. The cross-reference will be transformed to can be suffixed with ``?``. The cross-reference will be transformed to
"type, Optional" with the link applying only to the type name. For "type, Optional" with the link applying only to the type name. For
example; ``:qapi:type:`BitmapSyncMode?``` renders to: example; ``:qapi:type:`BitmapSyncMode?``` renders to:
:qapi:type:`BitmapSyncMode?` :qapi:type:`QMP:BitmapSyncMode?`
Namespaces Namespaces
@ -405,11 +405,11 @@ type.
* A namespace can be explicitly provided; * A namespace can be explicitly provided;
e.g. ``:qapi:type:`QMP:BitmapSyncMode`` e.g. ``:qapi:type:`QMP:BitmapSyncMode``
* A module can be explicitly provided; * A module can be explicitly provided;
``:qapi:type:`block-core.BitmapSyncMode``` will render to: ``:qapi:type:`QMP:block-core.BitmapSyncMode``` will render to:
:qapi:type:`block-core.BitmapSyncMode` :qapi:type:`QMP:block-core.BitmapSyncMode`
* If you don't want to display the "fully qualified" name, it can be * If you don't want to display the "fully qualified" name, it can be
prefixed with a tilde; ``:qapi:type:`~block-core.BitmapSyncMode``` prefixed with a tilde; ``:qapi:type:`~QMP:block-core.BitmapSyncMode```
will render to: :qapi:type:`~block-core.BitmapSyncMode` will render to: :qapi:type:`~QMP:block-core.BitmapSyncMode`
Target resolution Target resolution
@ -444,7 +444,7 @@ using the ``custom text <target>`` syntax.
For example, ``:qapi:cmd:`Merge dirty bitmaps For example, ``:qapi:cmd:`Merge dirty bitmaps
<block-dirty-bitmap-merge>``` will render as: :qapi:cmd:`Merge dirty <block-dirty-bitmap-merge>``` will render as: :qapi:cmd:`Merge dirty
bitmaps <block-dirty-bitmap-merge>` bitmaps <QMP:block-dirty-bitmap-merge>`
Directives Directives