OpenE2K/qemu-e2k
13
4
Fork 0
Code Issues 4 Pull Requests Projects 2 Releases Activity

docs: Stop calling the top level subsections of our manual 'manuals'

Browse Source 
We merged our previous multiple-manual setup into a single Sphinx
manual, but we left some text in the various index.rst lines that
still calls the top level subsections separate 'manuals'.  Update
them to talk about "this section of the manual" instead, and remove
now-obsolete comments about how the index.rst files are the "top
level page for the 'foo' manual".

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Acked-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Message-id: 20210705095547.15790-3-peter.maydell@linaro.org
This commit is contained in:
Peter Maydell 2021-07-05 10:55:42 +01:00
parent 955990af73
commit b4634487c4
6 changed files with 9 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/devel/index.rst
View File

@ -1,10 +1,7 @@
.. This is the top level page for the 'devel' manual.
Developer Information
=====================
This manual documents various parts of the internals of QEMU.
This section of the manual documents various parts of the internals of QEMU.
You only need to read it if you are interested in reading or
modifying QEMU's source code.

7
docs/interop/index.rst
View File

@ -1,11 +1,8 @@
.. This is the top level page for the 'interop' manual.
System Emulation Management and Interoperability
================================================
This manual contains documents and specifications that are useful
for making QEMU interoperate with other software.
This section of the manual contains documents and specifications that
are useful for making QEMU interoperate with other software.
Contents:

5
docs/specs/index.rst
View File

@ -1,9 +1,8 @@
.. This is the top level page for the 'specs' manual
System Emulation Guest Hardware Specifications
==============================================
This section of the manual contains specifications of
guest hardware that is specific to QEMU.
Contents:

5
docs/system/index.rst
View File

@ -1,10 +1,7 @@
.. This is the top level page for the 'system' manual.
System Emulation
================
This manual is the overall guide for users using QEMU
This section of the manual is the overall guide for users using QEMU
for full system emulation (as opposed to user-mode emulation).
This includes working with hypervisors such as KVM, Xen, Hax
or Hypervisor.Framework.

5
docs/tools/index.rst
View File

@ -1,9 +1,8 @@
.. This is the top level page for the 'tools' manual
Tools
=====
This section of the manual documents QEMU's "tools": its
command line utilities and other standalone programs.
Contents:

5
docs/user/index.rst
View File

@ -1,10 +1,7 @@
.. This is the top level page for the 'user' manual.
User Mode Emulation
===================
This manual is the overall guide for users using QEMU
This section of the manual is the overall guide for users using QEMU
for user-mode emulation. In this mode, QEMU can launch
processes compiled for one CPU on another CPU.