diff options
| author | Peter Maydell <peter.maydell@linaro.org> | 2021-07-05 10:55:42 +0100 |
|---|---|---|
| committer | Peter Maydell <peter.maydell@linaro.org> | 2021-07-18 10:59:46 +0100 |
| commit | b4634487c44bd1cc664f45b63c98161dfd170784 (patch) | |
| tree | 7c52babc02eb45d9bc506270c3316e79b2f2ce30 | |
| parent | 955990af736a8cb2af7839d53b26ed8bb3b0633a (diff) | |
docs: Stop calling the top level subsections of our manual 'manuals'
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
| -rw-r--r-- | docs/devel/index.rst | 5 | ||||
| -rw-r--r-- | docs/interop/index.rst | 7 | ||||
| -rw-r--r-- | docs/specs/index.rst | 5 | ||||
| -rw-r--r-- | docs/system/index.rst | 5 | ||||
| -rw-r--r-- | docs/tools/index.rst | 5 | ||||
| -rw-r--r-- | 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 40a7e2ee6f..9299d2a502 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 219a5e5fc5..8b34da6f55 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 7b08314d33..4c0d2a37cb 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 6092eb2d91..2a9bd75980 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 d923834a73..ffb14b9690 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 a5b47459ec..6ac2ac089f 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. |