mirror of
https://github.com/Motorhead1991/qemu.git
synced 2025-07-27 04:13:53 -06:00
e13c59fa44
The qemu-img documentation is currently in qemu-nbd.texi in Texinfo format, which we present to the user as: * a qemu-img manpage * a section of the main qemu-doc HTML documentation Convert the documentation to rST format, and present it to the user as: * a qemu-img manpage * part of the interop/ Sphinx manual The qemu-img rST document uses the new hxtool extension to handle pulling rST fragments out of qemu-img-cmds.hx. The documentation of the various options and commands is rather muddled, with some options being described inside the relevant command description and some in a more general section near the start of the manual. All the command synopses are replicated in the .hx file and then again in the manual. A lot of text is also duplicated in the qemu-img.c code for the help text. I have not attempted to deal with any of this, but have simply transposed the existing structure into rST. As usual, there are some minor formatting changes but no textual changes, except that as with one or two other conversions I have dropped the 'see also' section since it's not very informative and looks odd in the HTML. Signed-off-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> Message-id: 20200124162606.8787-6-peter.maydell@linaro.org
26 lines
1,011 B
Python
26 lines
1,011 B
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# QEMU documentation build configuration file for the 'interop' manual.
|
|
#
|
|
# This includes the top level conf file and then makes any necessary tweaks.
|
|
import sys
|
|
import os
|
|
|
|
qemu_docdir = os.path.abspath("..")
|
|
parent_config = os.path.join(qemu_docdir, "conf.py")
|
|
exec(compile(open(parent_config, "rb").read(), parent_config, 'exec'))
|
|
|
|
# This slightly misuses the 'description', but is the best way to get
|
|
# the manual title to appear in the sidebar.
|
|
html_theme_options['description'] = u'System Emulation Management and Interoperability Guide'
|
|
|
|
# One entry per manual page. List of tuples
|
|
# (source start file, name, description, authors, manual section).
|
|
man_pages = [
|
|
('qemu-ga', 'qemu-ga', u'QEMU Guest Agent',
|
|
['Michael Roth <mdroth@linux.vnet.ibm.com>'], 8),
|
|
('qemu-img', 'qemu-img', u'QEMU disk image utility',
|
|
['Fabrice Bellard'], 1),
|
|
('qemu-nbd', 'qemu-nbd', u'QEMU Disk Network Block Device Server',
|
|
['Anthony Liguori <anthony@codemonkey.ws>'], 8)
|
|
]
|