aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/index.html.in1
-rw-r--r--docs/index.rst1
-rw-r--r--docs/interop/conf.py12
-rw-r--r--docs/interop/index.rst5
-rw-r--r--docs/qemu-option-trace.rst.inc (renamed from docs/interop/qemu-option-trace.rst.inc)0
-rw-r--r--docs/tools/conf.py33
-rw-r--r--docs/tools/index.rst17
-rw-r--r--docs/tools/qemu-img.rst (renamed from docs/interop/qemu-img.rst)2
-rw-r--r--docs/tools/qemu-nbd.rst (renamed from docs/interop/qemu-nbd.rst)2
-rw-r--r--docs/tools/qemu-trace-stap.rst (renamed from docs/interop/qemu-trace-stap.rst)0
-rw-r--r--docs/tools/virtfs-proxy-helper.rst (renamed from docs/interop/virtfs-proxy-helper.rst)0
-rw-r--r--docs/tools/virtiofsd.rst (renamed from docs/interop/virtiofsd.rst)0
12 files changed, 54 insertions, 19 deletions
diff --git a/docs/index.html.in b/docs/index.html.in
index 8512933d14..cf61b1cf44 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 46405d4f07..acd604fa8a 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/interop/conf.py b/docs/interop/conf.py
index b3cda17042..42ce7e3d36 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 e8455b4270..049387ac6d 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/interop/qemu-option-trace.rst.inc b/docs/qemu-option-trace.rst.inc
index 23cfcb4853..23cfcb4853 100644
--- a/docs/interop/qemu-option-trace.rst.inc
+++ b/docs/qemu-option-trace.rst.inc
diff --git a/docs/tools/conf.py b/docs/tools/conf.py
new file mode 100644
index 0000000000..9052d17d6d
--- /dev/null
+++ b/docs/tools/conf.py
@@ -0,0 +1,33 @@
+# -*- 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'
+
+# 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
new file mode 100644
index 0000000000..232ce9f3e4
--- /dev/null
+++ b/docs/tools/index.rst
@@ -0,0 +1,17 @@
+.. This is the top level page for the 'tools' manual
+
+
+QEMU Tools Guide
+================
+
+
+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
index 5f40137c10..0080f83a76 100644
--- a/docs/interop/qemu-img.rst
+++ b/docs/tools/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/tools/qemu-nbd.rst
index e548403100..667861cb22 100644
--- a/docs/interop/qemu-nbd.rst
+++ b/docs/tools/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-trace-stap.rst b/docs/tools/qemu-trace-stap.rst
index fb70445c75..fb70445c75 100644
--- a/docs/interop/qemu-trace-stap.rst
+++ b/docs/tools/qemu-trace-stap.rst
diff --git a/docs/interop/virtfs-proxy-helper.rst b/docs/tools/virtfs-proxy-helper.rst
index 6cdeedf8e9..6cdeedf8e9 100644
--- a/docs/interop/virtfs-proxy-helper.rst
+++ b/docs/tools/virtfs-proxy-helper.rst
diff --git a/docs/interop/virtiofsd.rst b/docs/tools/virtiofsd.rst
index 378594c422..378594c422 100644
--- a/docs/interop/virtiofsd.rst
+++ b/docs/tools/virtiofsd.rst