From 08558763b72915313738a273b164f0156b59f838 Mon Sep 17 00:00:00 2001 From: Thomas Monjalon Date: Fri, 30 Jan 2015 23:47:18 +0100 Subject: [PATCH] doc: move Xen guide out of programmers guide Xen is an environment comparable to Linux and FreeBSD which have their own guide. Signed-off-by: Thomas Monjalon Acked-by: Siobhan Butler --- MAINTAINERS | 2 +- doc/guides/index.rst | 1 + doc/guides/prog_guide/index.rst | 1 - .../img/dpdk_xen_pkt_switch.png | Bin .../{prog_guide => xen}/img/grant_refs.png | Bin .../{prog_guide => xen}/img/grant_table.png | Bin doc/guides/xen/index.rst | 42 ++++++++++++++++++ .../pkt_switch.rst} | 0 8 files changed, 44 insertions(+), 2 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%) create mode 100644 doc/guides/xen/index.rst 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 657002de5f..7b67c5bdbf 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 diff --git a/doc/guides/index.rst b/doc/guides/index.rst index c589a30409..53f1be1e38 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 3c17e8db77..b263d318e0 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/xen/index.rst b/doc/guides/xen/index.rst new file mode 100644 index 0000000000..628ecc3856 --- /dev/null +++ b/doc/guides/xen/index.rst @@ -0,0 +1,42 @@ +.. BSD LICENSE + Copyright(c) 2010-2014 Intel Corporation. All rights reserved. + All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + * Neither the name of Intel Corporation nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +Xen Guide +========= + +|today| + +**Contents** + +.. toctree:: + :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.20.1