Re: [PATCH 2/2] doc: add flow_filtering example documentation

[Ori Kam <orika@mellanox.com>]

Hi John,

> -----Original Message-----
> From: Mcnamara, John [mailto:john.mcnamara@intel.com]
> Sent: Friday, October 20, 2017 7:33 PM
> To: Ori Kam <orika@mellanox.com>; Adrien Mazarguil
> <adrien.mazarguil@6wind.com>; Thomas Monjalon
> <thomas@monjalon.net>
> Cc: dev@dpdk.org
> Subject: RE: [PATCH 2/2] doc: add flow_filtering example documentation
> 
> 
> 
> > -----Original Message-----
> > From: Ori Kam [mailto:orika@mellanox.com]
> > Sent: Thursday, October 19, 2017 11:16 AM
> > To: adrien.mazarguil@6wind.com; Mcnamara, John
> > <john.mcnamara@intel.com>; thomas@monjalon.net
> > Cc: dev@dpdk.org; orika@mellanox.com
> > Subject: [PATCH 2/2] doc: add flow_filtering example documentation
> >
> > Signed-off-by: Ori Kam <orika@mellanox.com>
> 
> Hi,
> 
> 1. This file needs to be included in the index.rst file.

May bad will be fixed.

> 2. There is a doc compilation issue due to a missing blank line after one of the
> code-block sections.

Sorry for that I didn't get any compilation issue during my tests. I will check what I missed.

> 3. There is a white space warning on merge.
> 

I will check this. 

> Apart from that the doc looks good.
> 
> Below are the changes I made to get it to compile.
> 
> John
> 
> $ git diff
> diff --git a/doc/guides/sample_app_ug/flow_filtering.rst
> b/doc/guides/sample_app_ug/flow_filtering.rst
> index b8d59af..f2d7db2 100644
> --- a/doc/guides/sample_app_ug/flow_filtering.rst
> +++ b/doc/guides/sample_app_ug/flow_filtering.rst
> @@ -113,7 +113,8 @@ The ``main()`` also allocates a mempool to hold the
> mbufs (Message Buffers)  used by the application:
> 
>  .. code-block:: c
> -   mbuf_pool = rte_pktmbuf_pool_create("mbuf_pool", 4096, 128, 0,
> +
> +    mbuf_pool = rte_pktmbuf_pool_create("mbuf_pool", 4096, 128, 0,
>                                              RTE_MBUF_DEFAULT_BUF_SIZE,
>                                              rte_socket_id());
> 
> @@ -536,4 +537,3 @@ The last part of the function is to validate the rule and
> create it.
>     int res = rte_flow_validate(port_id, &attr, pattern, action, &error);
>     if (!res)
>          flow = rte_flow_create(port_id, &attr, pattern, action, &error);
> -
> diff --git a/doc/guides/sample_app_ug/index.rst
> b/doc/guides/sample_app_ug/index.rst
> index 069d4f1..ca1f544 100644
> --- a/doc/guides/sample_app_ug/index.rst
> +++ b/doc/guides/sample_app_ug/index.rst
> @@ -77,6 +77,7 @@ Sample Applications User Guides
>      ptpclient
>      performance_thread
>      ipsec_secgw
> +    flow_filtering
> 
>  **Figures**


Thanks for your comments,

Ori