[dpdk-dev] [PATCH v3 4/4] doc: update documentation for flow classify lib
Kovacevic, Marko
marko.kovacevic at intel.com
Mon Dec 18 12:04:54 CET 2017
> -----Original Message-----
> From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Jasvinder Singh
> Sent: Friday, December 15, 2017 10:39 AM
> To: dev at dpdk.org
> Cc: Iremonger, Bernard <bernard.iremonger at intel.com>
> Subject: [dpdk-dev] [PATCH v3 4/4] doc: update documentation for flow classify
> lib
>
> Updates the documentation for flow classification library and sample
> application.
>
> Signed-off-by: Jasvinder Singh <jasvinder.singh at intel.com>
> v3:
> - add validate API desciption to programmers guide
Small typo desciption/ description
> @@ -225,11 +236,16 @@ The ``Classifier`` has the following internal structures:
> /* Input parameters */
> char name[RTE_FLOW_CLASSIFIER_MAX_NAME_SZ];
> int socket_id;
> - enum rte_flow_classify_table_type type;
>
> - /* Internal tables */
> - struct rte_table tables[RTE_FLOW_CLASSIFY_TABLE_MAX];
> + /* Internal */
> + /* ntuple_fliter */
Small typo above. Ntuple_fliter/ ntuple_filter.
> + struct rte_eth_ntuple_filter ntuple_filter;
> +
> + /* clasifier tables */
Same above clasifier / classifier
> To create an ACL table the ``rte_table_acl_params`` structure must be @@ -
> 314,14 +329,14 @@ and SCTP.
> RTE_FLOW_ITEM_TYPE_END,
> };
>
> -The internal function ``flow_classify_parse_flow`` parses the
> +The API function ``rte_flow_classify_validate`` parses the
> IPv4 5-tuple pattern, attributes and actions and returns the 5-tuple data in the
> ``rte_eth_ntuple_filter`` structure.
>
> .. code-block:: c
>
> static int
> - flow_classify_parse_flow(
> + rte_flow_classify_validate(struct rte_flow_classifier *cls,
> const struct rte_flow_attr *attr,
> const struct rte_flow_item pattern[],
> const struct rte_flow_action actions[], @@ -333,7 +348,7 @@
> Adding Flow Rules The ``rte_flow_classify_table_entry_add`` API creates an
> ``rte_flow_classify`` object which contains the flow_classify id and type, the
> action, a union of add and delete keys and a union of rules.
> -It uses the ``flow_classify_parse_flow`` internal function for parsing the
> +It uses the ``rte_flow_classify_validate`` api function for parsing the
Above api/ API
Otherwise everything else seem ok
Acked-by: Marko Kovacevic <marko.kovacevic at intel.com>
More information about the dev
mailing list