[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 09/20] docs: Create stub system manual
From: |
Peter Maydell |
Subject: |
[PULL 09/20] docs: Create stub system manual |
Date: |
Thu, 23 Jan 2020 15:30:30 +0000 |
We want a user-facing manual which contains system emulation
documentation. Create an empty one which we can populate.
Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Acked-by: Stefan Hajnoczi <address@hidden>
Message-id: address@hidden
---
Makefile | 10 +++++++++-
docs/index.html.in | 1 +
docs/system/conf.py | 15 +++++++++++++++
docs/system/index.rst | 16 ++++++++++++++++
4 files changed, 41 insertions(+), 1 deletion(-)
create mode 100644 docs/system/conf.py
create mode 100644 docs/system/index.rst
diff --git a/Makefile b/Makefile
index b4a6c28107d..2ab6a17205f 100644
--- a/Makefile
+++ b/Makefile
@@ -757,6 +757,7 @@ distclean: clean
$(call clean-manual,devel)
$(call clean-manual,interop)
$(call clean-manual,specs)
+ $(call clean-manual,system)
for d in $(TARGET_DIRS); do \
rm -rf $$d || exit 1 ; \
done
@@ -813,6 +814,7 @@ endef
install-sphinxdocs: sphinxdocs
$(call install-manual,interop)
$(call install-manual,specs)
+ $(call install-manual,system)
install-doc: $(DOCS) install-sphinxdocs
$(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)"
@@ -1000,7 +1002,10 @@ docs/version.texi: $(SRC_PATH)/VERSION config-host.mak
# and handles "don't rebuild things unless necessary" itself.
# The '.doctrees' files are cached information to speed this up.
.PHONY: sphinxdocs
-sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html
$(MANUAL_BUILDDIR)/interop/index.html $(MANUAL_BUILDDIR)/specs/index.html
+sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html \
+ $(MANUAL_BUILDDIR)/interop/index.html \
+ $(MANUAL_BUILDDIR)/specs/index.html \
+ $(MANUAL_BUILDDIR)/system/index.html
# Canned command to build a single manual
# Arguments: $1 = manual name, $2 = Sphinx builder ('html' or 'man')
@@ -1022,6 +1027,9 @@ $(MANUAL_BUILDDIR)/interop/index.html: $(call
manual-deps,interop)
$(MANUAL_BUILDDIR)/specs/index.html: $(call manual-deps,specs)
$(call build-manual,specs,html)
+$(MANUAL_BUILDDIR)/system/index.html: $(call manual-deps,system)
+ $(call build-manual,system,html)
+
$(MANUAL_BUILDDIR)/interop/qemu-ga.8: $(call manual-deps,interop)
$(call build-manual,interop,man)
diff --git a/docs/index.html.in b/docs/index.html.in
index 94eb782cf7e..8512933d145 100644
--- a/docs/index.html.in
+++ b/docs/index.html.in
@@ -12,6 +12,7 @@
<li><a href="qemu-ga-ref.html">Guest Agent Protocol
Reference</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="system/index.html">System Emulation User's
Guide</a></li>
</ul>
</body>
</html>
diff --git a/docs/system/conf.py b/docs/system/conf.py
new file mode 100644
index 00000000000..6435b4d3f8e
--- /dev/null
+++ b/docs/system/conf.py
@@ -0,0 +1,15 @@
+# -*- coding: utf-8 -*-
+#
+# QEMU documentation build configuration file for the 'system' 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 User''s Guide'
diff --git a/docs/system/index.rst b/docs/system/index.rst
new file mode 100644
index 00000000000..ea8ea5fe3dc
--- /dev/null
+++ b/docs/system/index.rst
@@ -0,0 +1,16 @@
+.. This is the top level page for the 'system' manual.
+
+
+QEMU System Emulation User's Guide
+==================================
+
+This manual is the overall guide for users using QEMU
+for full system emulation (as opposed to user-mode emulation).
+This includes working with hypervisors such as KVM, Xen, Hax
+or Hypervisor.Framework.
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
--
2.20.1
- [PULL 00/20] target-arm queue, Peter Maydell, 2020/01/23
- [PULL 01/20] target/arm: add PMU feature to cortex-r5 and cortex-r5f, Peter Maydell, 2020/01/23
- [PULL 04/20] tests/tcg/aarch64: Add pauth-3, Peter Maydell, 2020/01/23
- [PULL 05/20] tests/tcg/aarch64: Add pauth-4, Peter Maydell, 2020/01/23
- [PULL 07/20] hw/arm: Use helper function to trigger hotplug handler plug, Peter Maydell, 2020/01/23
- [PULL 03/20] tests/tcg/aarch64: Fix compilation parameters for pauth-%, Peter Maydell, 2020/01/23
- [PULL 06/20] hw/acpi: Remove extra indent in ACPI GED hotplug cb, Peter Maydell, 2020/01/23
- [PULL 02/20] target/arm: Fix PAuth sbox functions, Peter Maydell, 2020/01/23
- [PULL 09/20] docs: Create stub system manual,
Peter Maydell <=
- [PULL 08/20] qemu-nbd: Convert invocation documentation to rST, Peter Maydell, 2020/01/23
- [PULL 12/20] hw/misc/stm32f4xx_syscfg: Fix copy/paste error, Peter Maydell, 2020/01/23
- [PULL 14/20] hw/core/or-irq: Increase limit of or-lines to 48, Peter Maydell, 2020/01/23
- [PULL 13/20] dma/pl330: Convert to support tracing, Peter Maydell, 2020/01/23
- [PULL 15/20] hw/arm/exynos4210: Fix DMA initialization, Peter Maydell, 2020/01/23
- [PULL 11/20] target/arm/arch_dump: Add SVE notes, Peter Maydell, 2020/01/23
- [PULL 17/20] hw/char/exynos4210_uart: Implement post_load function, Peter Maydell, 2020/01/23
- [PULL 19/20] hw/char/exynos4210_uart: Add receive DMA support, Peter Maydell, 2020/01/23
- [PULL 20/20] hw/arm/exynos4210: Connect serial port DMA busy signals with pl330, Peter Maydell, 2020/01/23
- [PULL 16/20] hw/char/exynos4210_uart: Convert to support tracing, Peter Maydell, 2020/01/23