From: Thomas Monjalon <thomas.monjalon@6wind.com>
To: John McNamara <john.mcnamara@intel.com>
Cc: dev@dpdk.org, Christian Ehrhardt <christian.ehrhardt@canonical.com>
Subject: [dpdk-dev] [PATCH] doc: move testpmd guide with other tools
Date: Tue, 8 Nov 2016 11:02:38 +0100 [thread overview]
Message-ID: <1478599358-15921-1-git-send-email-thomas.monjalon@6wind.com> (raw)
The guide testpmd_app_ug/ is moved inside the new tools/ guide
as a section.
Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
---
MAINTAINERS | 2 +-
doc/guides/conf.py | 2 +-
doc/guides/contributing/documentation.rst | 1 -
doc/guides/index.rst | 1 -
doc/guides/tools/index.rst | 2 +-
doc/guides/{testpmd_app_ug => tools/testpmd}/build_app.rst | 0
doc/guides/{testpmd_app_ug => tools/testpmd}/index.rst | 4 ++--
doc/guides/{testpmd_app_ug => tools/testpmd}/intro.rst | 0
doc/guides/{testpmd_app_ug => tools/testpmd}/run_app.rst | 0
doc/guides/{testpmd_app_ug => tools/testpmd}/testpmd_funcs.rst | 0
10 files changed, 5 insertions(+), 7 deletions(-)
rename doc/guides/{testpmd_app_ug => tools/testpmd}/build_app.rst (100%)
rename doc/guides/{testpmd_app_ug => tools/testpmd}/index.rst (96%)
rename doc/guides/{testpmd_app_ug => tools/testpmd}/intro.rst (100%)
rename doc/guides/{testpmd_app_ug => tools/testpmd}/run_app.rst (100%)
rename doc/guides/{testpmd_app_ug => tools/testpmd}/testpmd_funcs.rst (100%)
diff --git a/MAINTAINERS b/MAINTAINERS
index ba12d1b..19cd05b 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -614,7 +614,7 @@ F: app/test/virtual_pmd.h
Driver testing tool
M: Pablo de Lara <pablo.de.lara.guarch@intel.com>
F: app/test-pmd/
-F: doc/guides/testpmd_app_ug/
+F: doc/guides/tools/testpmd/
Dump tool
M: Maryam Tahhan <maryam.tahhan@intel.com>
diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index 149bcdb..8619d04 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -106,7 +106,7 @@ class CustomLatexFormatter(LatexFormatter):
PygmentsBridge.latex_formatter = CustomLatexFormatter
# Configuration for man pages
-man_pages = [("testpmd_app_ug/run_app", "testpmd",
+man_pages = [("tools/testpmd/run_app", "testpmd",
"tests for dpdk pmds", "", 1),
("tools/pdump", "dpdk-pdump",
"enable packet capture on dpdk ports", "", 1),
diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst
index 2cfb1a2..03dc59f 100644
--- a/doc/guides/contributing/documentation.rst
+++ b/doc/guides/contributing/documentation.rst
@@ -31,7 +31,6 @@ The main directories that contain files related to documentation are shown below
|-- prog_guide
|-- sample_app_ug
|-- guidelines
- |-- testpmd_app_ug
|-- rel_notes
|-- nics
|-- xen
diff --git a/doc/guides/index.rst b/doc/guides/index.rst
index 57570f6..25f576a 100644
--- a/doc/guides/index.rst
+++ b/doc/guides/index.rst
@@ -42,7 +42,6 @@ DPDK documentation
cryptodevs/index
sample_app_ug/index
tools/index
- testpmd_app_ug/index
faq/index
howto/index
rel_notes/index
diff --git a/doc/guides/tools/index.rst b/doc/guides/tools/index.rst
index cbe98b2..f9aa37d 100644
--- a/doc/guides/tools/index.rst
+++ b/doc/guides/tools/index.rst
@@ -39,4 +39,4 @@ Tool User Guides
pdump
pmdinfo
devbind
-
+ testpmd/index
diff --git a/doc/guides/testpmd_app_ug/build_app.rst b/doc/guides/tools/testpmd/build_app.rst
similarity index 100%
rename from doc/guides/testpmd_app_ug/build_app.rst
rename to doc/guides/tools/testpmd/build_app.rst
diff --git a/doc/guides/testpmd_app_ug/index.rst b/doc/guides/tools/testpmd/index.rst
similarity index 96%
rename from doc/guides/testpmd_app_ug/index.rst
rename to doc/guides/tools/testpmd/index.rst
index 1c39a17..10d2ec0 100644
--- a/doc/guides/testpmd_app_ug/index.rst
+++ b/doc/guides/tools/testpmd/index.rst
@@ -28,8 +28,8 @@
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-Testpmd Application User Guide
-==============================
+testpmd Application
+===================
.. toctree::
:maxdepth: 3
diff --git a/doc/guides/testpmd_app_ug/intro.rst b/doc/guides/tools/testpmd/intro.rst
similarity index 100%
rename from doc/guides/testpmd_app_ug/intro.rst
rename to doc/guides/tools/testpmd/intro.rst
diff --git a/doc/guides/testpmd_app_ug/run_app.rst b/doc/guides/tools/testpmd/run_app.rst
similarity index 100%
rename from doc/guides/testpmd_app_ug/run_app.rst
rename to doc/guides/tools/testpmd/run_app.rst
diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/tools/testpmd/testpmd_funcs.rst
similarity index 100%
rename from doc/guides/testpmd_app_ug/testpmd_funcs.rst
rename to doc/guides/tools/testpmd/testpmd_funcs.rst
--
2.7.0
next reply other threads:[~2016-11-08 10:02 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-11-08 10:02 Thomas Monjalon [this message]
2016-11-10 16:11 ` Mcnamara, John
2016-11-10 23:02 ` Thomas Monjalon
2016-11-10 23:18 ` Wiles, Keith
2016-11-10 23:32 ` Thomas Monjalon
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=1478599358-15921-1-git-send-email-thomas.monjalon@6wind.com \
--to=thomas.monjalon@6wind.com \
--cc=christian.ehrhardt@canonical.com \
--cc=dev@dpdk.org \
--cc=john.mcnamara@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).