From d644886398749aa551b8704a6aa9aba394d570ca Mon Sep 17 00:00:00 2001 From: Christian Ehrhardt Date: Wed, 31 Aug 2016 09:50:09 +0200 Subject: [PATCH 1/1] doc: move tool guides in their own subdirectory This is to clarify the scope of these documents that are more tools than sample applications. Also this is a preparation step to add more tools and generate man pages off of their rst files. Signed-off-by: Christian Ehrhardt Acked-by: Luca Boccassi Acked-by: John McNamara --- MAINTAINERS | 3 +- doc/guides/index.rst | 1 + doc/guides/sample_app_ug/index.rst | 2 - doc/guides/tools/index.rst | 40 +++++++++++++++++++ doc/guides/{sample_app_ug => tools}/pdump.rst | 1 - .../{sample_app_ug => tools}/proc_info.rst | 1 - 6 files changed, 43 insertions(+), 5 deletions(-) create mode 100644 doc/guides/tools/index.rst rename doc/guides/{sample_app_ug => tools}/pdump.rst (99%) rename doc/guides/{sample_app_ug => tools}/proc_info.rst (99%) diff --git a/MAINTAINERS b/MAINTAINERS index ccba4c9780..bc37294f5f 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -494,7 +494,7 @@ M: Reshma Pattan F: lib/librte_pdump/ F: doc/guides/prog_guide/pdump_lib.rst F: app/pdump/ -F: doc/guides/sample_app_ug/pdump.rst +F: doc/guides/tools/pdump.rst Packet Framework @@ -618,6 +618,7 @@ Dump tool M: Maryam Tahhan M: John McNamara F: app/proc_info/ +F: doc/guides/tools/proc_info.rst Other Example Applications diff --git a/doc/guides/index.rst b/doc/guides/index.rst index 0441859971..57570f6d63 100644 --- a/doc/guides/index.rst +++ b/doc/guides/index.rst @@ -41,6 +41,7 @@ DPDK documentation nics/index cryptodevs/index sample_app_ug/index + tools/index testpmd_app_ug/index faq/index howto/index diff --git a/doc/guides/sample_app_ug/index.rst b/doc/guides/sample_app_ug/index.rst index 96bb317902..65734526bf 100644 --- a/doc/guides/sample_app_ug/index.rst +++ b/doc/guides/sample_app_ug/index.rst @@ -72,11 +72,9 @@ Sample Applications User Guide dist_app vm_power_management tep_termination - proc_info ptpclient performance_thread ipsec_secgw - pdump **Figures** diff --git a/doc/guides/tools/index.rst b/doc/guides/tools/index.rst new file mode 100644 index 0000000000..d7654a23d4 --- /dev/null +++ b/doc/guides/tools/index.rst @@ -0,0 +1,40 @@ +.. BSD LICENSE + Copyright(c) 2016 Canonical Limited. 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. + +Tool User Guides +================ + +.. toctree:: + :maxdepth: 2 + :numbered: + + proc_info + pdump + diff --git a/doc/guides/sample_app_ug/pdump.rst b/doc/guides/tools/pdump.rst similarity index 99% rename from doc/guides/sample_app_ug/pdump.rst rename to doc/guides/tools/pdump.rst index 099e7dc08b..57097e4353 100644 --- a/doc/guides/sample_app_ug/pdump.rst +++ b/doc/guides/tools/pdump.rst @@ -1,4 +1,3 @@ - .. BSD LICENSE Copyright(c) 2016 Intel Corporation. All rights reserved. All rights reserved. diff --git a/doc/guides/sample_app_ug/proc_info.rst b/doc/guides/tools/proc_info.rst similarity index 99% rename from doc/guides/sample_app_ug/proc_info.rst rename to doc/guides/tools/proc_info.rst index 73f219580e..baaf977f11 100644 --- a/doc/guides/sample_app_ug/proc_info.rst +++ b/doc/guides/tools/proc_info.rst @@ -1,4 +1,3 @@ - .. BSD LICENSE Copyright(c) 2015 Intel Corporation. All rights reserved. All rights reserved. -- 2.20.1