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>
Showing
- docs/defs.rst.inc 8 additions, 4 deletionsdocs/defs.rst.inc
- docs/system/build-platforms.rst 79 additions, 0 deletionsdocs/system/build-platforms.rst
- docs/system/gdb.rst 81 additions, 0 deletionsdocs/system/gdb.rst
- docs/system/images.rst 85 additions, 0 deletionsdocs/system/images.rst
- docs/system/index.rst 18 additions, 1 deletiondocs/system/index.rst
- docs/system/invocation.rst 242 additions, 0 deletionsdocs/system/invocation.rst
- docs/system/ivshmem.rst 64 additions, 0 deletionsdocs/system/ivshmem.rst
- docs/system/keys.rst 40 additions, 0 deletionsdocs/system/keys.rst
- docs/system/license.rst 11 additions, 0 deletionsdocs/system/license.rst
- docs/system/linuxboot.rst 30 additions, 0 deletionsdocs/system/linuxboot.rst
- docs/system/monitor.rst 25 additions, 0 deletionsdocs/system/monitor.rst
- docs/system/mux-chardev.rst 32 additions, 0 deletionsdocs/system/mux-chardev.rst
- docs/system/net.rst 100 additions, 0 deletionsdocs/system/net.rst
- docs/system/quickstart.rst 13 additions, 0 deletionsdocs/system/quickstart.rst
- docs/system/target-arm.rst 227 additions, 0 deletionsdocs/system/target-arm.rst
- docs/system/target-i386.rst 84 additions, 0 deletionsdocs/system/target-i386.rst
- docs/system/target-m68k.rst 32 additions, 0 deletionsdocs/system/target-m68k.rst
- docs/system/target-mips.rst 120 additions, 0 deletionsdocs/system/target-mips.rst
- docs/system/target-ppc.rst 61 additions, 0 deletionsdocs/system/target-ppc.rst
- docs/system/target-sparc.rst 81 additions, 0 deletionsdocs/system/target-sparc.rst
Loading
Please register or sign in to comment