mirror of
https://github.com/xen-project/xen.git
synced 2026-10-28 02:01:24 +01:00
Stefano Stabellini
4b08435f58
Introduce a list of MISRA C rules that apply to the Xen hypervisor. The list is in RST format. Specify that rules deviations need to be documented. Introduce a documentation tag for in-code comments to mark them as deviations. Also mention that other documentation mechanisms are work-in-progress. Add a mention of the new list to CODING_STYLE. Signed-off-by: Stefano Stabellini <stefano.stabellini@xilinx.com> Signed-off-by: Bertrand Marquis <bertrand.marquis@arm.com> Acked-by: Julien Grall <jgrall@amazon.com>
74 lines
1.6 KiB
ReStructuredText
74 lines
1.6 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
|
|
|
|
|
|
MISRA C coding guidelines
|
|
-------------------------
|
|
|
|
MISRA C rules and directive to be used as coding guidelines when writing
|
|
Xen hypervisor code.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
misra/rules
|
|
|
|
|
|
Miscellanea
|
|
-----------
|
|
|
|
.. toctree::
|
|
|
|
glossary
|