]> git.ipfire.org Git - thirdparty/qemu.git/commitdiff
docs: add hotlinks to about preface text
authorAlex Bennée <alex.bennee@linaro.org>
Tue, 24 Jan 2023 18:01:11 +0000 (18:01 +0000)
committerAlex Bennée <alex.bennee@linaro.org>
Thu, 2 Feb 2023 10:44:23 +0000 (10:44 +0000)
Make it easier to navigate the documentation.

Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Acked-by: Richard Henderson <richard.henderson@linaro.org>
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Message-Id: <20230124180127.1881110-20-alex.bennee@linaro.org>

docs/about/index.rst
docs/system/index.rst
docs/tools/index.rst
docs/user/index.rst

index 5bea653c07cf1465dea7ee0e5eab59987c7c1ac6..bae1309cc6840a7032be7b5ff9fde66e7e971dd0 100644 (file)
@@ -5,19 +5,19 @@ About QEMU
 QEMU is a generic and open source machine emulator and virtualizer.
 
 QEMU can be used in several different ways. The most common is for
-"system emulation", where it provides a virtual model of an
+:ref:`System Emulation`, where it provides a virtual model of an
 entire machine (CPU, memory and emulated devices) to run a guest OS.
-In this mode the CPU may be fully emulated, or it may work with
-a hypervisor such as KVM, Xen, Hax or Hypervisor.Framework to
-allow the guest to run directly on the host CPU.
+In this mode the CPU may be fully emulated, or it may work with a
+hypervisor such as KVM, Xen, Hax or Hypervisor.Framework to allow the
+guest to run directly on the host CPU.
 
-The second supported way to use QEMU is "user mode emulation",
+The second supported way to use QEMU is :ref:`User Mode Emulation`,
 where QEMU can launch processes compiled for one CPU on another CPU.
 In this mode the CPU is always emulated.
 
-QEMU also provides a number of standalone commandline utilities,
-such as the ``qemu-img`` disk image utility that allows you to create,
-convert and modify disk images.
+QEMU also provides a number of standalone :ref:`command line
+utilities<Tools>`, such as the ``qemu-img`` disk image utility that
+allows you to create, convert and modify disk images.
 
 .. toctree::
    :maxdepth: 2
index e3695649c529dae7f4f7c7c8928229902f269377..282b6ffb56316838d72887fefba1ae536b30f17b 100644 (file)
@@ -1,3 +1,5 @@
+.. _System Emulation:
+
 ----------------
 System Emulation
 ----------------
index 1edd5a8054a6eb98bf4debd57b8a8d0caaaee2a1..2151adcf78441a20eb8f1c5bce2768d7db9f3133 100644 (file)
@@ -1,3 +1,5 @@
+.. _Tools:
+
 -----
 Tools
 -----
index 2c4e29f3dbc34f5ee95570362d1279a6bf2ebeef..782d27cda27622a34d07d3eb43b772be06bcec7d 100644 (file)
@@ -1,3 +1,5 @@
+.. _User Mode Emulation:
+
 -------------------
 User Mode Emulation
 -------------------