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

["Mcnamara, John" <john.mcnamara@intel.com>]

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