[dpdk-dev,v2,1/3] 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>
---
v2: Refer to 'applications' in general (John M)
---
 doc/guides/prog_guide/source_org.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

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


> -----Original Message-----
> From: Baruch Siach [mailto:baruch@tkos.co.il]
> Sent: Tuesday, December 6, 2016 12:38 PM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>; Baruch Siach
> <baruch@tkos.co.il>
> Subject: [PATCH v2 1/3] 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>

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

2016-12-06 14:38, 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>
[...]
> --- 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 applications to those shown above.
>      Check the latest DPDK source files for details.

I suggest to remove this file.
Each libraries, drivers and applications are documented somewhere else.
We really must avoid repeating ourself in the documentation and keep
a reasonnably maintainable documentation.
  

2016-12-06 17:53, Thomas Monjalon:
> 2016-12-06 14:38, 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>
> [...]
> > --- 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 applications to those shown above.
> >      Check the latest DPDK source files for details.
> 
> I suggest to remove this file.
> Each libraries, drivers and applications are documented somewhere else.
> We really must avoid repeating ourself in the documentation and keep
> a reasonnably maintainable documentation.

Any comment?