[dpdk-dev] [PATCH v2 2/2] doc/guides: updated testpmd app user guide for vxlan/nvgre encap/decap

[Iremonger, Bernard]

Hi Awal,

> -----Original Message-----
> From: Awal, Mohammad Abdul
> Sent: Friday, May 11, 2018 6:14 PM
> To: dev at dpdk.org; Iremonger, Bernard <bernard.iremonger at intel.com>;
> adrien.mazarguil at 6wind.com
> Subject: [PATCH v2 2/2] doc/guides: updated testpmd app user guide for
> vxlan/nvgre encap/decap
> 
> Updated the testpmd user guide documentation with how to used new action

Typo, "used" in line above should be "use".

> types RTE_FLOW_ACTION_VXLAN_ENCAP, RTE_FLOW_ACTION_VXLAN_DECAP,
> RTE_FLOW_ACTION_NVGRE_ENCAP, RTE_FLOW_ACTION_NVGRE_DECAP
> capabilities.
> 
> Signed-off-by: Mohammad Abdul Awal <mohammad.abdul.awal at intel.com>
> ---
>  doc/guides/testpmd_app_ug/testpmd_funcs.rst | 50
> +++++++++++++++++++++++++++++
>  1 file changed, 50 insertions(+)
> 
> diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> index 542c217..6ee3ff3 100644
> --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> @@ -3559,6 +3559,56 @@ This section lists supported actions and their
> attributes, if any.
> 
>    - ``ethertype``: Ethertype.
> 
> +- ``vxlan_encap``: encapsulate the inner flow with pattern of headers
> +  according to RFC7348.
> +
> +  - ``eth_dst {MAC-48}``: outer ether destination.
> +
> +  - ``eth_src {MAC-48}``: outer ether source.
> +
> +  - ``eth_type {unsigned}``: outer ether type.
> +
> +  - ``vlan_tci {unsigned}``: outer vlan tci.
> +
> +  - ``ipv4_dst {ipv4 address}``: outer ipv4 destination.
> +
> +  - ``ipv4_src {ipv4 address}``: outer ipv4 source.
> +
> +  - ``ipv4_proto {unsigned}``: outer ipv4 proto.
> +
> +  - ``udp_dst {unsigned}``: outer udp destination.
> +
> +  - ``udp_src {unsigned}``: outer udp source.
> +
> +  - ``vxlan_vni {unsigned}``: outer vxlan vni.
> +
> +  - ``end``: outer vxlan header pattern end.
> +
> +- ``vxlan_decap``: decapsulate the vxlan tunnel flow according to RFC7348.
> +
> +- ``nvgre_encap``: encapsulate the inner flow with pattern of headers
> +  according to RFC7637.
> +
> +  - ``eth_dst {MAC-48}``: outer ether destination.
> +
> +  - ``eth_src {MAC-48}``: outer ether source.
> +
> +  - ``eth_type {unsigned}``: outer ether type.
> +
> +  - ``vlan_tci {unsigned}``: outer vlan tci.
> +
> +  - ``ipv4_dst {ipv4 address}``: outer ipv4 destination.
> +
> +  - ``ipv4_src {ipv4 address}``: outer ipv4 source.
> +
> +  - ``ipv4_proto {unsigned}``: outer ipv4 proto.
> +
> +  - ``nvgre_vsni {unsigned}``: outer nvgre vsni.
> +
> +  - ``end``: outer nvgre header pattern end.
> +
> +- ``nvgre_decap``: decapsulate the nvgre tunnel flow according to RFC7637.
> +
>  Destroying flow rules
>  ~~~~~~~~~~~~~~~~~~~~~

I see that section 4.14.1 has been updated to document the syntax of the encap and decap actions, which look fine. 
However my comment on the v1 patch about adding some sample encap and decap rules has not been addressed.
My understanding is, that it is a two stage process where the tunnel endpoint flow is created first and the encapsulated flow is then created, this is not obvious from the syntax description section.
I think it would be useful to add some sample flows after section 4.12.8
> 
> --
> 2.7.4