From: Andrew Cooper <andrew.cooper3@citrix.com>
To: Xen-devel <xen-devel@lists.xen.org>
Cc: Stefano Stabellini <sstabellini@kernel.org>,
Wei Liu <wei.liu2@citrix.com>,
Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>,
George Dunlap <George.Dunlap@eu.citrix.com>,
Andrew Cooper <andrew.cooper3@citrix.com>,
Tim Deegan <tim@xen.org>, Julien Grall <julien.grall@arm.com>,
Jan Beulich <JBeulich@suse.com>,
Ian Jackson <ian.jackson@citrix.com>
Subject: [PATCH 1/2] docs/sphinx: Introduce a hypervisor guide section
Date: Wed, 3 Apr 2019 15:59:59 +0100 [thread overview]
Message-ID: <1554303600-27933-2-git-send-email-andrew.cooper3@citrix.com> (raw)
In-Reply-To: <1554303600-27933-1-git-send-email-andrew.cooper3@citrix.com>
Include (and retrofit to the user guide) an introductory paragraph describing
the intended audience.
Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
---
CC: George Dunlap <George.Dunlap@eu.citrix.com>
CC: Ian Jackson <ian.jackson@citrix.com>
CC: Jan Beulich <JBeulich@suse.com>
CC: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
CC: Stefano Stabellini <sstabellini@kernel.org>
CC: Tim Deegan <tim@xen.org>
CC: Wei Liu <wei.liu2@citrix.com>
CC: Julien Grall <julien.grall@arm.com>
---
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@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel
next prev parent reply other threads:[~2019-04-03 14:59 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-03 14:59 [PATCH 0/2] docs: Improve coverage docs Andrew Cooper
2019-04-03 14:59 ` Andrew Cooper [this message]
2019-04-04 12:10 ` [PATCH 1/2] docs/sphinx: Introduce a hypervisor guide section Wei Liu
2019-04-03 15:00 ` [PATCH 2/2] docs/hypervisor-guide: Code Coverage Andrew Cooper
2019-04-04 12:07 ` Artem Mygaiev
2019-04-04 12:29 ` Julien Grall
2019-04-04 12:46 ` Andrew Cooper
2019-04-04 13:26 ` Julien Grall
2019-04-04 12:10 ` Wei Liu
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1554303600-27933-2-git-send-email-andrew.cooper3@citrix.com \
--to=andrew.cooper3@citrix.com \
--cc=George.Dunlap@eu.citrix.com \
--cc=JBeulich@suse.com \
--cc=ian.jackson@citrix.com \
--cc=julien.grall@arm.com \
--cc=konrad.wilk@oracle.com \
--cc=sstabellini@kernel.org \
--cc=tim@xen.org \
--cc=wei.liu2@citrix.com \
--cc=xen-devel@lists.xen.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.