blob: 82881e3d219bbdb6b9414c0e31e6dc23c769cd25 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
% Template for feature documents
% Revision $N
\clearpage
This is a suggested template for formatting of a Xen feature document in
tree.
The purpose of this document is to provide a concrete support statement
for the feature (indicating its security status), as well as brief user
and technical documentation.
# Basics
A table with an overview of the support status and applicability.
---------------- ----------------------------------------------------
Status: e.g. **Supported**/**Tech Preview**/**Experimental**
Architecture(s): e.g. x86, arm
Component(s): e.g. Hypervisor, toolstack, guest
Hardware: _where applicable_
---------------- ----------------------------------------------------
# Overview
A short description the feature, similar to an abstract for a
paper/presentation.
# User details
Information for a user attempting to use the feature. Should include
how to enable the feature (is it enabled by default? If not, how to turn
it on?), and how to interact with the feature (typically via `xl`).
# Technical details
Information for a developer or power user. Should include where to look
in-tree for detailed documents and code.
# Limitations
Information concerning incompatibilities with other features or hardware
combinations.
# Testing
Information concerning how to properly test changes affecting this feature.
# Areas for improvement
List of enhancements which could be undertaken, e.g. to improve the
feature itself, or improve interaction with other features.
# Known issues
List of known issues or bugs. For tech preview or experimental
features, this section must contain the list of items needing fixing for
its status to be upgraded.
# References
Relevant external references for this feature.
# History
A table of changes to the document, in chronological order.
------------------------------------------------------------------------
Date Revision Version Notes
---------- -------- -------- -------------------------------------------
YYYY-MM-DD N Xen X.Y ...
---------- -------- -------- -------------------------------------------
|
