[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 06/33] qemu-doc: extract common system emulator documentation from
From: |
Peter Maydell |
Subject: |
[PULL 06/33] qemu-doc: extract common system emulator documentation from the PC section |
Date: |
Fri, 6 Mar 2020 11:09:32 +0000 |
From: Paolo Bonzini <address@hidden>
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 <address@hidden>
Reviewed-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Tested-by: Alex Bennée <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Message-id: address@hidden
Message-id: address@hidden
Reviewed-by: Peter Maydell <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
---
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
- [PULL 00/33] docs queue, Peter Maydell, 2020/03/06
- [PULL 02/33] qemu-doc: remove target OS documentation, Peter Maydell, 2020/03/06
- [PULL 03/33] texi2pod: parse @include directives outside "@c man" blocks, Peter Maydell, 2020/03/06
- [PULL 01/33] qemu-doc: convert user-mode emulation to a separate Sphinx manual, Peter Maydell, 2020/03/06
- [PULL 04/33] qemu-doc: split CPU models doc between MIPS and x86 parts, Peter Maydell, 2020/03/06
- [PULL 07/33] qemu-doc: move system requirements chapter inside PC section, Peter Maydell, 2020/03/06
- [PULL 06/33] qemu-doc: extract common system emulator documentation from the PC section,
Peter Maydell <=
- [PULL 09/33] qemu-doc: Remove the "CPU emulation" part of the "Implementation notes", Peter Maydell, 2020/03/06
- [PULL 10/33] qemu-doc: move qemu-tech.texi into main section, Peter Maydell, 2020/03/06
- [PULL 11/33] qemu-doc: move included files to docs/system, Peter Maydell, 2020/03/06
- [PULL 12/33] qemu-doc: remove indices other than findex, Peter Maydell, 2020/03/06
- [PULL 14/33] docs: Create defs.rst.inc as a place to define substitutions, Peter Maydell, 2020/03/06
- [PULL 17/33] docs/system: convert managed startup to rST., Peter Maydell, 2020/03/06
- [PULL 16/33] docs/system: Convert security.texi to rST format, Peter Maydell, 2020/03/06
- [PULL 08/33] qemu-doc: split target sections to separate files, Peter Maydell, 2020/03/06
- [PULL 13/33] docs/system: put qemu-block-drivers body in an included file, Peter Maydell, 2020/03/06
- [PULL 15/33] docs/system: Convert qemu-cpu-models.texi to rST, Peter Maydell, 2020/03/06