> -----Original Message----- > From: Walsh, Conor <[email protected]> > Sent: Wednesday, April 21, 2021 10:12 AM > To: Mcnamara, John <[email protected]>; [email protected]; > [email protected]; Yigit, Ferruh <[email protected]>; > Richardson, Bruce <[email protected]>; Burakov, Anatoly > <[email protected]> > Cc: [email protected]; Walsh, Conor <[email protected]> > 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 <[email protected]>
