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