[dpdk-dev] [PATCH] doc: move testpmd guide with other tools

[dpdk-dev] [PATCH] doc: move testpmd guide with other tools

[Thomas Monjalon]

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

Re: [dpdk-dev] [PATCH] doc: move testpmd guide with other tools

[Mcnamara, John]

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Tuesday, November 8, 2016 10:03 AM
> To: Mcnamara, John <john.mcnamara@intel.com>
> Cc: dev@dpdk.org; Christian Ehrhardt <christian.ehrhardt@canonical.com>
> Subject: [PATCH] doc: move testpmd guide with other tools
> 
> 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%)

Hi,

I had a look at the html output before and after this patch and I don't quite agree with it. I see that you are trying to clean up and make the documentation more consistent but I don't know if this is the right way to do it.

The problem is that TestPMD is a bit of an outlier. It isn't a sample application and it isn't really a test application despite the name (it is more of a tester application). Also I don't think that it is a tool/utility like the other apps in the target directory (if it is seen as a tool then it should be renamed to something like dpdk-tester for consistency). Testpmd also has quite a lot of documentation, more than any of our other apps or utilities, which again makes it an outlier.

So my preference is to leave TestPMD in the high level index.

However, I do think the High level index should be cleaned up a bit and the items re-ordered into a more logical sequence. I'll submit a patch for that.

John

Re: [dpdk-dev] [PATCH] doc: move testpmd guide with other tools

[Thomas Monjalon]

2016-11-10 16:11, Mcnamara, John:
> I had a look at the html output before and after this patch and I don't quite agree with it. I see that you are trying to clean up and make the documentation more consistent but I don't know if this is the right way to do it.
> 
> The problem is that TestPMD is a bit of an outlier. It isn't a sample application and it isn't really a test application despite the name (it is more of a tester application). Also I don't think that it is a tool/utility like the other apps in the target directory (if it is seen as a tool then it should be renamed to something like dpdk-tester for consistency). Testpmd also has quite a lot of documentation, more than any of our other apps or utilities, which again makes it an outlier.

Yes testpmd is not the same kind of tool as others. It helps for tests,
debugging and demos.

About the name, as it is packaged as part of the runtime, I think we should
find a better name. As you said it should start with "dpdk-" and it should
contain "net" as it does not test the crypto drivers.
Something like dpdk-testpmd-net.

> So my preference is to leave TestPMD in the high level index.

OK I understand your opinion.

> However, I do think the High level index should be cleaned up a bit and the items re-ordered into a more logical sequence. I'll submit a patch for that.

OK thanks

Re: [dpdk-dev] [PATCH] doc: move testpmd guide with other tools

[Wiles, Keith]

> On Nov 10, 2016, at 5:02 PM, Thomas Monjalon <thomas.monjalon@6wind.com> wrote:
> 
> 2016-11-10 16:11, Mcnamara, John:
>> I had a look at the html output before and after this patch and I don't quite agree with it. I see that you are trying to clean up and make the documentation more consistent but I don't know if this is the right way to do it.
>> 
>> The problem is that TestPMD is a bit of an outlier. It isn't a sample application and it isn't really a test application despite the name (it is more of a tester application). Also I don't think that it is a tool/utility like the other apps in the target directory (if it is seen as a tool then it should be renamed to something like dpdk-tester for consistency). Testpmd also has quite a lot of documentation, more than any of our other apps or utilities, which again makes it an outlier.
> 
> Yes testpmd is not the same kind of tool as others. It helps for tests,
> debugging and demos.
> 
> About the name, as it is packaged as part of the runtime, I think we should
> find a better name. As you said it should start with "dpdk-" and it should
> contain "net" as it does not test the crypto drivers.
> Something like dpdk-testpmd-net.

To me the name dpdk-testpmd-net is a bit long and does testpmd really just test PMDs. I was thinking of the name dpdk-tester is really pretty short and descriptive IMO. Adding net or pmd to the name does not really add anything as dpdk is kind of networking. Just my $0.04 worth. 

> 
>> So my preference is to leave TestPMD in the high level index.
> 
> OK I understand your opinion.
> 
>> However, I do think the High level index should be cleaned up a bit and the items re-ordered into a more logical sequence. I'll submit a patch for that.
> 
> OK thanks

Regards,
Keith

Re: [dpdk-dev] [PATCH] doc: move testpmd guide with other tools

[Thomas Monjalon]

2016-11-10 23:18, Wiles, Keith:
> > On Nov 10, 2016, at 5:02 PM, Thomas Monjalon <thomas.monjalon@6wind.com> wrote:
> > 2016-11-10 16:11, Mcnamara, John:
> >> The problem is that TestPMD is a bit of an outlier. It isn't a sample application and it isn't really a test application despite the name (it is more of a tester application). Also I don't think that it is a tool/utility like the other apps in the target directory (if it is seen as a tool then it should be renamed to something like dpdk-tester for consistency). Testpmd also has quite a lot of documentation, more than any of our other apps or utilities, which again makes it an outlier.
> > 
> > Yes testpmd is not the same kind of tool as others. It helps for tests,
> > debugging and demos.
> > 
> > About the name, as it is packaged as part of the runtime, I think we should
> > find a better name. As you said it should start with "dpdk-" and it should
> > contain "net" as it does not test the crypto drivers.
> > Something like dpdk-testpmd-net.
> 
> To me the name dpdk-testpmd-net is a bit long and does testpmd really just test PMDs. I was thinking of the name dpdk-tester is really pretty short and descriptive IMO. Adding net or pmd to the name does not really add anything as dpdk is kind of networking. Just my $0.04 worth. 

I tend to agree. dpdk-tester is not so bad.
So this application could be able to test the crypto engines?