[dpdk-dev] [PATCH] doc/contributing/documentation: add info about including code

[Mcnamara, John]

> -----Original Message-----
> From: Walsh, Conor <conor.walsh at intel.com>
> Sent: Wednesday, April 21, 2021 10:12 AM
> To: Mcnamara, John <john.mcnamara at intel.com>; thomas at monjalon.net;
> david.marchand at redhat.com; Yigit, Ferruh <ferruh.yigit at intel.com>;
> Richardson, Bruce <bruce.richardson at intel.com>; Burakov, Anatoly
> <anatoly.burakov at intel.com>
> Cc: dev at dpdk.org; Walsh, Conor <conor.walsh at intel.com>
> Subject: [PATCH] doc/contributing/documentation: add info about including
> code
> 
> Currently the documentation describes how to add code snippets to the docs
> using code blocks. This can be problematic as the code snippets in the
> docs may fall out of sync with the actual code it is referencing within
> DPDK. This patch adds instructions to the contribution guide about how to
> include code in the docs using literalinclude which will dynamically get
> the code from source when the docs are generated. This will help to ensure
> that the code within the docs is up to date and not out of sync with the
> actual code.

This is a very good suggestion and I think we should encourage doc writers
to use this when including code in the documentation.

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