[dpdk-dev] [PATCH 9/9] doc: update ipsec sample guide

[Mcnamara, John]

Hi,

Thanks for the updated docs and clear examples. Some minor comments below.


> -----Original Message-----
> From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Sergio Gonzalez
> Monroy
> Sent: Friday, May 6, 2016 5:32 PM
> To: dev at dpdk.org
> Subject: [dpdk-dev] [PATCH 9/9] doc: update ipsec sample guide
> 
> Signed-off-by: Sergio Gonzalez Monroy <sergio.gonzalez.monroy at intel.com>
> ---
>  doc/guides/sample_app_ug/ipsec_secgw.rst | 583 ++++++++++++++++++++------
> -----
>  1 file changed, 381 insertions(+), 202 deletions(-)



> +#. [Optional] Build the application for debugging:
> +   This option adds some extra flags, disables compiler optimizations and
> +   is verbose.
> +
> +   .. code-block:: console
> +
> +       make DEBUG=1
> +

For simple console code-blocks like this you can just use ::. It defaults
to "console".

> +
> +.. _figure_ipsec_endpoints:
> +
> +.. figure:: img/ipsec_endpoints.svg
> +
> +   IPSec Inbound/Outbound traffic


The patch is missing the file:
    doc/guides/sample_app_ug/img/ipsec_endpoints.svg


> ++-----------------------------------+------------+
> +| **Dst**                           | **SA idx** |
> +|                                   |            |
> ++-----------------------------------+------------+
> +| 192.168.105.0/24                  | 5          |
> +|                                   |            |



You should add the table directive before these tables so that a
caption can be applied:

   .. _table_ipsec_endpoint_outbound_sp:

   .. table:: Endpoint 0 Outbound Security Policies

      +-----------------------------------+------------+
      | **Dst**                           | **SA idx** |
      |                                   |            |
      +-----------------------------------+------------+
      | 192.168.105.0/24                  | 5          |
      |                                   |            |


John