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

Mcnamara, John john.mcnamara at intel.com
Tue Dec 6 12:41:44 CET 2016



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



More information about the dev mailing list