]> xenbits.xensource.com Git - people/sstabellini/xen-unstable.git/.git/commitdiff
docs/sphinx: Introduce a hypervisor guide section
authorAndrew Cooper <andrew.cooper3@citrix.com>
Tue, 26 Mar 2019 11:54:32 +0000 (11:54 +0000)
committerAndrew Cooper <andrew.cooper3@citrix.com>
Fri, 5 Apr 2019 17:25:25 +0000 (18:25 +0100)
Include (and retrofit to the user guide) an introductory paragraph describing
the intended audience.

Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
Acked-by: Wei Liu <wei.liu2@citrix.com>
docs/hypervisor-guide/index.rst [new file with mode: 0644]
docs/index.rst

diff --git a/docs/hypervisor-guide/index.rst b/docs/hypervisor-guide/index.rst
new file mode 100644 (file)
index 0000000..3e0cada
--- /dev/null
@@ -0,0 +1,5 @@
+Hypervisor documentation
+========================
+
+.. toctree::
+  :maxdepth: 2
index 50c40c8174eeaa554e0f235809019df090c5bcee..9e2e256a5d67c9d646951a8606ee5b63a3eec208 100644 (file)
@@ -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