> -----Original Message----- > From: Walsh, Conor <conor.wa...@intel.com> > Sent: Wednesday, April 21, 2021 10:12 AM > To: Mcnamara, John <john.mcnam...@intel.com>; tho...@monjalon.net; > david.march...@redhat.com; Yigit, Ferruh <ferruh.yi...@intel.com>; > Richardson, Bruce <bruce.richard...@intel.com>; Burakov, Anatoly > <anatoly.bura...@intel.com> > Cc: dev@dpdk.org; Walsh, Conor <conor.wa...@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.mcnam...@intel.com>
