[v2] flow_classify: remove eperimental tag from the API

Message ID 1632329295-22822-1-git-send-email-bernard.iremonger@intel.com (mailing list archive)
State Rejected, archived
Delegated to: Thomas Monjalon
Headers
Series [v2] flow_classify: remove eperimental tag from the API |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/github-robot: build success github build: passed

Commit Message

Iremonger, Bernard Sept. 22, 2021, 4:48 p.m. UTC
  This API was introduced in 17.11, removing experimental tag
to promote to stable state.

Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
---
 examples/flow_classify/meson.build    | 2 +-
 lib/flow_classify/rte_flow_classify.h | 7 -------
 lib/flow_classify/version.map         | 2 +-
 3 files changed, 2 insertions(+), 9 deletions(-)
  

Comments

Kevin Traynor Sept. 23, 2021, 10:09 a.m. UTC | #1
Hi Bernard,

On 22/09/2021 17:48, Bernard Iremonger wrote:
> This API was introduced in 17.11, removing experimental tag
> to promote to stable state.
> 
> Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
> ---
>   examples/flow_classify/meson.build    | 2 +-
>   lib/flow_classify/rte_flow_classify.h | 7 -------
>   lib/flow_classify/version.map         | 2 +-
>   3 files changed, 2 insertions(+), 9 deletions(-)
> 
> diff --git a/examples/flow_classify/meson.build b/examples/flow_classify/meson.build
> index 1be1bf0374..bffceb9465 100644
> --- a/examples/flow_classify/meson.build
> +++ b/examples/flow_classify/meson.build
> @@ -7,7 +7,7 @@
>   # DPDK instance, use 'make'
>   
>   deps += 'flow_classify'
> -allow_experimental_apis = true
> +
>   sources = files(
>           'flow_classify.c',
>   )
> diff --git a/lib/flow_classify/rte_flow_classify.h b/lib/flow_classify/rte_flow_classify.h
> index 82ea92b6a6..3759cd32af 100644
> --- a/lib/flow_classify/rte_flow_classify.h
> +++ b/lib/flow_classify/rte_flow_classify.h

The library is still marked as experimental, but I don't think this is 
valid anymore as it now contains stable APIs. So needs some removals:

Text below in rte_flow_classify.h,

  * @warning
  * @b EXPERIMENTAL:
  * All functions in this file may be changed or removed without prior 
notice.


Also in MAINTAINERS file,
Flow Classify - EXPERIMENTAL

and as it is lib moving into stable ABI, then probably something should 
go in the release notes for this.

thanks,
Kevin.

> @@ -157,7 +157,6 @@ struct rte_flow_classify_ipv4_5tuple_stats {
>    * @return
>    *   Handle to flow classifier instance on success or NULL otherwise
>    */
> -__rte_experimental
>   struct rte_flow_classifier *
>   rte_flow_classifier_create(struct rte_flow_classifier_params *params);
>   
> @@ -169,7 +168,6 @@ rte_flow_classifier_create(struct rte_flow_classifier_params *params);
>    * @return
>    *   0 on success, error code otherwise
>    */
> -__rte_experimental
>   int
>   rte_flow_classifier_free(struct rte_flow_classifier *cls);
>   
> @@ -183,7 +181,6 @@ rte_flow_classifier_free(struct rte_flow_classifier *cls);
>    * @return
>    *   0 on success, error code otherwise
>    */
> -__rte_experimental
>   int
>   rte_flow_classify_table_create(struct rte_flow_classifier *cls,
>   		struct rte_flow_classify_table_params *params);
> @@ -205,7 +202,6 @@ rte_flow_classify_table_create(struct rte_flow_classifier *cls,
>    * @return
>    *   0 on success, error code otherwise
>    */
> -__rte_experimental
>   int
>   rte_flow_classify_validate(struct rte_flow_classifier *cls,
>   		const struct rte_flow_attr *attr,
> @@ -232,7 +228,6 @@ rte_flow_classify_validate(struct rte_flow_classifier *cls,
>    * @return
>    *   A valid handle in case of success, NULL otherwise.
>    */
> -__rte_experimental
>   struct rte_flow_classify_rule *
>   rte_flow_classify_table_entry_add(struct rte_flow_classifier *cls,
>   		const struct rte_flow_attr *attr,
> @@ -251,7 +246,6 @@ rte_flow_classify_table_entry_add(struct rte_flow_classifier *cls,
>    * @return
>    *   0 on success, error code otherwise.
>    */
> -__rte_experimental
>   int
>   rte_flow_classify_table_entry_delete(struct rte_flow_classifier *cls,
>   		struct rte_flow_classify_rule *rule);
> @@ -273,7 +267,6 @@ rte_flow_classify_table_entry_delete(struct rte_flow_classifier *cls,
>    * @return
>    *   0 on success, error code otherwise.
>    */
> -__rte_experimental
>   int
>   rte_flow_classifier_query(struct rte_flow_classifier *cls,
>   		struct rte_mbuf **pkts,
> diff --git a/lib/flow_classify/version.map b/lib/flow_classify/version.map
> index 49bc25c6a0..b7a888053b 100644
> --- a/lib/flow_classify/version.map
> +++ b/lib/flow_classify/version.map
> @@ -1,4 +1,4 @@
> -EXPERIMENTAL {
> +DPDK_22 {
>   	global:
>   
>   	rte_flow_classifier_create;
>
  

Patch

diff --git a/examples/flow_classify/meson.build b/examples/flow_classify/meson.build
index 1be1bf0374..bffceb9465 100644
--- a/examples/flow_classify/meson.build
+++ b/examples/flow_classify/meson.build
@@ -7,7 +7,7 @@ 
 # DPDK instance, use 'make'
 
 deps += 'flow_classify'
-allow_experimental_apis = true
+
 sources = files(
         'flow_classify.c',
 )
diff --git a/lib/flow_classify/rte_flow_classify.h b/lib/flow_classify/rte_flow_classify.h
index 82ea92b6a6..3759cd32af 100644
--- a/lib/flow_classify/rte_flow_classify.h
+++ b/lib/flow_classify/rte_flow_classify.h
@@ -157,7 +157,6 @@  struct rte_flow_classify_ipv4_5tuple_stats {
  * @return
  *   Handle to flow classifier instance on success or NULL otherwise
  */
-__rte_experimental
 struct rte_flow_classifier *
 rte_flow_classifier_create(struct rte_flow_classifier_params *params);
 
@@ -169,7 +168,6 @@  rte_flow_classifier_create(struct rte_flow_classifier_params *params);
  * @return
  *   0 on success, error code otherwise
  */
-__rte_experimental
 int
 rte_flow_classifier_free(struct rte_flow_classifier *cls);
 
@@ -183,7 +181,6 @@  rte_flow_classifier_free(struct rte_flow_classifier *cls);
  * @return
  *   0 on success, error code otherwise
  */
-__rte_experimental
 int
 rte_flow_classify_table_create(struct rte_flow_classifier *cls,
 		struct rte_flow_classify_table_params *params);
@@ -205,7 +202,6 @@  rte_flow_classify_table_create(struct rte_flow_classifier *cls,
  * @return
  *   0 on success, error code otherwise
  */
-__rte_experimental
 int
 rte_flow_classify_validate(struct rte_flow_classifier *cls,
 		const struct rte_flow_attr *attr,
@@ -232,7 +228,6 @@  rte_flow_classify_validate(struct rte_flow_classifier *cls,
  * @return
  *   A valid handle in case of success, NULL otherwise.
  */
-__rte_experimental
 struct rte_flow_classify_rule *
 rte_flow_classify_table_entry_add(struct rte_flow_classifier *cls,
 		const struct rte_flow_attr *attr,
@@ -251,7 +246,6 @@  rte_flow_classify_table_entry_add(struct rte_flow_classifier *cls,
  * @return
  *   0 on success, error code otherwise.
  */
-__rte_experimental
 int
 rte_flow_classify_table_entry_delete(struct rte_flow_classifier *cls,
 		struct rte_flow_classify_rule *rule);
@@ -273,7 +267,6 @@  rte_flow_classify_table_entry_delete(struct rte_flow_classifier *cls,
  * @return
  *   0 on success, error code otherwise.
  */
-__rte_experimental
 int
 rte_flow_classifier_query(struct rte_flow_classifier *cls,
 		struct rte_mbuf **pkts,
diff --git a/lib/flow_classify/version.map b/lib/flow_classify/version.map
index 49bc25c6a0..b7a888053b 100644
--- a/lib/flow_classify/version.map
+++ b/lib/flow_classify/version.map
@@ -1,4 +1,4 @@ 
-EXPERIMENTAL {
+DPDK_22 {
 	global:
 
 	rte_flow_classifier_create;