aboutsummaryrefslogtreecommitdiff
path: root/docs/defs.rst.inc
diff options
context:
space:
mode:
authorPaolo Bonzini <pbonzini@redhat.com>2020-02-28 15:36:05 +0000
committerPeter Maydell <peter.maydell@linaro.org>2020-03-06 10:05:12 +0000
commit324b2298feab35533d44301cfdae332c086463cf (patch)
tree659a01d0fcd247ade452d3d84b9db928ca1ce64f /docs/defs.rst.inc
parent41fba1618b7a743740670f528ba409478678cc7c (diff)
downloadqemu-324b2298feab35533d44301cfdae332c086463cf.zip
qemu-324b2298feab35533d44301cfdae332c086463cf.tar.gz
qemu-324b2298feab35533d44301cfdae332c086463cf.tar.bz2
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>
Diffstat (limited to 'docs/defs.rst.inc')
-rw-r--r--docs/defs.rst.inc12
1 files changed, 8 insertions, 4 deletions
diff --git a/docs/defs.rst.inc b/docs/defs.rst.inc
index ae80d2f..48d05aa 100644
--- a/docs/defs.rst.inc
+++ b/docs/defs.rst.inc
@@ -3,9 +3,13 @@
all rST files as part of the epilogue by docs/conf.py. conf.py
also defines some dynamically generated substitutions like CONFDIR.
- Note that |qemu_system| is intended to be used inside a parsed-literal
- block: the definition must not include extra literal formatting with
- ``..``: this works in the HTML output but the manpages will end up
- misrendered with following normal text incorrectly in boldface.
+ Note that |qemu_system| and |qemu_system_x86| are intended to be
+ used inside a parsed-literal block: the definition must not include
+ extra literal formatting with ``..``: this works in the HTML output
+ but the manpages will end up misrendered with following normal text
+ incorrectly in boldface.
.. |qemu_system| replace:: qemu-system-x86_64
+.. |qemu_system_x86| replace:: qemu_system-x86_64
+.. |I2C| replace:: I\ :sup:`2`\ C
+.. |I2S| replace:: I\ :sup:`2`\ S