1.. SPDX-License-Identifier: CC-BY-4.0
2
3The Xen Hypervisor documentation
4================================
5
6.. note::
7
8   Xen's Sphinx/RST documentation is a work in progress.  The existing
9   documentation can be found at https://xenbits.xen.org/docs/
10
11Xen is an open source, bare metal hypervisor.  It runs as the most privileged
12piece of software on the system, and shares the resources of the hardware
13between virtual machines.  See :doc:`admin-guide/introduction` for an
14introduction to a Xen system.
15
16User documentation
17------------------
18
19This is documentation for an administrator of a Xen system.  It is intended
20for someone who is not necesserily a developer, has installed Xen from their
21preferred distribution, and is attempting to run virtual machines and
22configure the system.
23
24.. toctree::
25   :maxdepth: 2
26
27   admin-guide/index
28
29
30Guest documentation
31-------------------
32
33This documentation concerns the APIs and ABIs available to guests.  It is
34intended for OS developers trying to use a Xen feature, and for Xen developers
35to avoid breaking things.
36
37.. toctree::
38   :maxdepth: 3
39
40   guest-guide/index
41
42
43Hypervisor developer documentation
44----------------------------------
45
46This is documentation for a hypervisor developer.  It is intended for someone
47who is building Xen from source, and is running the new hypervisor in some
48kind of development environment.
49
50.. toctree::
51   :maxdepth: 2
52
53   hypervisor-guide/index
54
55
56Unsorted documents
57------------------
58
59Documents in need of some rearranging.
60
61.. toctree::
62   :maxdepth: 2
63
64   designs/launch/hyperlaunch
65   designs/launch/hyperlaunch-devicetree
66   misc/xen-makefiles/makefiles
67   misra/index
68
69
70Miscellanea
71-----------
72
73.. toctree::
74
75   faq
76   glossary
77