diff mbox

[dpdk-dev,RFC,2/2] doc/guides/prog_guide: add new flow attribute

Message ID 1494791406-3594-3-git-send-email-qi.z.zhang@intel.com (mailing list archive)
State Superseded, archived
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Qi Zhang May 14, 2017, 7:50 p.m. UTC 
  Update the programming guide for the new attribute of rte_flow

Signed-off-by: Qi Zhang <qi.z.zhang@intel.com>
---
 doc/guides/prog_guide/rte_flow.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)

Comments

John McNamara May 16, 2017, 9:11 a.m. UTC | #1 
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Qi Zhang
> Sent: Sunday, May 14, 2017 8:50 PM
> To: adrien.mazarguil@6wind.com
> Cc: dev@dpdk.org; Lu, Wenzhuo <wenzhuo.lu@intel.com>; Xing, Beilei
> <beilei.xing@intel.com>; Zhang, Qi Z <qi.z.zhang@intel.com>
> Subject: [dpdk-dev] [RFC 2/2] doc/guides/prog_guide: add new flow
> attribute
> 
> Update the programming guide for the new attribute of rte_flow
> 
> Signed-off-by: Qi Zhang <qi.z.zhang@intel.com>
> ---
>  doc/guides/prog_guide/rte_flow.rst | 12 ++++++++++++
>  1 file changed, 12 insertions(+)
> 
> diff --git a/doc/guides/prog_guide/rte_flow.rst
> b/doc/guides/prog_guide/rte_flow.rst
> index b587ba9..5207eec 100644
> --- a/doc/guides/prog_guide/rte_flow.rst
> +++ b/doc/guides/prog_guide/rte_flow.rst
> @@ -181,6 +181,18 @@ directions. At least one direction must be specified.
>  Specifying both directions at once for a given rule is not recommended
> but  may be valid in a few cases (e.g. shared counters).
> 
> +Attribute: Match hint
> +^^^^^^^^^^^^^^^^^^^^^
> +
> +This is a attribute to hint different pattern match accuracy.
> +
> +Perfect match:
> +- Actions will be taken if input packet's pattern matches flow's pattern.
> +
> +Signature match:
> +- Actions will be taken if the signature of input packet's pattern
> +matches
> +  the signature of flow's pattern.
> +

There should be a blank line before the list items, otherwise it will
cause an RST warning.
diff mbox

Patch

diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst
index b587ba9..5207eec 100644
--- a/doc/guides/prog_guide/rte_flow.rst
+++ b/doc/guides/prog_guide/rte_flow.rst
@@ -181,6 +181,18 @@  directions. At least one direction must be specified.
 Specifying both directions at once for a given rule is not recommended but
 may be valid in a few cases (e.g. shared counters).
 
+Attribute: Match hint
+^^^^^^^^^^^^^^^^^^^^^
+
+This is a attribute to hint different pattern match accuracy.
+
+Perfect match:
+- Actions will be taken if input packet's pattern matches flow's pattern.
+
+Signature match:
+- Actions will be taken if the signature of input packet's pattern matches
+  the signature of flow's pattern.
+
 Pattern item
 ~~~~~~~~~~~~