From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) by dpdk.org (Postfix) with ESMTP id 5FAAE2B8C for ; Thu, 10 Nov 2016 17:13:00 +0100 (CET) Received: from orsmga002.jf.intel.com ([10.7.209.21]) by orsmga104.jf.intel.com with ESMTP; 10 Nov 2016 08:13:00 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.31,619,1473145200"; d="scan'208";a="2420011" Received: from irsmsx152.ger.corp.intel.com ([163.33.192.66]) by orsmga002.jf.intel.com with ESMTP; 10 Nov 2016 08:12:59 -0800 Received: from irsmsx103.ger.corp.intel.com ([169.254.3.190]) by IRSMSX152.ger.corp.intel.com ([169.254.6.24]) with mapi id 14.03.0248.002; Thu, 10 Nov 2016 16:11:37 +0000 From: "Mcnamara, John" To: Thomas Monjalon CC: "dev@dpdk.org" , Christian Ehrhardt , "Richardson, Bruce" Thread-Topic: [PATCH] doc: move testpmd guide with other tools Thread-Index: AQHSOadgKC/uX//cQUqI5XqAm4KCpKDSZmBw Date: Thu, 10 Nov 2016 16:11:36 +0000 Message-ID: References: <1478599358-15921-1-git-send-email-thomas.monjalon@6wind.com> In-Reply-To: <1478599358-15921-1-git-send-email-thomas.monjalon@6wind.com> Accept-Language: en-GB, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ctpclassification: CTP_PUBLIC x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiZjUyNTlmNGQtYWE3ZS00NzI2LWI5ZmEtMzc4Njk4N2JhZWIwIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX1BVQkxJQyJ9XX1dfSwiU3ViamVjdExhYmVscyI6W10sIlRNQ1ZlcnNpb24iOiIxNS45LjYuNiIsIlRydXN0ZWRMYWJlbEhhc2giOiJmbnBQNjRUNjRYcHRjbmF3ZXN5d1BOczlmVTU1ZzVWOGtaVHlOblwvRDAzRT0ifQ== x-originating-ip: [163.33.239.180] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [PATCH] doc: move testpmd guide with other tools X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 10 Nov 2016 16:13:02 -0000 > -----Original Message----- > From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com] > Sent: Tuesday, November 8, 2016 10:03 AM > To: Mcnamara, John > Cc: dev@dpdk.org; Christian Ehrhardt > Subject: [PATCH] doc: move testpmd guide with other tools >=20 > The guide testpmd_app_ug/ is moved inside the new tools/ guide as a > section. >=20 > Signed-off-by: Thomas Monjalon > --- > 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 =3D> tools/testpmd}/build_app.rst | 0 > doc/guides/{testpmd_app_ug =3D> tools/testpmd}/index.rst | 4 ++-= - > doc/guides/{testpmd_app_ug =3D> tools/testpmd}/intro.rst | 0 > doc/guides/{testpmd_app_ug =3D> tools/testpmd}/run_app.rst | 0 > doc/guides/{testpmd_app_ug =3D> tools/testpmd}/testpmd_funcs.rst | 0 > 10 files changed, 5 insertions(+), 7 deletions(-) rename > doc/guides/{testpmd_app_ug =3D> tools/testpmd}/build_app.rst (100%) rena= me > doc/guides/{testpmd_app_ug =3D> tools/testpmd}/index.rst (96%) rename > doc/guides/{testpmd_app_ug =3D> tools/testpmd}/intro.rst (100%) rename > doc/guides/{testpmd_app_ug =3D> tools/testpmd}/run_app.rst (100%) rename > doc/guides/{testpmd_app_ug =3D> tools/testpmd}/testpmd_funcs.rst (100%) Hi, I had a look at the html output before and after this patch and I don't qui= te agree with it. I see that you are trying to clean up and make the docume= ntation 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 appli= cation 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 sh= ould be renamed to something like dpdk-tester for consistency). Testpmd als= o has quite a lot of documentation, more than any of our other apps or util= ities, 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 tha= t. John