diff mbox series

[21.11] telemetry: remove experimental tags from APIs

Message ID 20210702152305.606933-1-bruce.richardson@intel.com (mailing list archive)
State Superseded
Delegated to: Thomas Monjalon
Headers show
Series [21.11] telemetry: remove experimental tags from APIs | expand

Checks

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

Commit Message

Bruce Richardson July 2, 2021, 3:23 p.m. UTC
The telemetry APIs have been present and unchanged for >1 year now, so
remove experimental tag from them.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 lib/telemetry/rte_telemetry.h | 18 ------------------
 lib/telemetry/version.map     |  2 +-
 2 files changed, 1 insertion(+), 19 deletions(-)

Comments

Ciara Power July 5, 2021, 10:09 a.m. UTC | #1
>-----Original Message-----
>From: Richardson, Bruce <bruce.richardson@intel.com>
>Sent: Friday 2 July 2021 16:23
>To: dev@dpdk.org
>Cc: Ray Kinsella <mdr@ashroe.eu>; Power, Ciara <ciara.power@intel.com>;
>Richardson, Bruce <bruce.richardson@intel.com>
>Subject: [PATCH 21.11] telemetry: remove experimental tags from APIs
>
>The telemetry APIs have been present and unchanged for >1 year now, so
>remove experimental tag from them.
>
>Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
>---
> lib/telemetry/rte_telemetry.h | 18 ------------------
> lib/telemetry/version.map     |  2 +-
> 2 files changed, 1 insertion(+), 19 deletions(-)
>
<snip>

Hi Bruce,

+1 for this change.

I think there are some experimental tags missing from this patch - the legacy telemetry functions that are in "metrics/rte_metrics_telemetry.h" currently have the tags too.
Also, there is a reference to the library being experimental in the Telemetry User Guide doc.

Thanks,
Ciara
Bruce Richardson July 5, 2021, 10:58 a.m. UTC | #2
On Mon, Jul 05, 2021 at 11:09:38AM +0100, Power, Ciara wrote:
> 
> 
> >-----Original Message-----
> >From: Richardson, Bruce <bruce.richardson@intel.com>
> >Sent: Friday 2 July 2021 16:23
> >To: dev@dpdk.org
> >Cc: Ray Kinsella <mdr@ashroe.eu>; Power, Ciara <ciara.power@intel.com>;
> >Richardson, Bruce <bruce.richardson@intel.com>
> >Subject: [PATCH 21.11] telemetry: remove experimental tags from APIs
> >
> >The telemetry APIs have been present and unchanged for >1 year now, so
> >remove experimental tag from them.
> >
> >Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> >---
> > lib/telemetry/rte_telemetry.h | 18 ------------------
> > lib/telemetry/version.map     |  2 +-
> > 2 files changed, 1 insertion(+), 19 deletions(-)
> >
> <snip>
> 
> Hi Bruce,
> 
> +1 for this change.
> 
> I think there are some experimental tags missing from this patch - the legacy telemetry functions that are in "metrics/rte_metrics_telemetry.h" currently have the tags too.

I'm not sure about making those part of the stable ABI.

> Also, there is a reference to the library being experimental in the Telemetry User Guide doc.
> 
I missed checking the "howto" doc on telemetry, yes. I'll include that in a
v2.
diff mbox series

Patch

diff --git a/lib/telemetry/rte_telemetry.h b/lib/telemetry/rte_telemetry.h
index 8776998b54..d3c61ffcd3 100644
--- a/lib/telemetry/rte_telemetry.h
+++ b/lib/telemetry/rte_telemetry.h
@@ -24,10 +24,6 @@ 
  *
  * RTE Telemetry.
  *
- * @warning
- * @b EXPERIMENTAL:
- * All functions in this file may be changed or removed without prior notice.
- *
  * The telemetry library provides a method to retrieve statistics from
  * DPDK by sending a request message over a socket. DPDK will send
  * a JSON encoded response containing telemetry data.
@@ -59,7 +55,6 @@  enum rte_tel_value_type {
  * @return
  *   0 on success, negative errno on error
  */
-__rte_experimental
 int
 rte_tel_data_start_array(struct rte_tel_data *d, enum rte_tel_value_type type);
 
@@ -71,7 +66,6 @@  rte_tel_data_start_array(struct rte_tel_data *d, enum rte_tel_value_type type);
  * @return
  *   0 on success, negative errno on error
  */
-__rte_experimental
 int
 rte_tel_data_start_dict(struct rte_tel_data *d);
 
@@ -85,7 +79,6 @@  rte_tel_data_start_dict(struct rte_tel_data *d);
  * @return
  *   0 on success, negative errno on error, E2BIG on string truncation
  */
-__rte_experimental
 int
 rte_tel_data_string(struct rte_tel_data *d, const char *str);
 
@@ -101,7 +94,6 @@  rte_tel_data_string(struct rte_tel_data *d, const char *str);
  * @return
  *   0 on success, negative errno on error, E2BIG on string truncation
  */
-__rte_experimental
 int
 rte_tel_data_add_array_string(struct rte_tel_data *d, const char *str);
 
@@ -117,7 +109,6 @@  rte_tel_data_add_array_string(struct rte_tel_data *d, const char *str);
  * @return
  *   0 on success, negative errno on error
  */
-__rte_experimental
 int
 rte_tel_data_add_array_int(struct rte_tel_data *d, int x);
 
@@ -133,7 +124,6 @@  rte_tel_data_add_array_int(struct rte_tel_data *d, int x);
  * @return
  *   0 on success, negative errno on error
  */
-__rte_experimental
 int
 rte_tel_data_add_array_u64(struct rte_tel_data *d, uint64_t x);
 
@@ -154,7 +144,6 @@  rte_tel_data_add_array_u64(struct rte_tel_data *d, uint64_t x);
  * @return
  *   0 on success, negative errno on error
  */
-__rte_experimental
 int
 rte_tel_data_add_array_container(struct rte_tel_data *d,
 		struct rte_tel_data *val, int keep);
@@ -173,7 +162,6 @@  rte_tel_data_add_array_container(struct rte_tel_data *d,
  *   0 on success, negative errno on error, E2BIG on string truncation of
  *   either name or value.
  */
-__rte_experimental
 int
 rte_tel_data_add_dict_string(struct rte_tel_data *d, const char *name,
 		const char *val);
@@ -191,7 +179,6 @@  rte_tel_data_add_dict_string(struct rte_tel_data *d, const char *name,
  * @return
  *   0 on success, negative errno on error, E2BIG on string truncation of name.
  */
-__rte_experimental
 int
 rte_tel_data_add_dict_int(struct rte_tel_data *d, const char *name, int val);
 
@@ -208,7 +195,6 @@  rte_tel_data_add_dict_int(struct rte_tel_data *d, const char *name, int val);
  * @return
  *   0 on success, negative errno on error, E2BIG on string truncation of name.
  */
-__rte_experimental
 int
 rte_tel_data_add_dict_u64(struct rte_tel_data *d,
 		const char *name, uint64_t val);
@@ -232,7 +218,6 @@  rte_tel_data_add_dict_u64(struct rte_tel_data *d,
  * @return
  *   0 on success, negative errno on error
  */
-__rte_experimental
 int
 rte_tel_data_add_dict_container(struct rte_tel_data *d, const char *name,
 		struct rte_tel_data *val, int keep);
@@ -285,7 +270,6 @@  typedef void * (*handler)(void *sock_id);
  *  @return
  *  -ENOMEM for mem allocation failure.
  */
-__rte_experimental
 int
 rte_telemetry_register_cmd(const char *cmd, telemetry_cb fn, const char *help);
 
@@ -297,7 +281,6 @@  rte_telemetry_register_cmd(const char *cmd, telemetry_cb fn, const char *help);
  * @return
  *  Pointer to a container.
  */
-__rte_experimental
 struct rte_tel_data *
 rte_tel_data_alloc(void);
 
@@ -309,7 +292,6 @@  rte_tel_data_alloc(void);
  *  Pointer to container.
  *.
  */
-__rte_experimental
 void
 rte_tel_data_free(struct rte_tel_data *data);
 
diff --git a/lib/telemetry/version.map b/lib/telemetry/version.map
index bde80ce29b..77528bb1fe 100644
--- a/lib/telemetry/version.map
+++ b/lib/telemetry/version.map
@@ -1,4 +1,4 @@ 
-EXPERIMENTAL {
+DPDK_22 {
 	global:
 
 	rte_tel_data_add_array_container;