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

06/05/2021 18:40, Conor Walsh:

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.
Note: literalinclude was used in the past and was removed from DPDK as
it created an issue with PDF generation but this is not done anymore:
git.dpdk.org/dpdk/commit/?id=d3ce1dc637c1bbef9a407f10281b2bc0549256da

Signed-off-by: Conor Walsh <redacted>
Acked-by: John McNamara <redacted>
Acked-by: David Marchand <redacted>

Acked-by: Thomas Monjalon <redacted>

Applied, thanks.