[dpdk-dev,4/4] doc: extend commands in testpmd and remove related ABI deprecation

  Modify the doc about flow director commands to support filtering in VFs.
Remove related ABI deprecation.

Signed-off-by: Jingjing Wu <jingjing.wu@intel.com>
---
 doc/guides/rel_notes/deprecation.rst        |  4 ----
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 12 ++++++------
 2 files changed, 6 insertions(+), 10 deletions(-)
  

I am not sure if doc udpated here is what we expected or not.
Any guidance on this from ABI experts?

Regards,
Helin

> -----Original Message-----
> From: Wu, Jingjing
> Sent: Tuesday, September 22, 2015 11:46 AM
> To: dev@dpdk.org
> Cc: Wu, Jingjing; Zhang, Helin; Lu, Wenzhuo; Xu, HuilongX
> Subject: [PATCH 4/4] doc: extend commands in testpmd and remove related ABI
> deprecation
> 
> Modify the doc about flow director commands to support filtering in VFs.
> Remove related ABI deprecation.
> 
> Signed-off-by: Jingjing Wu <jingjing.wu@intel.com>
> ---
>  doc/guides/rel_notes/deprecation.rst        |  4 ----
>  doc/guides/testpmd_app_ug/testpmd_funcs.rst | 12 ++++++------
>  2 files changed, 6 insertions(+), 10 deletions(-)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst
> b/doc/guides/rel_notes/deprecation.rst
> index fffad80..e1a35b9 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -24,10 +24,6 @@ Deprecation Notices
>    Structures: rte_fdir_*, rte_eth_fdir.
>    Enums: rte_l4type, rte_iptype.
> 
> -* ABI changes are planned for struct rte_eth_fdir_flow_ext in order to support
> -  flow director filtering in VF. The release 2.1 does not contain these ABI
> -  changes, but release 2.2 will, and no backwards compatibility is planned.
> -
>  * ABI changes are planned for struct rte_eth_fdir_filter and
>    rte_eth_fdir_masks in order to support new flow director modes,
>    MAC VLAN and Cloud, on x550. The MAC VLAN mode means the MAC and
> diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> index aa77a91..9a0d18a 100644
> --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> @@ -1624,30 +1624,30 @@ Different NICs may have different capabilities,
> command show port fdir (port_id)
> 
>  flow_director_filter (port_id) (add|del|update) flow
> (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag)
>  src (src_ip_address) dst (dst_ip_address) vlan (vlan_value) flexbytes
> (flexbytes_value)
> -(drop|fwd) queue (queue_id) fd_id (fd_id_value)
> +(drop|fwd) pf|vf(vf_id) queue (queue_id) fd_id (fd_id_value)
> 
>  flow_director_filter (port_id) (add|del|update) flow
> (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp)
>  src (src_ip_address) (src_port) dst (dst_ip_address) (dst_port) vlan (vlan_value)
> -flexbytes (flexbytes_value) (drop|fwd) queue (queue_id) fd_id (fd_id_value)
> +flexbytes (flexbytes_value) (drop|fwd) pf|vf(vf_id) queue (queue_id)
> +fd_id (fd_id_value)
> 
>  flow_director_filter (port_id) (add|del|update) flow (ipv4-sctp|ipv6-sctp)  src
> (src_ip_address) (src_port) dst (dst_ip_address) (dst_port) tag (verification_tag)
> -vlan (vlan_value) flexbytes (flexbytes_value) (drop|fwd) queue (queue_id)
> fd_id (fd_id_value)
> +vlan (vlan_value) flexbytes (flexbytes_value) (drop|fwd) pf|vf(vf_id)
> +queue (queue_id) fd_id (fd_id_value)
> 
>  flow_director_filter (port_id) (add|del|update) flow l2_payload -ether
> (ethertype) flexbytes (flexbytes_value) (drop|fwd) queue (queue_id) fd_id
> (fd_id_value)
> +ether (ethertype) flexbytes (flexbytes_value) (drop|fwd) pf|vf(vf_id)
> +queue (queue_id) fd_id (fd_id_value)
> 
>  For example, to add an ipv4-udp flow type filter:
> 
>  .. code-block:: console
> 
> -    testpmd> flow_director_filter 0 add flow ipv4-udp src 2.2.2.3 32 dst 2.2.2.5
> 33 vlan 0x1 flexbytes (0x88,0x48) fwd queue 1 fd_id 1
> +    testpmd> flow_director_filter 0 add flow ipv4-udp src 2.2.2.3 32
> + dst 2.2.2.5 33 vlan 0x1 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1
> 
>  For example, add an ipv4-other flow type filter:
> 
>  .. code-block:: console
> 
> -    testpmd> flow_director_filter 0 add flow ipv4-other src 2.2.2.3 dst 2.2.2.5
> vlan 0x1 flexbytes (0x88,0x48) fwd queue 1 fd_id 1
> +    testpmd> flow_director_filter 0 add flow ipv4-other src 2.2.2.3 dst
> + 2.2.2.5 vlan 0x1 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1
> 
>  flush_flow_director
>  ~~~~~~~~~~~~~~~~~~~
> --
> 2.4.0
  

2015-10-27 07:54, Zhang, Helin:
> I am not sure if doc udpated here is what we expected or not.
> Any guidance on this from ABI experts?
[...]
> >  doc/guides/rel_notes/deprecation.rst        |  4 ----
> >  doc/guides/testpmd_app_ug/testpmd_funcs.rst | 12 ++++++------

The deprecation should be removed in the patch changing the code.
And the release notes must be updated at the same time.
Thanks for the catch Helin.
  

Thanks helin and Thomas
I will update the release notes too.

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Tuesday, October 27, 2015 5:36 PM
> To: Zhang, Helin
> Cc: dev@dpdk.org; Wu, Jingjing
> Subject: Re: [dpdk-dev] [PATCH 4/4] doc: extend commands in testpmd and
> remove related ABI deprecation
> 
> 2015-10-27 07:54, Zhang, Helin:
> > I am not sure if doc udpated here is what we expected or not.
> > Any guidance on this from ABI experts?
> [...]
> > >  doc/guides/rel_notes/deprecation.rst        |  4 ----
> > >  doc/guides/testpmd_app_ug/testpmd_funcs.rst | 12 ++++++------
> 
> The deprecation should be removed in the patch changing the code.
> And the release notes must be updated at the same time.
> Thanks for the catch Helin.