mirror of
https://github.com/xen-project/xen.git
synced 2026-10-28 02:01:24 +01:00
Andrew Cooper
509f737d3e
sphinx-build reports:
docs/designs/launch/hyperlaunch.rst: WARNING: document isn't included in any toctree
docs/designs/launch/hyperlaunch-devicetree.rst: WARNING: document isn't included in any toctree
docs/misc/xen-makefiles/makefiles.rst: WARNING: document isn't included in any toctree
docs/misra/C-language-toolchain.rst: WARNING: document isn't included in any toctree
docs/misra/C-runtime-failures.rst: WARNING: document isn't included in any toctree
docs/misra/documenting-violations.rst: WARNING: document isn't included in any toctree
docs/misra/exclude-list.rst: WARNING: document isn't included in any toctree
docs/misra/xen-static-analysis.rst: WARNING: document isn't included in any toctree
Create an up-to-date index.rst in misra/ create an "unsorted docs" section at
the top level to contain everything else. They can be re-filed at a later
date.
Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
Acked-by: Stefano Stabellini <sstabellini@kernel.org>
Release-acked-by: Henry Wang <Henry.Wang@arm.com>
(cherry picked from commit fb41228ece)
76 lines
1.7 KiB
ReStructuredText
76 lines
1.7 KiB
ReStructuredText
.. SPDX-License-Identifier: CC-BY-4.0
|
|
|
|
The Xen Hypervisor documentation
|
|
================================
|
|
|
|
.. note::
|
|
|
|
Xen's Sphinx/RST documentation is a work in progress. The existing
|
|
documentation can be found at https://xenbits.xen.org/docs/
|
|
|
|
Xen is an open source, bare metal hypervisor. It runs as the most privileged
|
|
piece of software on the system, and shares the resources of the hardware
|
|
between virtual machines. See :doc:`admin-guide/introduction` for an
|
|
introduction to a Xen system.
|
|
|
|
User documentation
|
|
------------------
|
|
|
|
This is documentation for an administrator of a Xen system. It is intended
|
|
for someone who is not necesserily a developer, has installed Xen from their
|
|
preferred distribution, and is attempting to run virtual machines and
|
|
configure the system.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
admin-guide/index
|
|
|
|
|
|
Guest documentation
|
|
-------------------
|
|
|
|
This documentation concerns the APIs and ABIs available to guests. It is
|
|
intended for OS developers trying to use a Xen feature, and for Xen developers
|
|
to avoid breaking things.
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
guest-guide/index
|
|
|
|
|
|
Hypervisor developer documentation
|
|
----------------------------------
|
|
|
|
This is documentation for a hypervisor developer. It is intended for someone
|
|
who is building Xen from source, and is running the new hypervisor in some
|
|
kind of development environment.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
hypervisor-guide/index
|
|
|
|
|
|
Unsorted documents
|
|
------------------
|
|
|
|
Documents in need of some rearranging.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
designs/launch/hyperlaunch
|
|
designs/launch/hyperlaunch-devicetree
|
|
misc/xen-makefiles/makefiles
|
|
misra/index
|
|
|
|
|
|
Miscellanea
|
|
-----------
|
|
|
|
.. toctree::
|
|
|
|
glossary
|