qemu/docs/system
Paolo Bonzini 324b2298fe docs/system: convert Texinfo documentation to rST
Apart from targets.rst, which was written by hand, this is an automated
conversion obtained with the following command:

  makeinfo --force -o - --docbook \
    -D 'qemu_system_x86 QEMU_SYSTEM_X86_MACRO' \
    -D 'qemu_system     QEMU_SYSTEM_MACRO' \
    $texi | pandoc -f docbook -t rst+smart | perl -e '
      $/=undef;
      $_ = <>;
      s/^-  − /-  /gm;
      s/QEMU_SYSTEM_MACRO/|qemu_system|/g;
      s/QEMU_SYSTEM_X86_MACRO/|qemu_system_x86|/g;
      s/(?=::\n\n +\|qemu)/.. parsed-literal/g;
      s/:\n\n::$/::/gm;
      print' > $rst

In addition, the following changes were made manually:

- target-i386.rst and target-mips.rst: replace CPU model documentation with
  an include directive

- monitor.rst: replace the command section with a comment

- images.rst: add toctree

- target-arm.rst: Replace use of :math: (which Sphinx complains
  about) with :sup:, and hide it behind |I2C| and |I2C| substitutions.

Content that is not @included remains exclusive to qemu-doc.texi.

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-20-peter.maydell@linaro.org
Message-id: 20200226113034.6741-19-pbonzini@redhat.com
[PMM: Fixed target-arm.rst use of :math:; remove out of date
 note about images.rst from commit message; fixed expansion
 of |qemu_system_x86|; use parsed-literal in invocation.rst
 when we want to use |qemu_system_x86|; fix incorrect subsection
 level for "OS requirements" in target-i386.rst; fix incorrect
 syntax for making links to other sections of the manual]
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
2020-03-06 10:05:12 +00:00
..
build-platforms.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
build-platforms.texi qemu-doc: split qemu-doc.texi in multiple files 2020-03-06 10:04:57 +00:00
conf.py docs/system: Convert qemu-cpu-models.texi to rST 2020-03-06 10:05:12 +00:00
cpu-models-mips.rst.inc docs/system: Convert qemu-cpu-models.texi to rST 2020-03-06 10:05:12 +00:00
cpu-models-mips.texi qemu-doc: split CPU models doc between MIPS and x86 parts 2020-03-06 10:04:57 +00:00
cpu-models-x86.rst.inc docs/system: Convert qemu-cpu-models.texi to rST 2020-03-06 10:05:12 +00:00
cpu-models-x86.texi qemu-doc: split CPU models doc between MIPS and x86 parts 2020-03-06 10:04:57 +00:00
deprecated.rst docs/system: convert the documentation of deprecated features to rST. 2020-03-06 10:05:12 +00:00
deprecated.texi qemu-doc: move included files to docs/system 2020-03-06 10:04:57 +00:00
gdb.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
gdb.texi qemu-doc: split qemu-doc.texi in multiple files 2020-03-06 10:04:57 +00:00
images.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
images.texi qemu-doc: split qemu-doc.texi in multiple files 2020-03-06 10:04:57 +00:00
index.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
invocation.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
invocation.texi qemu-doc: split qemu-doc.texi in multiple files 2020-03-06 10:04:57 +00:00
ivshmem.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
ivshmem.texi qemu-doc: split qemu-doc.texi in multiple files 2020-03-06 10:04:57 +00:00
keys.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
keys.texi qemu-doc: remove indices other than findex 2020-03-06 10:04:58 +00:00
license.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
license.texi qemu-doc: split qemu-doc.texi in multiple files 2020-03-06 10:04:57 +00:00
linuxboot.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
linuxboot.texi qemu-doc: split qemu-doc.texi in multiple files 2020-03-06 10:04:57 +00:00
managed-startup.rst docs/system: convert managed startup to rST. 2020-03-06 10:05:12 +00:00
managed-startup.texi qemu-doc: move qemu-tech.texi into main section 2020-03-06 10:04:57 +00:00
monitor.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
monitor.texi qemu-doc: remove indices other than findex 2020-03-06 10:04:58 +00:00
mux-chardev.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
mux-chardev.texi qemu-doc: remove indices other than findex 2020-03-06 10:04:58 +00:00
net.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
net.texi qemu-doc: split qemu-doc.texi in multiple files 2020-03-06 10:04:57 +00:00
qemu-block-drivers.rst docs: Create defs.rst.inc as a place to define substitutions 2020-03-06 10:04:58 +00:00
qemu-block-drivers.rst.inc docs/system: put qemu-block-drivers body in an included file 2020-03-06 10:04:58 +00:00
qemu-cpu-models.rst docs/system: Convert qemu-cpu-models.texi to rST 2020-03-06 10:05:12 +00:00
qemu-option-trace.texi qemu-doc: move included files to docs/system 2020-03-06 10:04:57 +00:00
quickstart.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
quickstart.texi qemu-doc: remove indices other than findex 2020-03-06 10:04:58 +00:00
security.rst docs/system: Convert security.texi to rST format 2020-03-06 10:05:12 +00:00
security.texi qemu-doc: move included files to docs/system 2020-03-06 10:04:57 +00:00
target-arm.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
target-arm.texi qemu-doc: remove indices other than findex 2020-03-06 10:04:58 +00:00
target-i386.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
target-i386.texi qemu-doc: remove indices other than findex 2020-03-06 10:04:58 +00:00
target-m68k.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
target-m68k.texi qemu-doc: remove indices other than findex 2020-03-06 10:04:58 +00:00
target-mips.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
target-mips.texi qemu-doc: remove indices other than findex 2020-03-06 10:04:58 +00:00
target-ppc.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
target-ppc.texi qemu-doc: remove indices other than findex 2020-03-06 10:04:58 +00:00
target-sparc64.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
target-sparc64.texi qemu-doc: remove indices other than findex 2020-03-06 10:04:58 +00:00
target-sparc.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
target-sparc.texi qemu-doc: remove indices other than findex 2020-03-06 10:04:58 +00:00
target-xtensa.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
target-xtensa.texi qemu-doc: remove indices other than findex 2020-03-06 10:04:58 +00:00
targets.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
tls.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
tls.texi qemu-doc: split qemu-doc.texi in multiple files 2020-03-06 10:04:57 +00:00
usb.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
usb.texi qemu-doc: split qemu-doc.texi in multiple files 2020-03-06 10:04:57 +00:00
vfio-ap.rst docs: rstfy vfio-ap documentation 2020-02-26 18:57:07 +01:00
vnc-security.rst docs/system: convert Texinfo documentation to rST 2020-03-06 10:05:12 +00:00
vnc-security.texi qemu-doc: split qemu-doc.texi in multiple files 2020-03-06 10:04:57 +00:00