[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 2/7] docs: Stop calling the top level subsections of our manual '
From: |
Peter Maydell |
Subject: |
[PATCH 2/7] docs: Stop calling the top level subsections of our manual 'manuals' |
Date: |
Mon, 5 Jul 2021 10:55:42 +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>
---
docs/devel/index.rst | 5 +----
docs/interop/index.rst | 7 ++-----
docs/specs/index.rst | 5 ++---
docs/system/index.rst | 5 +----
docs/tools/index.rst | 5 ++---
docs/user/index.rst | 5 +----
6 files changed, 9 insertions(+), 23 deletions(-)
diff --git a/docs/devel/index.rst b/docs/devel/index.rst
index 977c3893bda..e188f187a18 100644
--- a/docs/devel/index.rst
+++ b/docs/devel/index.rst
@@ -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.
diff --git a/docs/interop/index.rst b/docs/interop/index.rst
index 219a5e5fc50..8b34da6f551 100644
--- a/docs/interop/index.rst
+++ b/docs/interop/index.rst
@@ -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:
diff --git a/docs/specs/index.rst b/docs/specs/index.rst
index 7b08314d334..4c0d2a37cb8 100644
--- a/docs/specs/index.rst
+++ b/docs/specs/index.rst
@@ -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:
diff --git a/docs/system/index.rst b/docs/system/index.rst
index 6092eb2d91d..2a9bd759807 100644
--- a/docs/system/index.rst
+++ b/docs/system/index.rst
@@ -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.
diff --git a/docs/tools/index.rst b/docs/tools/index.rst
index d923834a739..ffb14b9690b 100644
--- a/docs/tools/index.rst
+++ b/docs/tools/index.rst
@@ -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:
diff --git a/docs/user/index.rst b/docs/user/index.rst
index a5b47459ec7..6ac2ac089fd 100644
--- a/docs/user/index.rst
+++ b/docs/user/index.rst
@@ -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.
--
2.20.1
- [PATCH 4/7] docs: Move deprecation, build and license info out of system/, (continued)
- [PATCH 4/7] docs: Move deprecation, build and license info out of system/, Peter Maydell, 2021/07/05
- [PATCH 5/7] docs: Add some actual About text to about/index.rst, Peter Maydell, 2021/07/05
- [PATCH 3/7] docs: Remove "Contents:" lines from top-level subsections, Peter Maydell, 2021/07/05
- [PATCH 7/7] docs: Add QEMU version information to HTML footer, Peter Maydell, 2021/07/05
- [PATCH 2/7] docs: Stop calling the top level subsections of our manual 'manuals',
Peter Maydell <=
- [PATCH 6/7] docs: Add license note to the HTML page footer, Peter Maydell, 2021/07/05
- Re: [PATCH 0/7] docs: State QEMU version and license in all HTML footers, Peter Maydell, 2021/07/13
- Re: [PATCH 0/7] docs: State QEMU version and license in all HTML footers, Markus Armbruster, 2021/07/14