|
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [PATCH 1/3] Sphinx docs: Rearrange the design docs into a new dedicated design index
The Hyperlaunch Design Documents were stated as needing rearranging. Rearrange them inside the Hypervisor Guide and fix the bug where one got the title "1 Hypervisor Design Document". This also serves as first small step to clean up the main menu of the Sphinx documentation. Signed-off-by: Bernhard Kaindl <bernhard.kaindl@xxxxxxxxxx> --- Preview of the improved menu structure for design documents: https://xen.kaindl.dev/arrange-hyperlaunch-design/ --- docs/{misc => designs}/cache-coloring.rst | 4 ++-- docs/designs/index.rst | 16 ++++++++++++++++ docs/designs/launch/hyperlaunch.rst | 4 ++-- docs/designs/launch/index.rst | 10 ++++++++++ docs/hypervisor-guide/index.rst | 12 ++++++++++-- docs/index.rst | 2 -- 6 files changed, 40 insertions(+), 8 deletions(-) rename docs/{misc => designs}/cache-coloring.rst (99%) create mode 100644 docs/designs/index.rst create mode 100644 docs/designs/launch/index.rst diff --git a/docs/misc/cache-coloring.rst b/docs/designs/cache-coloring.rst similarity index 99% rename from docs/misc/cache-coloring.rst rename to docs/designs/cache-coloring.rst index e156062aa207..0c078e29463e 100644 --- a/docs/misc/cache-coloring.rst +++ b/docs/designs/cache-coloring.rst @@ -1,7 +1,7 @@ .. SPDX-License-Identifier: CC-BY-4.0 -Xen cache coloring user guide -============================= +Cache Coloring +============== The cache coloring support in Xen allows to reserve Last Level Cache (LLC) partitions for Dom0, DomUs and Xen itself. Currently only ARM64 is supported. diff --git a/docs/designs/index.rst b/docs/designs/index.rst new file mode 100644 index 000000000000..54d45c2bc321 --- /dev/null +++ b/docs/designs/index.rst @@ -0,0 +1,16 @@ +.. 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 + cache-coloring 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 |