mirror of https://github.com/proxmox/mirror_qemu
docs: Create new 'tools' manual
Some of the documentation for QEMU "tools" which are standalone binaries like qemu-img is an awkward fit in our current 5-manual split. We've put it into "interop", but they're not really about interoperability. Create a new top level manual "tools" which will be a better home for this documentation. This commit creates an empty initial manual; we will move the relevant documentation files in a subsequent commit. Signed-off-by: Peter Maydell <peter.maydell@linaro.org> Reviewed-by: Richard Henderson <richard.henderson@linaro.org> Acked-by: Paolo Bonzini <pbonzini@redhat.com> Message-id: 20200217155415.30949-2-peter.maydell@linaro.orgmaster
parent
c1e667d259
commit
65c3542b1f
8
Makefile
8
Makefile
|
@ -786,6 +786,7 @@ distclean: clean
|
||||||
$(call clean-manual,interop)
|
$(call clean-manual,interop)
|
||||||
$(call clean-manual,specs)
|
$(call clean-manual,specs)
|
||||||
$(call clean-manual,system)
|
$(call clean-manual,system)
|
||||||
|
$(call clean-manual,tools)
|
||||||
for d in $(TARGET_DIRS); do \
|
for d in $(TARGET_DIRS); do \
|
||||||
rm -rf $$d || exit 1 ; \
|
rm -rf $$d || exit 1 ; \
|
||||||
done
|
done
|
||||||
|
@ -843,6 +844,7 @@ install-sphinxdocs: sphinxdocs
|
||||||
$(call install-manual,interop)
|
$(call install-manual,interop)
|
||||||
$(call install-manual,specs)
|
$(call install-manual,specs)
|
||||||
$(call install-manual,system)
|
$(call install-manual,system)
|
||||||
|
$(call install-manual,tools)
|
||||||
|
|
||||||
install-doc: $(DOCS) install-sphinxdocs
|
install-doc: $(DOCS) install-sphinxdocs
|
||||||
$(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)"
|
$(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)"
|
||||||
|
@ -1036,7 +1038,8 @@ docs/version.texi: $(SRC_PATH)/VERSION config-host.mak
|
||||||
sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html \
|
sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html \
|
||||||
$(MANUAL_BUILDDIR)/interop/index.html \
|
$(MANUAL_BUILDDIR)/interop/index.html \
|
||||||
$(MANUAL_BUILDDIR)/specs/index.html \
|
$(MANUAL_BUILDDIR)/specs/index.html \
|
||||||
$(MANUAL_BUILDDIR)/system/index.html
|
$(MANUAL_BUILDDIR)/system/index.html \
|
||||||
|
$(MANUAL_BUILDDIR)/tools/index.html
|
||||||
|
|
||||||
# Canned command to build a single manual
|
# Canned command to build a single manual
|
||||||
# Arguments: $1 = manual name, $2 = Sphinx builder ('html' or 'man')
|
# Arguments: $1 = manual name, $2 = Sphinx builder ('html' or 'man')
|
||||||
|
@ -1069,6 +1072,9 @@ $(MANUAL_BUILDDIR)/specs/index.html: $(call manual-deps,specs)
|
||||||
$(MANUAL_BUILDDIR)/system/index.html: $(call manual-deps,system)
|
$(MANUAL_BUILDDIR)/system/index.html: $(call manual-deps,system)
|
||||||
$(call build-manual,system,html)
|
$(call build-manual,system,html)
|
||||||
|
|
||||||
|
$(MANUAL_BUILDDIR)/tools/index.html: $(call manual-deps,tools)
|
||||||
|
$(call build-manual,tools,html)
|
||||||
|
|
||||||
$(call define-manpage-rule,interop,\
|
$(call define-manpage-rule,interop,\
|
||||||
qemu-ga.8 qemu-img.1 qemu-nbd.8 qemu-trace-stap.1\
|
qemu-ga.8 qemu-img.1 qemu-nbd.8 qemu-trace-stap.1\
|
||||||
virtiofsd.1 virtfs-proxy-helper.1,\
|
virtiofsd.1 virtfs-proxy-helper.1,\
|
||||||
|
|
|
@ -13,6 +13,7 @@
|
||||||
<li><a href="interop/index.html">System Emulation Management and Interoperability Guide</a></li>
|
<li><a href="interop/index.html">System Emulation Management and Interoperability Guide</a></li>
|
||||||
<li><a href="specs/index.html">System Emulation Guest Hardware Specifications</a></li>
|
<li><a href="specs/index.html">System Emulation Guest Hardware Specifications</a></li>
|
||||||
<li><a href="system/index.html">System Emulation User's Guide</a></li>
|
<li><a href="system/index.html">System Emulation User's Guide</a></li>
|
||||||
|
<li><a href="tools/index.html">Tools Guide</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|
|
@ -14,3 +14,4 @@ Welcome to QEMU's documentation!
|
||||||
devel/index
|
devel/index
|
||||||
specs/index
|
specs/index
|
||||||
system/index
|
system/index
|
||||||
|
tools/index
|
||||||
|
|
|
@ -0,0 +1,16 @@
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
#
|
||||||
|
# QEMU documentation build configuration file for the 'tools' 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'Tools Guide'
|
|
@ -0,0 +1,11 @@
|
||||||
|
.. This is the top level page for the 'tools' manual
|
||||||
|
|
||||||
|
|
||||||
|
QEMU Tools Guide
|
||||||
|
================
|
||||||
|
|
||||||
|
|
||||||
|
Contents:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
Loading…
Reference in New Issue