diff options
| author | John Snow <jsnow@redhat.com> | 2025-03-13 00:43:11 -0400 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2025-03-14 07:32:41 +0100 |
| commit | d85f7efe1f16c51b9c016ebc79f7c4081486642e (patch) | |
| tree | 5a168d5323baa31142b10ed7ebaa695e88ce5907 | |
| parent | 602c90beaedd9abbbf1535c8630293267e6b29c0 (diff) | |
| download | focaccia-qemu-d85f7efe1f16c51b9c016ebc79f7c4081486642e.tar.gz focaccia-qemu-d85f7efe1f16c51b9c016ebc79f7c4081486642e.zip | |
docs: disambiguate references in qapi-domain.rst
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>
| -rw-r--r-- | docs/devel/qapi-domain.rst | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/devel/qapi-domain.rst b/docs/devel/qapi-domain.rst index 4705ba255e..a748529f51 100644 --- a/docs/devel/qapi-domain.rst +++ b/docs/devel/qapi-domain.rst @@ -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 will apply only to the type name between the brackets. For example; ``: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 can be suffixed with ``?``. The cross-reference will be transformed to "type, Optional" with the link applying only to the type name. For example; ``:qapi:type:`BitmapSyncMode?``` renders to: -:qapi:type:`BitmapSyncMode?` +:qapi:type:`QMP:BitmapSyncMode?` Namespaces @@ -405,11 +405,11 @@ type. * A namespace can be explicitly provided; e.g. ``:qapi:type:`QMP:BitmapSyncMode`` * A module can be explicitly provided; - ``:qapi:type:`block-core.BitmapSyncMode``` will render to: - :qapi:type:`block-core.BitmapSyncMode` + ``:qapi:type:`QMP:block-core.BitmapSyncMode``` will render to: + :qapi:type:`QMP:block-core.BitmapSyncMode` * If you don't want to display the "fully qualified" name, it can be - prefixed with a tilde; ``:qapi:type:`~block-core.BitmapSyncMode``` - will render to: :qapi:type:`~block-core.BitmapSyncMode` + prefixed with a tilde; ``:qapi:type:`~QMP:block-core.BitmapSyncMode``` + will render to: :qapi:type:`~QMP:block-core.BitmapSyncMode` Target resolution @@ -444,7 +444,7 @@ using the ``custom text <target>`` syntax. For example, ``:qapi:cmd:`Merge dirty bitmaps <block-dirty-bitmap-merge>``` will render as: :qapi:cmd:`Merge dirty -bitmaps <block-dirty-bitmap-merge>` +bitmaps <QMP:block-dirty-bitmap-merge>` Directives |