d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: move tool guides in their own subdirectory

Browse Source 
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 <christian.ehrhardt@canonical.com>
Acked-by: Luca Boccassi <lboccass@brocade.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
This commit is contained in:
Christian Ehrhardt 2016-08-31 09:50:09 +02:00 committed by Thomas Monjalon
parent bf97a83b13
commit d644886398
6 changed files with 43 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
MAINTAINERS
View File

@ -494,7 +494,7 @@ M: Reshma Pattan <reshma.pattan@intel.com>
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 <maryam.tahhan@intel.com>
M: John McNamara <john.mcnamara@intel.com>
F: app/proc_info/
F: doc/guides/tools/proc_info.rst
Other Example Applications

1
doc/guides/index.rst
View File

@ -41,6 +41,7 @@ DPDK documentation
nics/index
cryptodevs/index
sample_app_ug/index
tools/index
testpmd_app_ug/index
faq/index
howto/index

2
doc/guides/sample_app_ug/index.rst
View File

@ -72,11 +72,9 @@ Sample Applications User Guide
dist_app
vm_power_management
tep_termination
proc_info
ptpclient
performance_thread
ipsec_secgw
pdump
**Figures**

40
doc/guides/tools/index.rst Normal file
View File

@ -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

1
doc/guides/sample_app_ug/pdump.rst → doc/guides/tools/pdump.rst
View File

@ -1,4 +1,3 @@
.. BSD LICENSE
Copyright(c) 2016 Intel Corporation. All rights reserved.
All rights reserved.

1
doc/guides/sample_app_ug/proc_info.rst → doc/guides/tools/proc_info.rst
View File

@ -1,4 +1,3 @@
.. BSD LICENSE
Copyright(c) 2015 Intel Corporation. All rights reserved.
All rights reserved.