From mboxrd@z Thu Jan  1 00:00:00 1970
From: Bruce Richardson <bruce.richardson@intel.com>
Subject: Re: [PATCH v2 2/3] doc: added guidelines on dpdk
 documentation
Date: Wed, 5 Aug 2015 15:26:00 +0100
Message-ID: <20150805142600.GB9532@bricha3-MOBL3>
References: <1435845053-17203-1-git-send-email-john.mcnamara@intel.com>
 <1436543121-26240-1-git-send-email-john.mcnamara@intel.com>
 <1436543121-26240-3-git-send-email-john.mcnamara@intel.com>
Mime-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Cc: dev@dpdk.org
To: John McNamara <john.mcnamara@intel.com>
Return-path: <dev-bounces@dpdk.org>
Received: from mga14.intel.com (mga14.intel.com [192.55.52.115])
 by dpdk.org (Postfix) with ESMTP id 33FF05960
 for <dev@dpdk.org>; Wed,  5 Aug 2015 16:26:04 +0200 (CEST)
Content-Disposition: inline
In-Reply-To: <1436543121-26240-3-git-send-email-john.mcnamara@intel.com>
List-Id: patches and discussions about DPDK <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

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.