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

[Xen-changelog] [xen staging] docs/sphinx: Introduce a hypervisor guide section



commit b05c8fe1a69fd4ca99ecc3b381c33dda7b44379e
Author:     Andrew Cooper <andrew.cooper3@xxxxxxxxxx>
AuthorDate: Tue Mar 26 11:54:32 2019 +0000
Commit:     Andrew Cooper <andrew.cooper3@xxxxxxxxxx>
CommitDate: Fri Apr 5 18:25:25 2019 +0100

    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>
    Acked-by: Wei Liu <wei.liu2@xxxxxxxxxx>
---
 docs/hypervisor-guide/index.rst |  5 +++++
 docs/index.rst                  | 18 ++++++++++++++++++
 2 files changed, 23 insertions(+)

diff --git a/docs/hypervisor-guide/index.rst b/docs/hypervisor-guide/index.rst
new file mode 100644
index 0000000000..3e0cada37d
--- /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 50c40c8174..9e2e256a5d 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
--
generated by git-patchbot for /home/xen/git/xen.git#staging

_______________________________________________
Xen-changelog mailing list
Xen-changelog@xxxxxxxxxxxxxxxxxxxx
https://lists.xenproject.org/xen-changelog

 


Rackspace

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