From: Thomas Monjalon <thomas.monjalon@6wind.com>
To: siobhan.a.butler@intel.com, bernard.iremonger@intel.com
Cc: dev@dpdk.org
Subject: [dpdk-dev] [PATCH v2 2/3] doc: move Xen guide out of programmers guide
Date: Thu, 19 Mar 2015 17:48:30 +0100 [thread overview]
Message-ID: <1426783711-2407-3-git-send-email-thomas.monjalon@6wind.com> (raw)
In-Reply-To: <1426783711-2407-1-git-send-email-thomas.monjalon@6wind.com>
Xen is an environment comparable to Linux and FreeBSD which
have their own guide.
Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
---
MAINTAINERS | 2 +-
doc/guides/index.rst | 1 +
doc/guides/prog_guide/index.rst | 1 -
.../img/dpdk_xen_pkt_switch.png | Bin
doc/guides/{prog_guide => xen}/img/grant_refs.png | Bin
doc/guides/{prog_guide => xen}/img/grant_table.png | Bin
doc/guides/{ => xen}/index.rst | 21 +++++++++------------
.../pkt_switch.rst} | 0
8 files changed, 11 insertions(+), 14 deletions(-)
rename doc/guides/{prog_guide => xen}/img/dpdk_xen_pkt_switch.png (100%)
rename doc/guides/{prog_guide => xen}/img/grant_refs.png (100%)
rename doc/guides/{prog_guide => xen}/img/grant_table.png (100%)
copy doc/guides/{ => xen}/index.rst (88%)
rename doc/guides/{prog_guide/intel_dpdk_xen_based_packet_switch_sol.rst => xen/pkt_switch.rst} (100%)
diff --git a/MAINTAINERS b/MAINTAINERS
index bef7f59..24f0a4c 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -132,9 +132,9 @@ F: lib/librte_eal/linuxapp/eal/*xen*
F: lib/librte_eal/linuxapp/eal/include/exec-env/rte_dom0_common.h
F: lib/librte_mempool/rte_dom0_mempool.c
F: lib/librte_pmd_xenvirt/
+F: doc/guides/xen/
F: app/test-pmd/mempool_*
F: examples/vhost_xen/
-F: doc/guides/prog_guide/intel_dpdk_xen_based_packet_switch_sol.rst
FreeBSD EAL (with overlaps)
M: Bruce Richardson <bruce.richardson@intel.com>
diff --git a/doc/guides/index.rst b/doc/guides/index.rst
index c589a30..53f1be1 100644
--- a/doc/guides/index.rst
+++ b/doc/guides/index.rst
@@ -39,6 +39,7 @@ Contents:
linux_gsg/index
freebsd_gsg/index
+ xen/index
prog_guide/index
sample_app_ug/index
testpmd_app_ug/index
diff --git a/doc/guides/prog_guide/index.rst b/doc/guides/prog_guide/index.rst
index 3c17e8d..b263d31 100644
--- a/doc/guides/prog_guide/index.rst
+++ b/doc/guides/prog_guide/index.rst
@@ -53,7 +53,6 @@ Programmer's Guide
ivshmem_lib
poll_mode_drv_emulated_virtio_nic
poll_mode_drv_paravirtual_vmxnets_nic
- intel_dpdk_xen_based_packet_switch_sol
libpcap_ring_based_poll_mode_drv
link_bonding_poll_mode_drv_lib
mlx4_poll_mode_drv
diff --git a/doc/guides/prog_guide/img/dpdk_xen_pkt_switch.png b/doc/guides/xen/img/dpdk_xen_pkt_switch.png
similarity index 100%
rename from doc/guides/prog_guide/img/dpdk_xen_pkt_switch.png
rename to doc/guides/xen/img/dpdk_xen_pkt_switch.png
diff --git a/doc/guides/prog_guide/img/grant_refs.png b/doc/guides/xen/img/grant_refs.png
similarity index 100%
rename from doc/guides/prog_guide/img/grant_refs.png
rename to doc/guides/xen/img/grant_refs.png
diff --git a/doc/guides/prog_guide/img/grant_table.png b/doc/guides/xen/img/grant_table.png
similarity index 100%
rename from doc/guides/prog_guide/img/grant_table.png
rename to doc/guides/xen/img/grant_table.png
diff --git a/doc/guides/index.rst b/doc/guides/xen/index.rst
similarity index 88%
copy from doc/guides/index.rst
copy to doc/guides/xen/index.rst
index c589a30..628ecc3 100644
--- a/doc/guides/index.rst
+++ b/doc/guides/xen/index.rst
@@ -28,18 +28,15 @@
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-DPDK documentation
-==================
+Xen Guide
+=========
-Contents:
+|today|
+
+**Contents**
.. toctree::
- :maxdepth: 1
- :titlesonly:
-
- linux_gsg/index
- freebsd_gsg/index
- prog_guide/index
- sample_app_ug/index
- testpmd_app_ug/index
- rel_notes/index
+ :maxdepth: 2
+ :numbered:
+
+ pkt_switch
diff --git a/doc/guides/prog_guide/intel_dpdk_xen_based_packet_switch_sol.rst b/doc/guides/xen/pkt_switch.rst
similarity index 100%
rename from doc/guides/prog_guide/intel_dpdk_xen_based_packet_switch_sol.rst
rename to doc/guides/xen/pkt_switch.rst
--
2.2.2
next prev parent reply other threads:[~2015-03-19 16:49 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-01-31 23:35 [dpdk-dev] [RFC PATCH 0/4] welcome doc for new nics and environments Thomas Monjalon
2015-01-31 23:35 ` [dpdk-dev] [RFC PATCH 1/4] doc: fix file attributes Thomas Monjalon
2015-01-31 23:35 ` [dpdk-dev] [RFC PATCH 2/4] doc: move Xen guide out of programmers guide Thomas Monjalon
2015-01-31 23:35 ` [dpdk-dev] [RFC PATCH 3/4] doc: nics guide Thomas Monjalon
2015-01-31 23:35 ` [dpdk-dev] [RFC PATCH 4/4] doc: remove copyright footer Thomas Monjalon
[not found] ` <1678582.gq5SofjDC3@xps13>
[not found] ` <8CEF83825BEC744B83065625E567D7C2049DCD83@IRSMSX108.ger.corp.intel.com>
[not found] ` <1500004.RM7mZx5SlJ@xps13>
2015-02-02 17:54 ` [dpdk-dev] [RFC PATCH 3/4] doc: nics guide Iremonger, Bernard
2015-03-19 16:48 ` [dpdk-dev] [PATCH v2 0/3] split programmers guide a bit Thomas Monjalon
2015-03-19 16:48 ` [dpdk-dev] [PATCH v2 1/3] doc: fix file attributes Thomas Monjalon
2015-03-19 18:03 ` Butler, Siobhan A
2015-03-19 16:48 ` Thomas Monjalon [this message]
2015-03-19 18:03 ` [dpdk-dev] [PATCH v2 2/3] doc: move Xen guide out of programmers guide Butler, Siobhan A
2015-03-19 16:48 ` [dpdk-dev] [PATCH v2 3/3] doc: nics guide Thomas Monjalon
2015-03-19 17:36 ` Iremonger, Bernard
2015-03-19 18:02 ` Butler, Siobhan A
2015-03-30 23:38 ` [dpdk-dev] [PATCH v2 0/3] split programmers guide a bit Thomas Monjalon
2015-03-31 11:34 ` Mcnamara, John
2015-03-31 12:23 ` Thomas Monjalon
2015-04-01 9:19 ` Iremonger, Bernard
2015-04-01 16:36 ` Mcnamara, John
2015-04-01 17:20 ` Iremonger, Bernard
2015-04-02 7:59 ` Mcnamara, John
2015-04-02 11:04 ` [dpdk-dev] [RFC] doc: refactored figure numbers into references John McNamara
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=1426783711-2407-3-git-send-email-thomas.monjalon@6wind.com \
--to=thomas.monjalon@6wind.com \
--cc=bernard.iremonger@intel.com \
--cc=dev@dpdk.org \
--cc=siobhan.a.butler@intel.com \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).