[dpdk-dev] [PATCH 1/2] doc: remove chkincs reference

[dpdk-dev] [PATCH 1/2] doc: remove chkincs reference

[Baruch Siach]

The chkincs app was removed in commit 1b938bb9dfb6 ("app: remove chkincs").

Signed-off-by: Baruch Siach <baruch@tkos.co.il>
---
 doc/guides/prog_guide/source_org.rst | 1 -
 1 file changed, 1 deletion(-)

diff --git a/doc/guides/prog_guide/source_org.rst b/doc/guides/prog_guide/source_org.rst
index d9c140f704e3..4a4a0a325dd7 100644
--- a/doc/guides/prog_guide/source_org.rst
+++ b/doc/guides/prog_guide/source_org.rst
@@ -129,7 +129,6 @@ The app directory contains sample applications that are used to test DPDK (such
 or the Poll Mode Drivers (test-pmd)::
 
     app
-    +-- chkincs            # Test program to check include dependencies
     +-- cmdline_test       # Test the commandline library
     +-- test               # Autotests to validate DPDK features
     +-- test-acl           # Test the ACL library
-- 
2.10.2

[dpdk-dev] [PATCH 2/2] doc: note that the app list is incomplete

[Baruch Siach]

Extend the note at the end of Source Organization chapter to also mention
the app directory.

Signed-off-by: Baruch Siach <baruch@tkos.co.il>
---
 doc/guides/prog_guide/source_org.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/guides/prog_guide/source_org.rst b/doc/guides/prog_guide/source_org.rst
index 4a4a0a325dd7..8fd98d507008 100644
--- a/doc/guides/prog_guide/source_org.rst
+++ b/doc/guides/prog_guide/source_org.rst
@@ -162,5 +162,5 @@ The examples directory contains sample applications that show how libraries can
 
 .. note::
 
-    The actual examples directory may contain additional sample applications to those shown above.
+    The actual app and examples directories may contain additional sample applications to those shown above.
     Check the latest DPDK source files for details.
-- 
2.10.2

Re: [dpdk-dev] [PATCH 2/2] doc: note that the app list is incomplete

[Mcnamara, John]

> -----Original Message-----
> From: Baruch Siach [mailto:baruch@tkos.co.il]
> Sent: Tuesday, December 6, 2016 11:02 AM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>; Baruch Siach
> <baruch@tkos.co.il>
> Subject: [PATCH 2/2] doc: note that the app list is incomplete
> 
> Extend the note at the end of Source Organization chapter to also mention
> the app directory.
> 
> Signed-off-by: Baruch Siach <baruch@tkos.co.il>
> ---
>  doc/guides/prog_guide/source_org.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/doc/guides/prog_guide/source_org.rst
> b/doc/guides/prog_guide/source_org.rst
> index 4a4a0a325dd7..8fd98d507008 100644
> --- a/doc/guides/prog_guide/source_org.rst
> +++ b/doc/guides/prog_guide/source_org.rst
> @@ -162,5 +162,5 @@ The examples directory contains sample applications
> that show how libraries can
> 
>  .. note::
> 
> -    The actual examples directory may contain additional sample
> applications to those shown above.
> +    The actual app and examples directories may contain additional sample
> applications to those shown above.
>      Check the latest DPDK source files for details.

Strictly speaking the applications in the "app" directory aren't "sample" apps
and also they don't change very often. So I would leave this note as it is or
change it to:

The actual app and examples directories may contain additional applications to those shown above.

Re: [dpdk-dev] [PATCH 1/2] doc: remove chkincs reference

[Mcnamara, John]

> -----Original Message-----
> From: Baruch Siach [mailto:baruch@tkos.co.il]
> Sent: Tuesday, December 6, 2016 11:02 AM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>; Baruch Siach
> <baruch@tkos.co.il>
> Subject: [PATCH 1/2] doc: remove chkincs reference
> 
> The chkincs app was removed in commit 1b938bb9dfb6 ("app: remove
> chkincs").
> 
> Signed-off-by: Baruch Siach <baruch@tkos.co.il>

Acked-by: John McNamara <john.mcnamara@intel.com>

Re: [dpdk-dev] [PATCH 2/2] doc: note that the app list is incomplete

[Baruch Siach]

Hi John,

On Tue, Dec 06, 2016 at 11:41:44AM +0000, Mcnamara, John wrote:
> > Extend the note at the end of Source Organization chapter to also mention
> > the app directory.
> > 
> > Signed-off-by: Baruch Siach <baruch@tkos.co.il>
> > ---
> >  doc/guides/prog_guide/source_org.rst | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/doc/guides/prog_guide/source_org.rst
> > b/doc/guides/prog_guide/source_org.rst
> > index 4a4a0a325dd7..8fd98d507008 100644
> > --- a/doc/guides/prog_guide/source_org.rst
> > +++ b/doc/guides/prog_guide/source_org.rst
> > @@ -162,5 +162,5 @@ The examples directory contains sample applications
> > that show how libraries can
> > 
> >  .. note::
> > 
> > -    The actual examples directory may contain additional sample
> > applications to those shown above.
> > +    The actual app and examples directories may contain additional sample
> > applications to those shown above.
> >      Check the latest DPDK source files for details.
> 
> Strictly speaking the applications in the "app" directory aren't "sample" apps
> and also they don't change very often.

The text above says just that:

  The app directory contains sample applications that are used to test DPDK...

Should I change the wording there?

> So I would leave this note as it is or change it to:
> 
> The actual app and examples directories may contain additional applications 
> to those shown above.

baruch

-- 
     http://baruch.siach.name/blog/                  ~. .~   Tk Open Systems
=}------------------------------------------------ooO--U--Ooo------------{=
   - baruch@tkos.co.il - tel: +972.52.368.4656, http://www.tkos.co.il -

Re: [dpdk-dev] [PATCH 2/2] doc: note that the app list is incomplete

[Mcnamara, John]

> -----Original Message-----
> From: Baruch Siach [mailto:baruch@tkos.co.il]
> Sent: Tuesday, December 6, 2016 11:46 AM
> To: Mcnamara, John <john.mcnamara@intel.com>
> Cc: dev@dpdk.org
> Subject: Re: [PATCH 2/2] doc: note that the app list is incomplete
> 
> Hi John,
> 
> On Tue, Dec 06, 2016 at 11:41:44AM +0000, Mcnamara, John wrote:
> > > Extend the note at the end of Source Organization chapter to also
> > > mention the app directory.
> > >
> > > Signed-off-by: Baruch Siach <baruch@tkos.co.il>
> > > ---
> > >  doc/guides/prog_guide/source_org.rst | 2 +-
> > >  1 file changed, 1 insertion(+), 1 deletion(-)
> > >
> > > diff --git a/doc/guides/prog_guide/source_org.rst
> > > b/doc/guides/prog_guide/source_org.rst
> > > index 4a4a0a325dd7..8fd98d507008 100644
> > > --- a/doc/guides/prog_guide/source_org.rst
> > > +++ b/doc/guides/prog_guide/source_org.rst
> > > @@ -162,5 +162,5 @@ The examples directory contains sample
> > > applications that show how libraries can
> > >
> > >  .. note::
> > >
> > > -    The actual examples directory may contain additional sample
> > > applications to those shown above.
> > > +    The actual app and examples directories may contain additional
> > > + sample
> > > applications to those shown above.
> > >      Check the latest DPDK source files for details.
> >
> > Strictly speaking the applications in the "app" directory aren't
> > "sample" apps and also they don't change very often.
> 
> The text above says just that:
> 

The docs keep making a liar of me. :-/

>   The app directory contains sample applications that are used to test
> DPDK...
> 
> Should I change the wording there?

Yes, change that line as well. Thanks.

Re: [dpdk-dev] [PATCH 2/2] doc: note that the app list is incomplete

[Thomas Monjalon]

2016-12-06 11:54, Mcnamara, John:
> From: Baruch Siach [mailto:baruch@tkos.co.il]
> > > > --- a/doc/guides/prog_guide/source_org.rst
> > > > +++ b/doc/guides/prog_guide/source_org.rst
> > > > @@ -162,5 +162,5 @@ The examples directory contains sample
> > > > applications that show how libraries can
> > > >
> > > >  .. note::
> > > >
> > > > -    The actual examples directory may contain additional sample
> > > > applications to those shown above.
> > > > +    The actual app and examples directories may contain additional
> > > > + sample
> > > > applications to those shown above.
> > > >      Check the latest DPDK source files for details.
> > >
> > > Strictly speaking the applications in the "app" directory aren't
> > > "sample" apps and also they don't change very often.
> > 
> > The text above says just that:
> > 
> 
> The docs keep making a liar of me. :-/
> 
> >   The app directory contains sample applications that are used to test
> > DPDK...
> > 
> > Should I change the wording there?
> 
> Yes, change that line as well. Thanks.

Anyone for a v2, please?

Re: [dpdk-dev] [PATCH 1/2] doc: remove chkincs reference

[Ferruh Yigit]

On 12/6/2016 11:42 AM, john.mcnamara at intel.com (Mcnamara, John) wrote:
>> -----Original Message-----
>> From: Baruch Siach [mailto:baruch at tkos.co.il]
>> Sent: Tuesday, December 6, 2016 11:02 AM
>> To: dev at dpdk.org
>> Cc: Mcnamara, John <john.mcnamara at intel.com>; Baruch Siach
>> <baruch at tkos.co.il>
>> Subject: [PATCH 1/2] doc: remove chkincs reference
>>
>> The chkincs app was removed in commit 1b938bb9dfb6 ("app: remove
>> chkincs").
>>
>> Signed-off-by: Baruch Siach <baruch at tkos.co.il>
> 
> Acked-by: John McNamara <john.mcnamara at intel.com>

Hi Baruch,

This patch [1] has been superseded by David's patch [2] which removes all file
references from documentation.


[1]
https://patches.dpdk.org/patch/17701/

[2]
https://patches.dpdk.org/patch/49901/