[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 at 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 at tkos.co.il - tel: +972.52.368.4656, http://www.tkos.co.il -