DPDK patches and discussions
 help / color / mirror / Atom feed
From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Cc: ciara.power@intel.com, mdr@ashroe.eu,
	Bruce Richardson <bruce.richardson@intel.com>
Subject: [dpdk-dev] [PATCH v2] telemetry: remove experimental tags from APIs
Date: Wed, 15 Sep 2021 17:55:35 +0100	[thread overview]
Message-ID: <20210915165535.24616-1-bruce.richardson@intel.com> (raw)
In-Reply-To: <20210702152305.606933-1-bruce.richardson@intel.com>

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>
---
v2: remove note from docs about telemetry being experimental.

 doc/guides/howto/telemetry.rst |  4 ----
 lib/telemetry/rte_telemetry.h  | 18 ------------------
 lib/telemetry/version.map      |  2 +-
 3 files changed, 1 insertion(+), 23 deletions(-)

diff --git a/doc/guides/howto/telemetry.rst b/doc/guides/howto/telemetry.rst
index cf73dc41ce..8f4fa1a510 100644
--- a/doc/guides/howto/telemetry.rst
+++ b/doc/guides/howto/telemetry.rst
@@ -9,10 +9,6 @@ The Telemetry library provides users with the ability to query DPDK for
 telemetry information, currently including information such as ethdev stats,
 ethdev port list, and eal parameters.

-.. Note::
-
-   This library is experimental and the output format may change in the future.
-

 Telemetry Interface
 -------------------
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;
--
2.32.0


  parent reply	other threads:[~2021-09-15 16:55 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-07-02 15:23 [dpdk-dev] [PATCH 21.11] " Bruce Richardson
2021-07-05 10:09 ` Power, Ciara
2021-07-05 10:58   ` Bruce Richardson
2021-09-15 16:55 ` Bruce Richardson [this message]
2021-09-16  8:13   ` [dpdk-dev] [PATCH v2] " Power, Ciara
2021-09-27 13:03   ` Kinsella, Ray
2021-10-01 15:10     ` Thomas Monjalon

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210915165535.24616-1-bruce.richardson@intel.com \
    --to=bruce.richardson@intel.com \
    --cc=ciara.power@intel.com \
    --cc=dev@dpdk.org \
    --cc=mdr@ashroe.eu \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).