]> git.proxmox.com Git - mirror_qemu.git/commitdiff
docs: Stop calling the top level subsections of our manual 'manuals'
authorPeter Maydell <peter.maydell@linaro.org>
Mon, 5 Jul 2021 09:55:42 +0000 (10:55 +0100)
committerPeter Maydell <peter.maydell@linaro.org>
Sun, 18 Jul 2021 09:59:46 +0000 (10:59 +0100)
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

docs/devel/index.rst
docs/interop/index.rst
docs/specs/index.rst
docs/system/index.rst
docs/tools/index.rst
docs/user/index.rst

index 40a7e2ee6ffb6775a72a34a0212bbfe98f4fb8ff..9299d2a502da61a6f509b198e9400a23731909a5 100644 (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.
 
index 219a5e5fc50db6f3bc71f1bd7d5a49b6c43b9e04..8b34da6f551a2cd2c85eba8073cedd64df75d825 100644 (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:
 
index 7b08314d3343fd3e17cf2d9f644b8802dc6904d0..4c0d2a37cb8655a85d9ee35e04f3cc6a7e348ff0 100644 (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:
 
index 6092eb2d91d35acdb86f1ec4529c9d3c697fe95a..2a9bd759807a2e3313f262d167766accbdebf882 100644 (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.
index d923834a73985cdd456484f6a551c193679554a3..ffb14b9690bcfd63075612ec2f4023c5ea2072cd 100644 (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:
 
index a5b47459ec790eee7881edd3019778e51064e87d..6ac2ac089fd7736f28734926e0dc27c026e06f3a 100644 (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.