[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Xen-devel] [PATCH 1/2] docs/sphinx: Introduce a hypervisor guide section



Include (and retrofit to the user guide) an introductory paragraph describing
the intended audience.

Signed-off-by: Andrew Cooper <andrew.cooper3@xxxxxxxxxx>
---
CC: George Dunlap <George.Dunlap@xxxxxxxxxxxxx>
CC: Ian Jackson <ian.jackson@xxxxxxxxxx>
CC: Jan Beulich <JBeulich@xxxxxxxx>
CC: Konrad Rzeszutek Wilk <konrad.wilk@xxxxxxxxxx>
CC: Stefano Stabellini <sstabellini@xxxxxxxxxx>
CC: Tim Deegan <tim@xxxxxxx>
CC: Wei Liu <wei.liu2@xxxxxxxxxx>
CC: Julien Grall <julien.grall@xxxxxxx>
---
 docs/hypervisor-guide/index.rst |  5 +++++
 docs/index.rst                  | 18 ++++++++++++++++++
 2 files changed, 23 insertions(+)
 create mode 100644 docs/hypervisor-guide/index.rst

diff --git a/docs/hypervisor-guide/index.rst b/docs/hypervisor-guide/index.rst
new file mode 100644
index 0000000..3e0cada
--- /dev/null
+++ b/docs/hypervisor-guide/index.rst
@@ -0,0 +1,5 @@
+Hypervisor documentation
+========================
+
+.. toctree::
+  :maxdepth: 2
diff --git a/docs/index.rst b/docs/index.rst
index 50c40c8..9e2e256 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -10,7 +10,25 @@ The Xen Hypervisor documentation
 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
+
+
+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
-- 
2.1.4


_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxxxxxxxxx
https://lists.xenproject.org/mailman/listinfo/xen-devel

 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.