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

Thomas Monjalon thomas.monjalon at 6wind.com
Tue Dec 6 17:53:05 CET 2016


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


More information about the dev mailing list