Skip to content
  • Paolo Bonzini's avatar
    docs/system: convert Texinfo documentation to rST · 324b2298
    Paolo Bonzini authored and Peter Maydell's avatar Peter Maydell committed
    
    
    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: default avatarPaolo Bonzini <pbonzini@redhat.com>
    Reviewed-by: default avatarPeter Maydell <peter.maydell@linaro.org>
    Reviewed-by: default avatarAlex Bennée <alex.bennee@linaro.org>
    Tested-by: default avatarAlex Bennée <alex.bennee@linaro.org>
    Signed-off-by: default avatarPeter 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: default avatarPeter Maydell <peter.maydell@linaro.org>
    Signed-off-by: default avatarPeter Maydell <peter.maydell@linaro.org>
    324b2298