* [PULL 0/3] docs queue
@ 2020-02-25 11:02 Peter Maydell
2020-02-25 11:02 ` [PULL 1/3] docs: Create new 'tools' manual Peter Maydell
` (3 more replies)
0 siblings, 4 replies; 5+ messages in thread
From: Peter Maydell @ 2020-02-25 11:02 UTC (permalink / raw)
To: qemu-devel
Just the "create the tools manual" patches; I'd like to
get this into master because it'll be a dependency for
some other stuff (even if only textually due to Makefile
changes).
thanks
-- PMM
The following changes since commit c1e667d2598b9b3ce62b8e89ed22dd38dfe9f57f:
Merge remote-tracking branch 'remotes/stefanha/tags/block-pull-request' into staging (2020-02-24 11:38:54 +0000)
are available in the Git repository at:
https://git.linaro.org/people/pmaydell/qemu-arm.git tags/pull-docs-20200225
for you to fetch changes up to a08b4a9fe6cb3c23755db764c9a40510a40a8731:
docs: Move tools documentation to tools manual (2020-02-25 10:48:06 +0000)
----------------------------------------------------------------
* create a new 'tools' manual, and move the documentation for
qemu-img, qemu-nbd, virtfs-proxy-helper, qemu-trace-stap and
virtiofsd to it
----------------------------------------------------------------
Peter Maydell (3):
docs: Create new 'tools' manual
docs: Move qemu-option-trace.rst.inc to docs/
docs: Move tools documentation to tools manual
Makefile | 41 +++++++++++++++----------
docs/index.html.in | 1 +
docs/index.rst | 1 +
docs/interop/conf.py | 12 --------
docs/interop/index.rst | 5 ---
docs/{interop => }/qemu-option-trace.rst.inc | 0
docs/tools/conf.py | 33 ++++++++++++++++++++
docs/tools/index.rst | 17 ++++++++++
docs/{interop => tools}/qemu-img.rst | 2 +-
docs/{interop => tools}/qemu-nbd.rst | 2 +-
docs/{interop => tools}/qemu-trace-stap.rst | 0
docs/{interop => tools}/virtfs-proxy-helper.rst | 0
docs/{interop => tools}/virtiofsd.rst | 0
13 files changed, 78 insertions(+), 36 deletions(-)
rename docs/{interop => }/qemu-option-trace.rst.inc (100%)
create mode 100644 docs/tools/conf.py
create mode 100644 docs/tools/index.rst
rename docs/{interop => tools}/qemu-img.rst (99%)
rename docs/{interop => tools}/qemu-nbd.rst (99%)
rename docs/{interop => tools}/qemu-trace-stap.rst (100%)
rename docs/{interop => tools}/virtfs-proxy-helper.rst (100%)
rename docs/{interop => tools}/virtiofsd.rst (100%)
^ permalink raw reply [flat|nested] 5+ messages in thread
* [PULL 1/3] docs: Create new 'tools' manual
2020-02-25 11:02 [PULL 0/3] docs queue Peter Maydell
@ 2020-02-25 11:02 ` Peter Maydell
2020-02-25 11:02 ` [PULL 2/3] docs: Move qemu-option-trace.rst.inc to docs/ Peter Maydell
` (2 subsequent siblings)
3 siblings, 0 replies; 5+ messages in thread
From: Peter Maydell @ 2020-02-25 11:02 UTC (permalink / raw)
To: qemu-devel
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.org
---
Makefile | 8 +++++++-
docs/index.html.in | 1 +
docs/index.rst | 1 +
docs/tools/conf.py | 16 ++++++++++++++++
docs/tools/index.rst | 11 +++++++++++
5 files changed, 36 insertions(+), 1 deletion(-)
create mode 100644 docs/tools/conf.py
create mode 100644 docs/tools/index.rst
diff --git a/Makefile b/Makefile
index 15f8e53d050..c4c2eba7a7c 100644
--- a/Makefile
+++ b/Makefile
@@ -786,6 +786,7 @@ distclean: clean
$(call clean-manual,interop)
$(call clean-manual,specs)
$(call clean-manual,system)
+ $(call clean-manual,tools)
for d in $(TARGET_DIRS); do \
rm -rf $$d || exit 1 ; \
done
@@ -843,6 +844,7 @@ install-sphinxdocs: sphinxdocs
$(call install-manual,interop)
$(call install-manual,specs)
$(call install-manual,system)
+ $(call install-manual,tools)
install-doc: $(DOCS) install-sphinxdocs
$(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)"
@@ -1036,7 +1038,8 @@ docs/version.texi: $(SRC_PATH)/VERSION config-host.mak
sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html \
$(MANUAL_BUILDDIR)/interop/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
# 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)
$(call build-manual,system,html)
+$(MANUAL_BUILDDIR)/tools/index.html: $(call manual-deps,tools)
+ $(call build-manual,tools,html)
+
$(call define-manpage-rule,interop,\
qemu-ga.8 qemu-img.1 qemu-nbd.8 qemu-trace-stap.1\
virtiofsd.1 virtfs-proxy-helper.1,\
diff --git a/docs/index.html.in b/docs/index.html.in
index 8512933d145..cf61b1cf448 100644
--- a/docs/index.html.in
+++ b/docs/index.html.in
@@ -13,6 +13,7 @@
<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="system/index.html">System Emulation User's Guide</a></li>
+ <li><a href="tools/index.html">Tools Guide</a></li>
</ul>
</body>
</html>
diff --git a/docs/index.rst b/docs/index.rst
index 46405d4f077..acd604fa8a9 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -14,3 +14,4 @@ Welcome to QEMU's documentation!
devel/index
specs/index
system/index
+ tools/index
diff --git a/docs/tools/conf.py b/docs/tools/conf.py
new file mode 100644
index 00000000000..56461110b9d
--- /dev/null
+++ b/docs/tools/conf.py
@@ -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'
diff --git a/docs/tools/index.rst b/docs/tools/index.rst
new file mode 100644
index 00000000000..c5a4a13ec7a
--- /dev/null
+++ b/docs/tools/index.rst
@@ -0,0 +1,11 @@
+.. This is the top level page for the 'tools' manual
+
+
+QEMU Tools Guide
+================
+
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
--
2.20.1
^ permalink raw reply related [flat|nested] 5+ messages in thread
* [PULL 2/3] docs: Move qemu-option-trace.rst.inc to docs/
2020-02-25 11:02 [PULL 0/3] docs queue Peter Maydell
2020-02-25 11:02 ` [PULL 1/3] docs: Create new 'tools' manual Peter Maydell
@ 2020-02-25 11:02 ` Peter Maydell
2020-02-25 11:02 ` [PULL 3/3] docs: Move tools documentation to tools manual Peter Maydell
2020-02-25 12:49 ` [PULL 0/3] docs queue Peter Maydell
3 siblings, 0 replies; 5+ messages in thread
From: Peter Maydell @ 2020-02-25 11:02 UTC (permalink / raw)
To: qemu-devel
The qemu-option-trace.rst.inc file contains a rST documentation
fragment which describes trace options common to qemu-nbd and
qemu-img. We put this file into interop/, but we'd like to move the
qemu-nbd and qemu-img files into the tools/ manual. We could move
the .rst.inc file along with them, but we're eventually going to want
to use it for the main QEMU binary options documentation too, and
that will be in system/. So move qemu-option-trace.rst.inc to the
top-level docs/ directory, where all these files can include it via
.. include:: ../qemu-option-trace.rst.inc
This does have the slight downside that we now need to explicitly
tell Make which manuals use this file rather than relying on
a wildcard for all .rst.inc in the manual.
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-3-peter.maydell@linaro.org
---
Makefile | 5 ++---
docs/interop/qemu-img.rst | 2 +-
docs/interop/qemu-nbd.rst | 2 +-
docs/{interop => }/qemu-option-trace.rst.inc | 0
4 files changed, 4 insertions(+), 5 deletions(-)
rename docs/{interop => }/qemu-option-trace.rst.inc (100%)
diff --git a/Makefile b/Makefile
index c4c2eba7a7c..4a27be1cde9 100644
--- a/Makefile
+++ b/Makefile
@@ -1049,7 +1049,6 @@ sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html \
build-manual = $(call quiet-command,CONFDIR="$(qemu_confdir)" $(SPHINX_BUILD) $(if $(V),,-q) -W -b $2 -D version=$(VERSION) -D release="$(FULL_VERSION)" -d .doctrees/$1-$2 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1 ,"SPHINX","$(MANUAL_BUILDDIR)/$1")
# We assume all RST files in the manual's directory are used in it
manual-deps = $(wildcard $(SRC_PATH)/docs/$1/*.rst) \
- $(wildcard $(SRC_PATH)/docs/$1/*.rst.inc) \
$(SRC_PATH)/docs/$1/conf.py $(SRC_PATH)/docs/conf.py
# Macro to write out the rule and dependencies for building manpages
# Usage: $(call define-manpage-rule,manualname,manpage1 manpage2...[,extradeps])
@@ -1063,7 +1062,7 @@ endef
$(MANUAL_BUILDDIR)/devel/index.html: $(call manual-deps,devel)
$(call build-manual,devel,html)
-$(MANUAL_BUILDDIR)/interop/index.html: $(call manual-deps,interop) $(SRC_PATH)/qemu-img-cmds.hx
+$(MANUAL_BUILDDIR)/interop/index.html: $(call manual-deps,interop) $(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/docs/qemu-option-trace.rst.inc
$(call build-manual,interop,html)
$(MANUAL_BUILDDIR)/specs/index.html: $(call manual-deps,specs)
@@ -1078,7 +1077,7 @@ $(MANUAL_BUILDDIR)/tools/index.html: $(call manual-deps,tools)
$(call define-manpage-rule,interop,\
qemu-ga.8 qemu-img.1 qemu-nbd.8 qemu-trace-stap.1\
virtiofsd.1 virtfs-proxy-helper.1,\
- $(SRC_PATH)/qemu-img-cmds.hx)
+ $(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/docs/qemu-option-trace.rst.inc)
$(call define-manpage-rule,system,qemu-block-drivers.7)
diff --git a/docs/interop/qemu-img.rst b/docs/interop/qemu-img.rst
index 5f40137c100..0080f83a76c 100644
--- a/docs/interop/qemu-img.rst
+++ b/docs/interop/qemu-img.rst
@@ -34,7 +34,7 @@ Standard options:
.. option:: -T, --trace [[enable=]PATTERN][,events=FILE][,file=FILE]
- .. include:: qemu-option-trace.rst.inc
+ .. include:: ../qemu-option-trace.rst.inc
The following commands are supported:
diff --git a/docs/interop/qemu-nbd.rst b/docs/interop/qemu-nbd.rst
index e5484031005..667861cb22e 100644
--- a/docs/interop/qemu-nbd.rst
+++ b/docs/interop/qemu-nbd.rst
@@ -188,7 +188,7 @@ driver options if ``--image-opts`` is specified.
.. option:: -T, --trace [[enable=]PATTERN][,events=FILE][,file=FILE]
- .. include:: qemu-option-trace.rst.inc
+ .. include:: ../qemu-option-trace.rst.inc
Examples
--------
diff --git a/docs/interop/qemu-option-trace.rst.inc b/docs/qemu-option-trace.rst.inc
similarity index 100%
rename from docs/interop/qemu-option-trace.rst.inc
rename to docs/qemu-option-trace.rst.inc
--
2.20.1
^ permalink raw reply related [flat|nested] 5+ messages in thread
* [PULL 3/3] docs: Move tools documentation to tools manual
2020-02-25 11:02 [PULL 0/3] docs queue Peter Maydell
2020-02-25 11:02 ` [PULL 1/3] docs: Create new 'tools' manual Peter Maydell
2020-02-25 11:02 ` [PULL 2/3] docs: Move qemu-option-trace.rst.inc to docs/ Peter Maydell
@ 2020-02-25 11:02 ` Peter Maydell
2020-02-25 12:49 ` [PULL 0/3] docs queue Peter Maydell
3 siblings, 0 replies; 5+ messages in thread
From: Peter Maydell @ 2020-02-25 11:02 UTC (permalink / raw)
To: qemu-devel
Move the following tools documentation files to the new tools manual:
docs/interop/qemu-img.rst
docs/interop/qemu-nbd.rst
docs/interop/virtfs-proxy-helper.rst
docs/interop/qemu-trace-stap.rst
docs/interop/virtiofsd.rst
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-4-peter.maydell@linaro.org
---
Makefile | 34 ++++++++++---------
docs/interop/conf.py | 12 -------
docs/interop/index.rst | 5 ---
docs/tools/conf.py | 17 ++++++++++
docs/tools/index.rst | 6 ++++
docs/{interop => tools}/qemu-img.rst | 0
docs/{interop => tools}/qemu-nbd.rst | 0
docs/{interop => tools}/qemu-trace-stap.rst | 0
.../virtfs-proxy-helper.rst | 0
docs/{interop => tools}/virtiofsd.rst | 0
10 files changed, 41 insertions(+), 33 deletions(-)
rename docs/{interop => tools}/qemu-img.rst (100%)
rename docs/{interop => tools}/qemu-nbd.rst (100%)
rename docs/{interop => tools}/qemu-trace-stap.rst (100%)
rename docs/{interop => tools}/virtfs-proxy-helper.rst (100%)
rename docs/{interop => tools}/virtiofsd.rst (100%)
diff --git a/Makefile b/Makefile
index 4a27be1cde9..aa9cc0b5847 100644
--- a/Makefile
+++ b/Makefile
@@ -345,11 +345,11 @@ endif
ifdef BUILD_DOCS
DOCS=qemu-doc.html qemu-doc.txt qemu.1
-DOCS+=$(MANUAL_BUILDDIR)/interop/qemu-img.1
-DOCS+=$(MANUAL_BUILDDIR)/interop/qemu-nbd.8
+DOCS+=$(MANUAL_BUILDDIR)/tools/qemu-img.1
+DOCS+=$(MANUAL_BUILDDIR)/tools/qemu-nbd.8
DOCS+=$(MANUAL_BUILDDIR)/interop/qemu-ga.8
ifeq ($(CONFIG_LINUX)$(CONFIG_SECCOMP)$(CONFIG_LIBCAP_NG),yyy)
-DOCS+=$(MANUAL_BUILDDIR)/interop/virtiofsd.1
+DOCS+=$(MANUAL_BUILDDIR)/tools/virtiofsd.1
endif
DOCS+=$(MANUAL_BUILDDIR)/system/qemu-block-drivers.7
DOCS+=docs/interop/qemu-qmp-ref.html docs/interop/qemu-qmp-ref.txt docs/interop/qemu-qmp-ref.7
@@ -357,10 +357,10 @@ DOCS+=docs/interop/qemu-ga-ref.html docs/interop/qemu-ga-ref.txt docs/interop/qe
DOCS+=docs/qemu-cpu-models.7
DOCS+=$(MANUAL_BUILDDIR)/index.html
ifdef CONFIG_VIRTFS
-DOCS+=$(MANUAL_BUILDDIR)/interop/virtfs-proxy-helper.1
+DOCS+=$(MANUAL_BUILDDIR)/tools/virtfs-proxy-helper.1
endif
ifdef CONFIG_TRACE_SYSTEMTAP
-DOCS+=$(MANUAL_BUILDDIR)/interop/qemu-trace-stap.1
+DOCS+=$(MANUAL_BUILDDIR)/tools/qemu-trace-stap.1
endif
else
DOCS=
@@ -861,12 +861,12 @@ ifdef CONFIG_POSIX
$(INSTALL_DATA) $(MANUAL_BUILDDIR)/system/qemu-block-drivers.7 "$(DESTDIR)$(mandir)/man7"
$(INSTALL_DATA) docs/qemu-cpu-models.7 "$(DESTDIR)$(mandir)/man7"
ifeq ($(CONFIG_TOOLS),y)
- $(INSTALL_DATA) $(MANUAL_BUILDDIR)/interop/qemu-img.1 "$(DESTDIR)$(mandir)/man1"
+ $(INSTALL_DATA) $(MANUAL_BUILDDIR)/tools/qemu-img.1 "$(DESTDIR)$(mandir)/man1"
$(INSTALL_DIR) "$(DESTDIR)$(mandir)/man8"
- $(INSTALL_DATA) $(MANUAL_BUILDDIR)/interop/qemu-nbd.8 "$(DESTDIR)$(mandir)/man8"
+ $(INSTALL_DATA) $(MANUAL_BUILDDIR)/tools/qemu-nbd.8 "$(DESTDIR)$(mandir)/man8"
endif
ifdef CONFIG_TRACE_SYSTEMTAP
- $(INSTALL_DATA) $(MANUAL_BUILDDIR)/interop/qemu-trace-stap.1 "$(DESTDIR)$(mandir)/man1"
+ $(INSTALL_DATA) $(MANUAL_BUILDDIR)/tools/qemu-trace-stap.1 "$(DESTDIR)$(mandir)/man1"
endif
ifneq (,$(findstring qemu-ga,$(TOOLS)))
$(INSTALL_DATA) $(MANUAL_BUILDDIR)/interop/qemu-ga.8 "$(DESTDIR)$(mandir)/man8"
@@ -877,10 +877,10 @@ endif
endif
ifdef CONFIG_VIRTFS
$(INSTALL_DIR) "$(DESTDIR)$(mandir)/man1"
- $(INSTALL_DATA) $(MANUAL_BUILDDIR)/interop/virtfs-proxy-helper.1 "$(DESTDIR)$(mandir)/man1"
+ $(INSTALL_DATA) $(MANUAL_BUILDDIR)/tools/virtfs-proxy-helper.1 "$(DESTDIR)$(mandir)/man1"
endif
ifeq ($(CONFIG_LINUX)$(CONFIG_SECCOMP)$(CONFIG_LIBCAP_NG),yyy)
- $(INSTALL_DATA) $(MANUAL_BUILDDIR)/interop/virtiofsd.1 "$(DESTDIR)$(mandir)/man1"
+ $(INSTALL_DATA) $(MANUAL_BUILDDIR)/tools/virtiofsd.1 "$(DESTDIR)$(mandir)/man1"
endif
install-datadir:
@@ -1062,7 +1062,7 @@ endef
$(MANUAL_BUILDDIR)/devel/index.html: $(call manual-deps,devel)
$(call build-manual,devel,html)
-$(MANUAL_BUILDDIR)/interop/index.html: $(call manual-deps,interop) $(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/docs/qemu-option-trace.rst.inc
+$(MANUAL_BUILDDIR)/interop/index.html: $(call manual-deps,interop)
$(call build-manual,interop,html)
$(MANUAL_BUILDDIR)/specs/index.html: $(call manual-deps,specs)
@@ -1071,16 +1071,18 @@ $(MANUAL_BUILDDIR)/specs/index.html: $(call manual-deps,specs)
$(MANUAL_BUILDDIR)/system/index.html: $(call manual-deps,system)
$(call build-manual,system,html)
-$(MANUAL_BUILDDIR)/tools/index.html: $(call manual-deps,tools)
+$(MANUAL_BUILDDIR)/tools/index.html: $(call manual-deps,tools) $(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/docs/qemu-option-trace.rst.inc
$(call build-manual,tools,html)
-$(call define-manpage-rule,interop,\
- qemu-ga.8 qemu-img.1 qemu-nbd.8 qemu-trace-stap.1\
- virtiofsd.1 virtfs-proxy-helper.1,\
- $(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/docs/qemu-option-trace.rst.inc)
+$(call define-manpage-rule,interop,qemu-ga.8)
$(call define-manpage-rule,system,qemu-block-drivers.7)
+$(call define-manpage-rule,tools,\
+ qemu-img.1 qemu-nbd.8 qemu-trace-stap.1\
+ virtiofsd.1 virtfs-proxy-helper.1,\
+ $(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/docs/qemu-option-trace.rst.inc)
+
$(MANUAL_BUILDDIR)/index.html: $(SRC_PATH)/docs/index.html.in qemu-version.h
@mkdir -p "$(MANUAL_BUILDDIR)"
$(call quiet-command, sed "s|@@VERSION@@|${VERSION}|g" $< >$@, \
diff --git a/docs/interop/conf.py b/docs/interop/conf.py
index b3cda17042c..42ce7e3d365 100644
--- a/docs/interop/conf.py
+++ b/docs/interop/conf.py
@@ -19,16 +19,4 @@ html_theme_options['description'] = u'System Emulation Management and Interopera
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),
- ('qemu-trace-stap', 'qemu-trace-stap', u'QEMU SystemTap trace tool',
- [], 1),
- ('virtfs-proxy-helper', 'virtfs-proxy-helper',
- u'QEMU 9p virtfs proxy filesystem helper',
- ['M. Mohan Kumar'], 1),
- ('virtiofsd', 'virtiofsd', u'QEMU virtio-fs shared file system daemon',
- ['Stefan Hajnoczi <stefanha@redhat.com>',
- 'Masayoshi Mizuma <m.mizuma@jp.fujitsu.com>'], 1),
]
diff --git a/docs/interop/index.rst b/docs/interop/index.rst
index e8455b4270c..049387ac6de 100644
--- a/docs/interop/index.rst
+++ b/docs/interop/index.rst
@@ -18,10 +18,5 @@ Contents:
live-block-operations
pr-helper
qemu-ga
- qemu-img
- qemu-nbd
- qemu-trace-stap
vhost-user
vhost-user-gpu
- virtfs-proxy-helper
- virtiofsd
diff --git a/docs/tools/conf.py b/docs/tools/conf.py
index 56461110b9d..9052d17d6d4 100644
--- a/docs/tools/conf.py
+++ b/docs/tools/conf.py
@@ -14,3 +14,20 @@ exec(compile(open(parent_config, "rb").read(), parent_config, 'exec'))
# the manual title to appear in the sidebar.
html_theme_options['description'] = \
u'Tools Guide'
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('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),
+ ('qemu-trace-stap', 'qemu-trace-stap', u'QEMU SystemTap trace tool',
+ [], 1),
+ ('virtfs-proxy-helper', 'virtfs-proxy-helper',
+ u'QEMU 9p virtfs proxy filesystem helper',
+ ['M. Mohan Kumar'], 1),
+ ('virtiofsd', 'virtiofsd', u'QEMU virtio-fs shared file system daemon',
+ ['Stefan Hajnoczi <stefanha@redhat.com>',
+ 'Masayoshi Mizuma <m.mizuma@jp.fujitsu.com>'], 1),
+]
diff --git a/docs/tools/index.rst b/docs/tools/index.rst
index c5a4a13ec7a..232ce9f3e46 100644
--- a/docs/tools/index.rst
+++ b/docs/tools/index.rst
@@ -9,3 +9,9 @@ Contents:
.. toctree::
:maxdepth: 2
+
+ qemu-img
+ qemu-nbd
+ qemu-trace-stap
+ virtfs-proxy-helper
+ virtiofsd
diff --git a/docs/interop/qemu-img.rst b/docs/tools/qemu-img.rst
similarity index 100%
rename from docs/interop/qemu-img.rst
rename to docs/tools/qemu-img.rst
diff --git a/docs/interop/qemu-nbd.rst b/docs/tools/qemu-nbd.rst
similarity index 100%
rename from docs/interop/qemu-nbd.rst
rename to docs/tools/qemu-nbd.rst
diff --git a/docs/interop/qemu-trace-stap.rst b/docs/tools/qemu-trace-stap.rst
similarity index 100%
rename from docs/interop/qemu-trace-stap.rst
rename to docs/tools/qemu-trace-stap.rst
diff --git a/docs/interop/virtfs-proxy-helper.rst b/docs/tools/virtfs-proxy-helper.rst
similarity index 100%
rename from docs/interop/virtfs-proxy-helper.rst
rename to docs/tools/virtfs-proxy-helper.rst
diff --git a/docs/interop/virtiofsd.rst b/docs/tools/virtiofsd.rst
similarity index 100%
rename from docs/interop/virtiofsd.rst
rename to docs/tools/virtiofsd.rst
--
2.20.1
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PULL 0/3] docs queue
2020-02-25 11:02 [PULL 0/3] docs queue Peter Maydell
` (2 preceding siblings ...)
2020-02-25 11:02 ` [PULL 3/3] docs: Move tools documentation to tools manual Peter Maydell
@ 2020-02-25 12:49 ` Peter Maydell
3 siblings, 0 replies; 5+ messages in thread
From: Peter Maydell @ 2020-02-25 12:49 UTC (permalink / raw)
To: QEMU Developers
On Tue, 25 Feb 2020 at 11:02, Peter Maydell <peter.maydell@linaro.org> wrote:
>
>
> Just the "create the tools manual" patches; I'd like to
> get this into master because it'll be a dependency for
> some other stuff (even if only textually due to Makefile
> changes).
>
> thanks
> -- PMM
Applied, thanks.
Please update the changelog at https://wiki.qemu.org/ChangeLog/5.0
for any user-visible changes.
-- PMM
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2020-02-25 13:20 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-02-25 11:02 [PULL 0/3] docs queue Peter Maydell
2020-02-25 11:02 ` [PULL 1/3] docs: Create new 'tools' manual Peter Maydell
2020-02-25 11:02 ` [PULL 2/3] docs: Move qemu-option-trace.rst.inc to docs/ Peter Maydell
2020-02-25 11:02 ` [PULL 3/3] docs: Move tools documentation to tools manual Peter Maydell
2020-02-25 12:49 ` [PULL 0/3] docs queue Peter Maydell
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).