Skip to content

Commit d85f7ef

Browse files
jnsnowMarkus Armbruster
authored andcommitted
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 <[email protected]> Message-ID: <[email protected]> Acked-by: Markus Armbruster <[email protected]> Signed-off-by: Markus Armbruster <[email protected]>
1 parent 602c90b commit d85f7ef

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/devel/qapi-domain.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -385,13 +385,13 @@ Type names in references can be surrounded by brackets, like
385385
``[typename]``, to indicate an array of that type. The cross-reference
386386
will apply only to the type name between the brackets. For example;
387387
``:qapi:type:`[Qcow2BitmapInfoFlags]``` renders to:
388-
:qapi:type:`[Qcow2BitmapInfoFlags]`
388+
:qapi:type:`[QMP:Qcow2BitmapInfoFlags]`
389389

390390
To indicate an optional argument/member in a field list, the type name
391391
can be suffixed with ``?``. The cross-reference will be transformed to
392392
"type, Optional" with the link applying only to the type name. For
393393
example; ``:qapi:type:`BitmapSyncMode?``` renders to:
394-
:qapi:type:`BitmapSyncMode?`
394+
:qapi:type:`QMP:BitmapSyncMode?`
395395

396396

397397
Namespaces
@@ -405,11 +405,11 @@ type.
405405
* A namespace can be explicitly provided;
406406
e.g. ``:qapi:type:`QMP:BitmapSyncMode``
407407
* A module can be explicitly provided;
408-
``:qapi:type:`block-core.BitmapSyncMode``` will render to:
409-
:qapi:type:`block-core.BitmapSyncMode`
408+
``:qapi:type:`QMP:block-core.BitmapSyncMode``` will render to:
409+
:qapi:type:`QMP:block-core.BitmapSyncMode`
410410
* If you don't want to display the "fully qualified" name, it can be
411-
prefixed with a tilde; ``:qapi:type:`~block-core.BitmapSyncMode```
412-
will render to: :qapi:type:`~block-core.BitmapSyncMode`
411+
prefixed with a tilde; ``:qapi:type:`~QMP:block-core.BitmapSyncMode```
412+
will render to: :qapi:type:`~QMP:block-core.BitmapSyncMode`
413413

414414

415415
Target resolution
@@ -444,7 +444,7 @@ using the ``custom text <target>`` syntax.
444444

445445
For example, ``:qapi:cmd:`Merge dirty bitmaps
446446
<block-dirty-bitmap-merge>``` will render as: :qapi:cmd:`Merge dirty
447-
bitmaps <block-dirty-bitmap-merge>`
447+
bitmaps <QMP:block-dirty-bitmap-merge>`
448448

449449

450450
Directives

0 commit comments

Comments
 (0)