docs/system: convert Texinfo documentation to rST
commit324b2298feab35533d44301cfdae332c086463cf
authorPaolo Bonzini <pbonzini@redhat.com>
Fri, 28 Feb 2020 15:36:05 +0000 (28 15:36 +0000)
committerPeter Maydell <peter.maydell@linaro.org>
Fri, 6 Mar 2020 10:05:12 +0000 (6 10:05 +0000)
tree659a01d0fcd247ade452d3d84b9db928ca1ce64f
parent41fba1618b7a743740670f528ba409478678cc7c
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>
26 files changed:
docs/defs.rst.inc
docs/system/build-platforms.rst [new file with mode: 0644]
docs/system/gdb.rst [new file with mode: 0644]
docs/system/images.rst [new file with mode: 0644]
docs/system/index.rst
docs/system/invocation.rst [new file with mode: 0644]
docs/system/ivshmem.rst [new file with mode: 0644]
docs/system/keys.rst [new file with mode: 0644]
docs/system/license.rst [new file with mode: 0644]
docs/system/linuxboot.rst [new file with mode: 0644]
docs/system/monitor.rst [new file with mode: 0644]
docs/system/mux-chardev.rst [new file with mode: 0644]
docs/system/net.rst [new file with mode: 0644]
docs/system/quickstart.rst [new file with mode: 0644]
docs/system/target-arm.rst [new file with mode: 0644]
docs/system/target-i386.rst [new file with mode: 0644]
docs/system/target-m68k.rst [new file with mode: 0644]
docs/system/target-mips.rst [new file with mode: 0644]
docs/system/target-ppc.rst [new file with mode: 0644]
docs/system/target-sparc.rst [new file with mode: 0644]
docs/system/target-sparc64.rst [new file with mode: 0644]
docs/system/target-xtensa.rst [new file with mode: 0644]
docs/system/targets.rst [new file with mode: 0644]
docs/system/tls.rst [new file with mode: 0644]
docs/system/usb.rst [new file with mode: 0644]
docs/system/vnc-security.rst [new file with mode: 0644]