|
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [PATCH] docs: Hypervisor-Guide: Move Hyperlaunch design docs as needed
In the Sphinx documentation, the Hyperlaunch Design Documents were stated
as needing rearranging:
They were put into the section that needs rearranging, so rearrange
them as indicated inside the Hypervisor Guide which aims to describe
the hypervisor for developers and people interested in the hypervisor.
This also fixes the glitch where the "1 Hypervisor Design Document" was
listed in the main menu sidebar and helps to clean up the main menu.
Signed-off-by: Bernhard Kaindl <bernhard.kaindl@xxxxxxxxxx>
---
docs/designs/index.rst | 15 +++++++++++++++
docs/designs/launch/hyperlaunch.rst | 4 ++--
docs/designs/launch/index.rst | 10 ++++++++++
docs/hypervisor-guide/index.rst | 12 ++++++++++--
docs/index.rst | 2 --
5 files changed, 37 insertions(+), 6 deletions(-)
create mode 100644 docs/designs/index.rst
create mode 100644 docs/designs/launch/index.rst
diff --git a/docs/designs/index.rst b/docs/designs/index.rst
new file mode 100644
index 000000000000..ded12082c622
--- /dev/null
+++ b/docs/designs/index.rst
@@ -0,0 +1,15 @@
+.. SPDX-License-Identifier: CC-BY-4.0
+
+Design documents
+================
+
+Design documents and implementation details for the Xen hypervisor.
+
+These are intended for developers working on the Xen hypervisor,
+and for those interested in the internal workings of Xen.
+
+.. toctree::
+ :maxdepth: 2
+ :numbered: 4
+
+ launch/index
diff --git a/docs/designs/launch/hyperlaunch.rst
b/docs/designs/launch/hyperlaunch.rst
index 3bed36f97637..aa7c2798a380 100644
--- a/docs/designs/launch/hyperlaunch.rst
+++ b/docs/designs/launch/hyperlaunch.rst
@@ -2,8 +2,6 @@
Hyperlaunch Design Document
###########################
-.. sectnum:: :depth: 4
-
This post is a Request for Comment on the included v4 of a design document that
describes Hyperlaunch: a new method of launching the Xen hypervisor, relating
to dom0less and work from the Hyperlaunch project. We invite discussion of this
@@ -13,6 +11,8 @@ Xen Development mailing list.
.. contents:: :depth: 3
+ :backlinks: entry
+ :local:
Introduction
diff --git a/docs/designs/launch/index.rst b/docs/designs/launch/index.rst
new file mode 100644
index 000000000000..afd845296d30
--- /dev/null
+++ b/docs/designs/launch/index.rst
@@ -0,0 +1,10 @@
+.. SPDX-License-Identifier: CC-BY-4.0
+
+Hyperlaunch
+===========
+
+.. toctree::
+ :maxdepth: 2
+
+ hyperlaunch
+ hyperlaunch-devicetree
diff --git a/docs/hypervisor-guide/index.rst b/docs/hypervisor-guide/index.rst
index 520fe01554ab..9c8033305549 100644
--- a/docs/hypervisor-guide/index.rst
+++ b/docs/hypervisor-guide/index.rst
@@ -1,11 +1,19 @@
.. SPDX-License-Identifier: CC-BY-4.0
-Hypervisor documentation
-========================
+Hypervisor Guide
+================
+
+The Hypervisor Guide provides an overview of the Xen hypervisor's
+architecture and design, covering its core components, features,
+and how it manages resources for :term:`guest` domains.
+
+It serves as a comprehensive reference for developers and users interested
+in understanding the inner workings of the Xen hypervisor.
.. toctree::
:maxdepth: 2
+ ../designs/index
code-coverage
x86/index
diff --git a/docs/index.rst b/docs/index.rst
index bd87d736b9c3..6b04a077cebd 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -62,8 +62,6 @@ Documents in need of some rearranging.
.. toctree::
:maxdepth: 2
- designs/launch/hyperlaunch
- designs/launch/hyperlaunch-devicetree
misc/xen-makefiles/makefiles
misra/index
fusa/index
--
2.39.5
|
![]() |
Lists.xenproject.org is hosted with RackSpace, monitoring our |