| Message ID | 20230113133923.1642627-2-alex.bennee@linaro.org |
|---|---|
| State | Superseded |
| Headers | show |
| Series | Improve the introductory documentation | expand |
On Fri, 13 Jan 2023 at 13:39, Alex Bennée <alex.bennee@linaro.org> wrote: > > Make it easier to navigate the documentation. > > Signed-off-by: Alex Bennée <alex.bennee@linaro.org> > --- > docs/about/index.rst | 16 ++++++++-------- > docs/system/index.rst | 2 ++ > docs/tools/index.rst | 2 ++ > docs/user/index.rst | 2 ++ > 4 files changed, 14 insertions(+), 8 deletions(-) > > 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. Any particular reason for this change? As far as I can tell it's just rewrapping these there lines? Otherwise Reviewed-by: Peter Maydell <peter.maydell@linaro.org> thanks -- PMM
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 -------------------
Make it easier to navigate the documentation. Signed-off-by: Alex Bennée <alex.bennee@linaro.org> --- docs/about/index.rst | 16 ++++++++-------- docs/system/index.rst | 2 ++ docs/tools/index.rst | 2 ++ docs/user/index.rst | 2 ++ 4 files changed, 14 insertions(+), 8 deletions(-)