diff mbox

[dpdk-dev,v2,2/3] doc: move Xen guide out of programmers guide

Message ID 1426783711-2407-3-git-send-email-thomas.monjalon@6wind.com (mailing list archive)
State Accepted, archived
Headers show

Commit Message

Thomas Monjalon March 19, 2015, 4:48 p.m. UTC
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%)

Comments

Siobhan Butler March 19, 2015, 6:03 p.m. UTC | #1
> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Thursday, March 19, 2015 4:49 PM
> To: Butler, Siobhan A; Iremonger, Bernard
> Cc: dev@dpdk.org
> Subject: [PATCH v2 2/3] 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 <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

Acked-by Siobhan Butler <siobhan.a.butler@intel.com>
diff mbox

Patch

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