[PATCH v2 00/18] qemu-doc reorganization and Sphinx version

[Paolo Bonzini]

This series converts qemu-doc to Sphinx, providing the fourth and fifth
manuals (user-mode emulation and system emulation).

Patch 1 extracts the user-mode emulation documentation to docs/user,
converting it to rST.

Patches 2 to 12 split qemu-doc.texi in multiple files, slightly
reorganizing the sections and removing wildly obsolete material.
At this point qemu-doc.texi looks very much like what docs/system
will be.

Patch 13 tweaks the construction of the qemu-block-drivers man page
from the material that goes in docs/system.  Instead of usihg an
"only" directive, the man page is in an orphaned .rst file and
the common material is included.

Patch 14 is Kashyap's conversion of qemu-cpu-models.texi to rST,
tweaked in the same way as patch 12.

Patches 15 to 17 are Peter's manual conversion of security.texi,
qemu-tech.texi and qemu-deprecated.texi.

Patch 18 finally is the mass automated conversion of everything
else.  The content is temporarily preserved in qemu-doc.texi as well,
until the hxtool-based documentation is converted to rST.

Paolo

Supersedes: <address@hidden>

Kashyap Chamarthy (1):
  docs/system: Convert qemu-cpu-models.texi to rST

Paolo Bonzini (13):
  qemu-doc: convert user-mode emulation to a separate Sphinx manual
  qemu-doc: remove target OS documentation
  texi2pod: parse @include directives outside "@c man" blocks
  qemu-doc: split CPU models doc between MIPS and x86 parts
  qemu-doc: split qemu-doc.texi in multiple files
  qemu-doc: extract common system emulator documentation from the PC
    section
  qemu-doc: move system requirements chapter inside PC section
  qemu-doc: split target sections to separate files
  qemu-doc: move qemu-tech.texi into main section
  qemu-doc: move included files to docs/system
  qemu-doc: remove indices other than findex
  docs/system: put qemu-block-drivers body in an included file
  docs/system: convert Texinfo documentation to rST

Peter Maydell (4):
  qemu-doc: Remove the "CPU emulation" part of the "Implementation
    notes"
  docs/system: Convert security.texi to rST format
  docs/system: convert managed startup to rST.
  docs/system: convert the documentation of deprecated features to rST.

 MAINTAINERS                                   |    6 +-
 Makefile                                      |   42 +-
 docs/conf.py                                  |    2 +-
 docs/system/build-platforms.rst               |   79 +
 docs/system/build-platforms.texi              |   67 +
 docs/system/conf.py                           |   10 +-
 docs/system/cpu-models-mips.rst.inc           |  105 +
 docs/system/cpu-models-mips.texi              |  157 +
 docs/system/cpu-models-x86.rst.inc            |  365 +++
 .../cpu-models-x86.texi}                      |  221 +-
 docs/system/defs.rst.inc                      |    2 +
 docs/system/deprecated.rst                    |  446 +++
 .../system/deprecated.texi                    |    0
 docs/system/gdb.rst                           |   81 +
 docs/system/gdb.texi                          |   71 +
 docs/system/images.rst                        |   85 +
 docs/system/images.texi                       |   88 +
 docs/system/index.rst                         |   22 +-
 docs/system/invocation.rst                    |  242 ++
 docs/system/invocation.texi                   |  240 ++
 docs/system/ivshmem.rst                       |   64 +
 docs/system/ivshmem.texi                      |   60 +
 docs/system/keys.rst                          |   40 +
 docs/system/keys.texi                         |   43 +
 docs/system/license.rst                       |   11 +
 docs/system/license.texi                      |    9 +
 docs/system/linuxboot.rst                     |   30 +
 docs/system/linuxboot.texi                    |   27 +
 docs/system/managed-startup.rst               |   35 +
 docs/system/managed-startup.texi              |   35 +
 docs/system/monitor.rst                       |   25 +
 docs/system/monitor.texi                      |   34 +
 docs/system/mux-chardev.rst                   |   32 +
 docs/system/mux-chardev.texi                  |   44 +
 docs/system/net.rst                           |  100 +
 docs/system/net.texi                          |   96 +
 docs/system/qemu-block-drivers.rst            |  989 +-----
 docs/system/qemu-block-drivers.rst.inc        |  954 ++++++
 docs/system/qemu-cpu-models.rst               |   20 +
 .../system/qemu-option-trace.texi             |    0
 docs/system/quickstart.rst                    |   13 +
 docs/system/quickstart.texi                   |   12 +
 docs/system/security.rst                      |  173 +
 docs/{ => system}/security.texi               |    0
 docs/system/target-arm.rst                    |  227 ++
 docs/system/target-arm.texi                   |  263 ++
 docs/system/target-i386.rst                   |   84 +
 docs/system/target-i386.texi                  |   91 +
 docs/system/target-m68k.rst                   |   32 +
 docs/system/target-m68k.texi                  |   44 +
 docs/system/target-mips.rst                   |  120 +
 docs/system/target-mips.texi                  |  150 +
 docs/system/target-ppc.rst                    |   61 +
 docs/system/target-ppc.texi                   |   77 +
 docs/system/target-sparc.rst                  |   81 +
 docs/system/target-sparc.texi                 |   95 +
 docs/system/target-sparc64.rst                |   49 +
 docs/system/target-sparc64.texi               |   60 +
 docs/system/target-xtensa.rst                 |   39 +
 docs/system/target-xtensa.texi                |   55 +
 docs/system/targets.rst                       |   19 +
 docs/system/tls.rst                           |  328 ++
 docs/system/tls.texi                          |  329 ++
 docs/system/usb.rst                           |  137 +
 docs/system/usb.texi                          |  115 +
 docs/system/vnc-security.rst                  |  202 ++
 docs/system/vnc-security.texi                 |  196 ++
 docs/user/conf.py                             |   18 +
 docs/user/index.rst                           |   16 +
 docs/user/main.rst                            |  295 ++
 qemu-doc.texi                                 | 2868 +----------------
 qemu-options.hx                               |    2 +-
 qemu-tech.texi                                |  195 --
 scripts/texi2pod.pl                           |   36 +-
 74 files changed, 7229 insertions(+), 4232 deletions(-)
 create mode 100644 docs/system/build-platforms.rst
 create mode 100644 docs/system/build-platforms.texi
 create mode 100644 docs/system/cpu-models-mips.rst.inc
 create mode 100644 docs/system/cpu-models-mips.texi
 create mode 100644 docs/system/cpu-models-x86.rst.inc
 rename docs/{qemu-cpu-models.texi => system/cpu-models-x86.texi} (71%)
 create mode 100644 docs/system/defs.rst.inc
 create mode 100644 docs/system/deprecated.rst
 rename qemu-deprecated.texi => docs/system/deprecated.texi (100%)
 create mode 100644 docs/system/gdb.rst
 create mode 100644 docs/system/gdb.texi
 create mode 100644 docs/system/images.rst
 create mode 100644 docs/system/images.texi
 create mode 100644 docs/system/invocation.rst
 create mode 100644 docs/system/invocation.texi
 create mode 100644 docs/system/ivshmem.rst
 create mode 100644 docs/system/ivshmem.texi
 create mode 100644 docs/system/keys.rst
 create mode 100644 docs/system/keys.texi
 create mode 100644 docs/system/license.rst
 create mode 100644 docs/system/license.texi
 create mode 100644 docs/system/linuxboot.rst
 create mode 100644 docs/system/linuxboot.texi
 create mode 100644 docs/system/managed-startup.rst
 create mode 100644 docs/system/managed-startup.texi
 create mode 100644 docs/system/monitor.rst
 create mode 100644 docs/system/monitor.texi
 create mode 100644 docs/system/mux-chardev.rst
 create mode 100644 docs/system/mux-chardev.texi
 create mode 100644 docs/system/net.rst
 create mode 100644 docs/system/net.texi
 create mode 100644 docs/system/qemu-block-drivers.rst.inc
 create mode 100644 docs/system/qemu-cpu-models.rst
 rename qemu-option-trace.texi => docs/system/qemu-option-trace.texi (100%)
 create mode 100644 docs/system/quickstart.rst
 create mode 100644 docs/system/quickstart.texi
 create mode 100644 docs/system/security.rst
 rename docs/{ => system}/security.texi (100%)
 create mode 100644 docs/system/target-arm.rst
 create mode 100644 docs/system/target-arm.texi
 create mode 100644 docs/system/target-i386.rst
 create mode 100644 docs/system/target-i386.texi
 create mode 100644 docs/system/target-m68k.rst
 create mode 100644 docs/system/target-m68k.texi
 create mode 100644 docs/system/target-mips.rst
 create mode 100644 docs/system/target-mips.texi
 create mode 100644 docs/system/target-ppc.rst
 create mode 100644 docs/system/target-ppc.texi
 create mode 100644 docs/system/target-sparc.rst
 create mode 100644 docs/system/target-sparc.texi
 create mode 100644 docs/system/target-sparc64.rst
 create mode 100644 docs/system/target-sparc64.texi
 create mode 100644 docs/system/target-xtensa.rst
 create mode 100644 docs/system/target-xtensa.texi
 create mode 100644 docs/system/targets.rst
 create mode 100644 docs/system/tls.rst
 create mode 100644 docs/system/tls.texi
 create mode 100644 docs/system/usb.rst
 create mode 100644 docs/system/usb.texi
 create mode 100644 docs/system/vnc-security.rst
 create mode 100644 docs/system/vnc-security.texi
 create mode 100644 docs/user/conf.py
 create mode 100644 docs/user/index.rst
 create mode 100644 docs/user/main.rst
 delete mode 100644 qemu-tech.texi

-- 
2.21.1