Re: [dpdk-dev] [PATCH v2 2/3] doc: added guidelines on dpdk documentation

[Bruce Richardson <bruce.richardson@intel.com>]

On Fri, Jul 10, 2015 at 04:45:20PM +0100, John McNamara wrote:
> Added guidelines on the purpose and structure of the DPDK
> documentation, how to build it and guidelines for creating it.
> 
> Signed-off-by: John McNamara <john.mcnamara@intel.com>

Acked-by: Bruce Richardson <bruce.richardson@intel.com>

with one minor error highlighted below.

> ---
>  doc/guides/guidelines/documentation.rst | 579 ++++++++++++++++++++++++++++++++
>  doc/guides/guidelines/index.rst         |   2 +
>  2 files changed, 581 insertions(+)
>  create mode 100644 doc/guides/guidelines/documentation.rst
> 
> diff --git a/doc/guides/guidelines/documentation.rst b/doc/guides/guidelines/documentation.rst
> new file mode 100644
> index 0000000..b47f028
> --- /dev/null
> +++ b/doc/guides/guidelines/documentation.rst
> @@ -0,0 +1,579 @@
> +.. doc_guidelines:
> +
> +DPDK Documentation Guidelines
> +=============================
> +
<SNIP>
> +The API documentation is built from `Doxygen <http://www.stack.nl/~dimitri/doxygen/>`_ comments in the header files.
> +These files are mainly in the ``lib/lib_rte_*`` directories although some of the Poll Mode Drivers in ``drivers/net``

Minor nit - No "_" between lib and rte in the library names.