[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 19/35] docs: add hotlinks to about preface text
From: |
Alex Bennée |
Subject: |
[PULL 19/35] docs: add hotlinks to about preface text |
Date: |
Thu, 26 Jan 2023 11:22:34 +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>
diff --git a/docs/about/index.rst b/docs/about/index.rst
index 5bea653c07..bae1309cc6 100644
--- a/docs/about/index.rst
+++ b/docs/about/index.rst
@@ -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
diff --git a/docs/system/index.rst b/docs/system/index.rst
index e3695649c5..282b6ffb56 100644
--- a/docs/system/index.rst
+++ b/docs/system/index.rst
@@ -1,3 +1,5 @@
+.. _System Emulation:
+
----------------
System Emulation
----------------
diff --git a/docs/tools/index.rst b/docs/tools/index.rst
index 1edd5a8054..2151adcf78 100644
--- a/docs/tools/index.rst
+++ b/docs/tools/index.rst
@@ -1,3 +1,5 @@
+.. _Tools:
+
-----
Tools
-----
diff --git a/docs/user/index.rst b/docs/user/index.rst
index 2c4e29f3db..782d27cda2 100644
--- a/docs/user/index.rst
+++ b/docs/user/index.rst
@@ -1,3 +1,5 @@
+.. _User Mode Emulation:
+
-------------------
User Mode Emulation
-------------------
--
2.34.1
- [PULL 29/35] util/qht: use striped locks under TSAN, (continued)
- [PULL 29/35] util/qht: use striped locks under TSAN, Alex Bennée, 2023/01/26
- [PULL 09/35] gitlab: add lsan suppression file to workaround tcmalloc issues, Alex Bennée, 2023/01/26
- [PULL 16/35] tests/tcg: Use SIGKILL for timeout, Alex Bennée, 2023/01/26
- [PULL 30/35] plugins: make qemu_plugin_user_exit's locking order consistent with fork_start's, Alex Bennée, 2023/01/26
- [PULL 26/35] cpu: free cpu->tb_jmp_cache with RCU, Alex Bennée, 2023/01/26
- [PULL 34/35] cpu-exec: assert that plugin_mem_cbs is NULL after execution, Alex Bennée, 2023/01/26
- [PULL 32/35] translator: always pair plugin_gen_insn_{start, end} calls, Alex Bennée, 2023/01/26
- [PULL 31/35] plugins: fix optimization in plugin_gen_disable_mem_helpers, Alex Bennée, 2023/01/26
- [PULL 24/35] semihosting: add O_BINARY flag in host_open for NT compatibility, Alex Bennée, 2023/01/26
- [PULL 23/35] semihosting: Write back semihosting data before completion callback, Alex Bennée, 2023/01/26
- [PULL 19/35] docs: add hotlinks to about preface text,
Alex Bennée <=
- [PULL 35/35] plugins: Iterate on cb_lists in qemu_plugin_user_exit, Alex Bennée, 2023/01/26
- [PULL 27/35] util/qht: add missing atomic_set(hashes[i]), Alex Bennée, 2023/01/26
- [PULL 21/35] semihosting: add semihosting section to the docs, Alex Bennée, 2023/01/26
- [PULL 33/35] tcg: exclude non-memory effecting helpers from instrumentation, Alex Bennée, 2023/01/26
- [PULL 22/35] docs: add an introduction to the system docs, Alex Bennée, 2023/01/26
- [PULL 25/35] tests/tcg: add memory-sve test for aarch64, Alex Bennée, 2023/01/26