qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Peter Maydell <peter.maydell@linaro.org>
To: qemu-devel@nongnu.org
Subject: [PULL 06/33] qemu-doc: extract common system emulator documentation from the PC section
Date: Fri,  6 Mar 2020 11:09:32 +0000	[thread overview]
Message-ID: <20200306110959.29461-7-peter.maydell@linaro.org> (raw)
In-Reply-To: <20200306110959.29461-1-peter.maydell@linaro.org>

From: Paolo Bonzini <pbonzini@redhat.com>

Move the section on PC peripherals together with other targets.
While some x86-specific information remains in the main system
emulation chapter, it can be tackled more easily a section at a
time.

Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
Tested-by: Alex Bennée <alex.bennee@linaro.org>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Message-id: 20200228153619.9906-7-peter.maydell@linaro.org
Message-id: 20200226113034.6741-7-pbonzini@redhat.com
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
 docs/system/quickstart.texi |   2 +-
 qemu-doc.texi               | 102 ++++++++++++++++++++----------------
 2 files changed, 57 insertions(+), 47 deletions(-)

diff --git a/docs/system/quickstart.texi b/docs/system/quickstart.texi
index 8cd5b4bc6e5..ed7295de7a2 100644
--- a/docs/system/quickstart.texi
+++ b/docs/system/quickstart.texi
@@ -2,7 +2,7 @@
 @section Quick Start
 @cindex quick start
 
-Download and uncompress a hard disk image with Linux installed (e.g.
+Download and uncompress a PC hard disk image with Linux installed (e.g.
 @file{linux.img}) and type:
 
 @example
diff --git a/qemu-doc.texi b/qemu-doc.texi
index 33d24caf946..88e84300e91 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -36,8 +36,8 @@
 
 @menu
 * Introduction::
-* QEMU PC System emulator::
-* QEMU System emulator for non PC targets::
+* QEMU System emulator::
+* QEMU System emulator targets::
 * System requirements::
 * Security::
 * Implementation notes::
@@ -127,19 +127,16 @@ accelerator is required to use more than one host CPU for emulation.
 
 @end itemize
 
-
-@node QEMU PC System emulator
-@chapter QEMU PC System emulator
-@cindex system emulation (PC)
+@node QEMU System emulator
+@chapter QEMU System emulator
+@cindex system emulation
 
 @menu
-* pcsys_introduction:: Introduction
-* pcsys_quickstart::   Quick Start
+* pcsys_quickstart::   Quick start
 * sec_invocation::     Invocation
 * pcsys_keys::         Keys in the graphical frontends
 * mux_keys::           Keys in the character backend multiplexer
 * pcsys_monitor::      QEMU Monitor
-* cpu_models_x86::     Supported CPU model configurations on x86 hosts
 * disk_images::        Disk Images
 * pcsys_network::      Network emulation
 * pcsys_usb::          USB emulation
@@ -150,13 +147,57 @@ accelerator is required to use more than one host CPU for emulation.
 * gdb_usage::          GDB usage
 @end menu
 
-@node pcsys_introduction
-@section Introduction
+@include docs/system/quickstart.texi
+@include docs/system/invocation.texi
+@include docs/system/keys.texi
+@include docs/system/mux-chardev.texi
+@include docs/system/monitor.texi
+@include docs/system/images.texi
+@include docs/system/net.texi
+@include docs/system/usb.texi
+@include docs/system/ivshmem.texi
+@include docs/system/linuxboot.texi
+@include docs/system/vnc-security.texi
+@include docs/system/tls.texi
+@include docs/system/gdb.texi
+
+@node QEMU System emulator targets
+@chapter QEMU System emulator targets
+@cindex system emulation (PC)
+
+QEMU is a generic emulator and it emulates many machines. Most of the
+options are similar for all machines. Specific information about the
+various targets are mentioned in the following sections.
+
+@menu
+* x86 (PC) System emulator::
+* PowerPC System emulator::
+* Sparc32 System emulator::
+* Sparc64 System emulator::
+* MIPS System emulator::
+* ARM System emulator::
+* ColdFire System emulator::
+* Cris System emulator::
+* Microblaze System emulator::
+* SH4 System emulator::
+* Xtensa System emulator::
+@end menu
+
+@node x86 (PC) System emulator
+@section x86 (PC) System emulator
+@cindex system emulation (PC)
+
+@menu
+* pcsys_devices::      Peripherals
+* cpu_models_x86::     Supported CPU model configurations on x86 hosts
+@end menu
+
+@node pcsys_devices
+@subsection Peripherals
 
 @c man begin DESCRIPTION
 
-The QEMU PC System emulator simulates the
-following peripherals:
+The QEMU PC System emulator simulates the following peripherals:
 
 @itemize @minus
 @item
@@ -222,40 +263,9 @@ CS4231A is the chip used in Windows Sound System and GUSMAX products
 
 @c man end
 
-@include docs/system/quickstart.texi
-@include docs/system/invocation.texi
-@include docs/system/keys.texi
-@include docs/system/mux-chardev.texi
-@include docs/system/monitor.texi
+@lowersections
 @include docs/system/cpu-models-x86.texi
-@include docs/system/images.texi
-@include docs/system/net.texi
-@include docs/system/usb.texi
-@include docs/system/ivshmem.texi
-@include docs/system/linuxboot.texi
-@include docs/system/vnc-security.texi
-@include docs/system/tls.texi
-@include docs/system/gdb.texi
-
-@node QEMU System emulator for non PC targets
-@chapter QEMU System emulator for non PC targets
-
-QEMU is a generic emulator and it emulates many non PC
-machines. Most of the options are similar to the PC emulator. The
-differences are mentioned in the following sections.
-
-@menu
-* PowerPC System emulator::
-* Sparc32 System emulator::
-* Sparc64 System emulator::
-* MIPS System emulator::
-* ARM System emulator::
-* ColdFire System emulator::
-* Cris System emulator::
-* Microblaze System emulator::
-* SH4 System emulator::
-* Xtensa System emulator::
-@end menu
+@raisesections
 
 @node PowerPC System emulator
 @section PowerPC System emulator
-- 
2.20.1



  parent reply	other threads:[~2020-03-06 11:14 UTC|newest]

Thread overview: 37+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-03-06 11:09 [PULL 00/33] docs queue Peter Maydell
2020-03-06 11:09 ` [PULL 01/33] qemu-doc: convert user-mode emulation to a separate Sphinx manual Peter Maydell
2020-03-06 11:09 ` [PULL 02/33] qemu-doc: remove target OS documentation Peter Maydell
2020-03-06 11:09 ` [PULL 03/33] texi2pod: parse @include directives outside "@c man" blocks Peter Maydell
2020-03-06 11:09 ` [PULL 04/33] qemu-doc: split CPU models doc between MIPS and x86 parts Peter Maydell
2020-03-06 11:09 ` [PULL 05/33] qemu-doc: split qemu-doc.texi in multiple files Peter Maydell
2020-03-06 11:09 ` Peter Maydell [this message]
2020-03-06 11:09 ` [PULL 07/33] qemu-doc: move system requirements chapter inside PC section Peter Maydell
2020-03-06 11:09 ` [PULL 08/33] qemu-doc: split target sections to separate files Peter Maydell
2020-03-06 11:09 ` [PULL 09/33] qemu-doc: Remove the "CPU emulation" part of the "Implementation notes" Peter Maydell
2020-03-06 11:09 ` [PULL 10/33] qemu-doc: move qemu-tech.texi into main section Peter Maydell
2020-03-06 11:09 ` [PULL 11/33] qemu-doc: move included files to docs/system Peter Maydell
2020-03-06 11:09 ` [PULL 12/33] qemu-doc: remove indices other than findex Peter Maydell
2020-03-06 11:09 ` [PULL 13/33] docs/system: put qemu-block-drivers body in an included file Peter Maydell
2020-03-06 11:09 ` [PULL 14/33] docs: Create defs.rst.inc as a place to define substitutions Peter Maydell
2020-03-06 11:09 ` [PULL 15/33] docs/system: Convert qemu-cpu-models.texi to rST Peter Maydell
2020-03-06 11:09 ` [PULL 16/33] docs/system: Convert security.texi to rST format Peter Maydell
2020-03-06 11:09 ` [PULL 17/33] docs/system: convert managed startup to rST Peter Maydell
2020-03-06 11:09 ` [PULL 18/33] docs/system: convert the documentation of deprecated features " Peter Maydell
2020-03-06 11:09 ` [PULL 19/33] docs/system: convert Texinfo documentation " Peter Maydell
2020-03-06 11:09 ` [PULL 20/33] hmp-commands.hx: Add rST documentation fragments Peter Maydell
2020-03-06 11:09 ` [PULL 21/33] hmp-commands-info.hx: " Peter Maydell
2020-03-06 11:09 ` [PULL 22/33] doc/scripts/hxtool.py: Strip trailing ':' from DEFHEADING/ARCHHEADING Peter Maydell
2020-03-06 11:09 ` [PULL 23/33] docs: Roll semihosting option information into qemu-options.hx Peter Maydell
2020-03-06 11:09 ` [PULL 24/33] docs: Roll -prom-env and -g target-specific info " Peter Maydell
2020-03-06 11:09 ` [PULL 25/33] scripts/hxtool-conv: Archive script used in qemu-options.hx conversion Peter Maydell
2020-03-06 11:09 ` [PULL 26/33] qemu-options.hx: Add rST documentation fragments Peter Maydell
2020-03-06 11:09 ` [PULL 27/33] qemu-options.hx: Fix up the autogenerated rST Peter Maydell
2020-03-06 11:09 ` [PULL 28/33] docs: Split out sections for the manpage into .rst.inc files Peter Maydell
2020-03-06 11:09 ` [PULL 29/33] docs: Generate qemu.1 manpage with Sphinx Peter Maydell
2020-03-06 11:09 ` [PULL 30/33] ui/cocoa.m: Update documentation file and pathname Peter Maydell
2020-03-06 11:09 ` [PULL 31/33] docs: Stop building qemu-doc Peter Maydell
2020-03-06 11:09 ` [PULL 32/33] docs: Remove old texinfo sources Peter Maydell
2020-03-06 11:09 ` [PULL 33/33] *.hx: Remove all the STEXI/ETEXI blocks Peter Maydell
2020-03-06 11:37 ` [PULL 00/33] docs queue no-reply
2020-03-06 11:52 ` Peter Maydell
2020-03-06 11:55 ` no-reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200306110959.29461-7-peter.maydell@linaro.org \
    --to=peter.maydell@linaro.org \
    --cc=qemu-devel@nongnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).