Skip to content

Commit 30ab96c

Browse files
jnsnowMarkus Armbruster
authored andcommitted
docs: disambiguate cross-references
The next patch will engage the qapidoc transmogrifier, which creates a lot of cross-reference targets. Some of the existing targets ("migration", "qom", "replay") will become ambiguous as a result. Nail them down more explicitly to prevent ambiguous cross-reference warnings. 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 4d7d30b commit 30ab96c

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

docs/devel/codebase.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Some of the main QEMU subsystems are:
2323
- `Devices<device-emulation>` & Board models
2424
- `Documentation <documentation-root>`
2525
- `GDB support<GDB usage>`
26-
- `Migration<migration>`
26+
- :ref:`Migration<migration>`
2727
- `Monitor<QEMU monitor>`
2828
- :ref:`QOM (QEMU Object Model)<qom>`
2929
- `System mode<System emulation>`
@@ -112,7 +112,7 @@ yet, so sometimes the source code is all you have.
112112
* `libdecnumber <https://gitlab.com/qemu-project/qemu/-/tree/master/libdecnumber>`_:
113113
Import of gcc library, used to implement decimal number arithmetic.
114114
* `migration <https://gitlab.com/qemu-project/qemu/-/tree/master/migration>`__:
115-
`Migration framework <migration>`.
115+
:ref:`Migration framework <migration>`.
116116
* `monitor <https://gitlab.com/qemu-project/qemu/-/tree/master/monitor>`_:
117117
`Monitor <QEMU monitor>` implementation (HMP & QMP).
118118
* `nbd <https://gitlab.com/qemu-project/qemu/-/tree/master/nbd>`_:
@@ -193,7 +193,7 @@ yet, so sometimes the source code is all you have.
193193
- `lcitool <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/lcitool>`_:
194194
Generate dockerfiles for CI containers.
195195
- `migration <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/migration>`_:
196-
Test scripts and data for `Migration framework <migration>`.
196+
Test scripts and data for :ref:`Migration framework <migration>`.
197197
- `multiboot <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/multiboot>`_:
198198
Test multiboot functionality for x86_64/i386.
199199
- `qapi-schema <https://gitlab.com/qemu-project/qemu/-/tree/master/tests/qapi-schema>`_:

docs/glossary.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ Migration
120120
---------
121121

122122
QEMU can save and restore the execution of a virtual machine between different
123-
host systems. This is provided by the `Migration framework<migration>`.
123+
host systems. This is provided by the :ref:`Migration framework<migration>`.
124124

125125
NBD
126126
---
@@ -212,14 +212,14 @@ machine emulator and virtualizer.
212212
QOM
213213
---
214214

215-
`QEMU Object Model <qom>` is an object oriented API used to define various
216-
devices and hardware in the QEMU codebase.
215+
:ref:`QEMU Object Model <qom>` is an object oriented API used to define
216+
various devices and hardware in the QEMU codebase.
217217

218218
Record/replay
219219
-------------
220220

221-
`Record/replay <replay>` is a feature of QEMU allowing to have a deterministic
222-
and reproducible execution of a virtual machine.
221+
:ref:`Record/replay <replay>` is a feature of QEMU allowing to have a
222+
deterministic and reproducible execution of a virtual machine.
223223

224224
Rust
225225
----

0 commit comments

Comments
 (0)