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

[dpdk-dev] [PATCH v2 1/3] 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>
---
v2: Refer to 'applications' in general (John M)
---
 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..be4b564fb23e 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 applications to those shown above.
     Check the latest DPDK source files for details.
-- 
2.10.2

[dpdk-dev] [PATCH v2 2/3] doc: correct the description of the app directory

[Baruch Siach]

The applications under the app directory are just that, not sample
applications.

Signed-off-by: Baruch Siach <baruch@tkos.co.il>
---
v2: New patch (John M)
---
 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 be4b564fb23e..27e18e8951a0 100644
--- a/doc/guides/prog_guide/source_org.rst
+++ b/doc/guides/prog_guide/source_org.rst
@@ -125,7 +125,7 @@ Applications
 Applications are source files that contain a ``main()`` function.
 They are located in the ``$(RTE_SDK)/app`` and ``$(RTE_SDK)/examples`` directories.
 
-The app directory contains sample applications that are used to test DPDK (such as autotests)
+The app directory contains applications that are used to test DPDK (such as autotests)
 or the Poll Mode Drivers (test-pmd)::
 
     app
-- 
2.10.2

[dpdk-dev] [PATCH v2 3/3] doc: consistently quote directory names

[Baruch Siach]

Quote the names of the app and example directories like other directory
names in this chapter.

Signed-off-by: Baruch Siach <baruch@tkos.co.il>
---
v2: New patch
---
 doc/guides/prog_guide/source_org.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/doc/guides/prog_guide/source_org.rst b/doc/guides/prog_guide/source_org.rst
index 27e18e8951a0..6167384db4d3 100644
--- a/doc/guides/prog_guide/source_org.rst
+++ b/doc/guides/prog_guide/source_org.rst
@@ -125,7 +125,7 @@ Applications
 Applications are source files that contain a ``main()`` function.
 They are located in the ``$(RTE_SDK)/app`` and ``$(RTE_SDK)/examples`` directories.
 
-The app directory contains applications that are used to test DPDK (such as autotests)
+The ``app`` directory contains applications that are used to test DPDK (such as autotests)
 or the Poll Mode Drivers (test-pmd)::
 
     app
@@ -135,7 +135,7 @@ or the Poll Mode Drivers (test-pmd)::
     +-- test-pipeline      # Test the IP Pipeline framework
     +-- test-pmd           # Test and benchmark poll mode drivers
 
-The examples directory contains sample applications that show how libraries can be used::
+The ``examples`` directory contains sample applications that show how libraries can be used::
 
     examples
     +-- cmdline            # Example of using the cmdline library
@@ -162,5 +162,5 @@ The examples directory contains sample applications that show how libraries can
 
 .. note::
 
-    The actual app and examples directories may contain additional 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.
-- 
2.10.2

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

[Mcnamara, John]

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>

Re: [dpdk-dev] [PATCH v2 2/3] doc: correct the description of the app directory

[Mcnamara, John]

> -----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 2/3] doc: correct the description of the app directory
> 
> The applications under the app directory are just that, not sample
> applications.
> 
> Signed-off-by: Baruch Siach <baruch@tkos.co.il>

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

Re: [dpdk-dev] [PATCH v2 3/3] doc: consistently quote directory names

[Mcnamara, John]

> -----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 3/3] doc: consistently quote directory names
> 
> Quote the names of the app and example directories like other directory
> names in this chapter.
> 
> Signed-off-by: Baruch Siach <baruch@tkos.co.il>

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

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

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

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

[Thomas Monjalon]

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?