From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Cc: Bruce Richardson <bruce.richardson@intel.com>,
Ciara Power <ciara.power@intel.com>
Subject: [PATCH v3 6/9] telemetry: mark old names of renamed fns as deprecated
Date: Thu, 12 Jan 2023 17:41:13 +0000 [thread overview]
Message-ID: <20230112174116.2105237-7-bruce.richardson@intel.com> (raw)
In-Reply-To: <20230112174116.2105237-1-bruce.richardson@intel.com>
Add a deprecation notice for the renaming of the telemetry data u64/uint
functions, and point users to the newer versions of them when building.
To do this, we also need to mark the renamed versions as stable, rather
than experimental.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
Note: This patch adds the deprecation macro *after* the function
prototype rather than before, as adding it before - as with the
experimental tag - causes doxygen to get confused and give errors:
.../lib/telemetry/rte_telemetry.h:141: warning: argument 'd' of command @param is not found in the argument list of __rte_deprecated_msg("use 'rte_tel_data_add_array_uint' instead")
.../lib/telemetry/rte_telemetry.h:141: warning: argument 'x' of command @param is not found in the argument list of __rte_deprecated_msg("use 'rte_tel_data_add_array_uint' instead")
---
doc/guides/rel_notes/deprecation.rst | 5 +++++
lib/telemetry/rte_telemetry.h | 10 +++++-----
lib/telemetry/version.map | 9 ++-------
3 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index b9b02dcef0..98ad6baed5 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -11,6 +11,11 @@ here.
Deprecation Notices
-------------------
+* telemetry: The functions ``rte_tel_data_add_array_u64`` and ``rte_tel_data_add_dict_u64``,
+ used by telemetry callbacks for adding unsigned integer values to be returned to the user,
+ are renamed to ``rte_tel_data_add_array_uint`` and ``rte_tel_data_add_dict_uint`` respectively.
+ As such, the old function names are deprecated and will be removed in a future release.
+
* kvargs: The function ``rte_kvargs_process`` will get a new parameter
for returning key match count. It will ease handling of no-match case.
diff --git a/lib/telemetry/rte_telemetry.h b/lib/telemetry/rte_telemetry.h
index 73a0511807..4598303d5d 100644
--- a/lib/telemetry/rte_telemetry.h
+++ b/lib/telemetry/rte_telemetry.h
@@ -8,7 +8,7 @@
#ifndef _RTE_TELEMETRY_H_
#define _RTE_TELEMETRY_H_
-#include <rte_compat.h>
+#include <rte_common.h>
#ifdef __cplusplus
extern "C" {
@@ -134,7 +134,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_uint(struct rte_tel_data *d, uint64_t x);
@@ -151,7 +150,8 @@ rte_tel_data_add_array_uint(struct rte_tel_data *d, uint64_t x);
* 0 on success, negative errno on error
*/
int
-rte_tel_data_add_array_u64(struct rte_tel_data *d, uint64_t x);
+rte_tel_data_add_array_u64(struct rte_tel_data *d, uint64_t x)
+ __rte_deprecated_msg("use 'rte_tel_data_add_array_uint' instead");
/**
* Add a container to an array. A container is an existing telemetry data
@@ -224,7 +224,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_uint(struct rte_tel_data *d,
const char *name, uint64_t val);
@@ -245,7 +244,8 @@ rte_tel_data_add_dict_uint(struct rte_tel_data *d,
*/
int
rte_tel_data_add_dict_u64(struct rte_tel_data *d,
- const char *name, uint64_t val);
+ const char *name, uint64_t val)
+ __rte_deprecated_msg("use 'rte_tel_data_add_dict_uint' instead");
/**
* Add a container to a dictionary. A container is an existing telemetry data
diff --git a/lib/telemetry/version.map b/lib/telemetry/version.map
index 0f70d82dfc..d661180317 100644
--- a/lib/telemetry/version.map
+++ b/lib/telemetry/version.map
@@ -5,10 +5,12 @@ DPDK_23 {
rte_tel_data_add_array_int;
rte_tel_data_add_array_string;
rte_tel_data_add_array_u64;
+ rte_tel_data_add_array_uint;
rte_tel_data_add_dict_container;
rte_tel_data_add_dict_int;
rte_tel_data_add_dict_string;
rte_tel_data_add_dict_u64;
+ rte_tel_data_add_dict_uint;
rte_tel_data_alloc;
rte_tel_data_free;
rte_tel_data_start_array;
@@ -19,13 +21,6 @@ DPDK_23 {
local: *;
};
-EXPERIMENTAL {
- global:
-
- rte_tel_data_add_array_uint;
- rte_tel_data_add_dict_uint;
-};
-
INTERNAL {
rte_telemetry_legacy_register;
rte_telemetry_init;
--
2.37.2
next prev parent reply other threads:[~2023-01-12 17:42 UTC|newest]
Thread overview: 51+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-12-13 18:27 [RFC PATCH 0/7] Standardize telemetry int types Bruce Richardson
2022-12-13 18:27 ` [RFC PATCH 1/7] telemetry: rename unsigned 64-bit enum value to uint Bruce Richardson
2022-12-14 17:30 ` Tyler Retzlaff
2022-12-15 9:41 ` Bruce Richardson
2022-12-15 17:53 ` Tyler Retzlaff
2022-12-13 18:27 ` [RFC PATCH 2/7] telemetry: add uint type as alias for u64 Bruce Richardson
2022-12-14 17:38 ` Tyler Retzlaff
2022-12-15 9:44 ` Bruce Richardson
2022-12-15 13:36 ` Thomas Monjalon
2022-12-15 13:58 ` Bruce Richardson
2022-12-19 10:37 ` Thomas Monjalon
2022-12-19 13:22 ` Bruce Richardson
2022-12-15 17:58 ` Tyler Retzlaff
2022-12-15 1:49 ` lihuisong (C)
2022-12-15 9:42 ` Bruce Richardson
2022-12-15 18:02 ` Tyler Retzlaff
2022-12-13 18:27 ` [RFC PATCH 3/7] telemetry: remove RTE prefix from internal enum values Bruce Richardson
2022-12-13 18:27 ` [RFC PATCH 4/7] telemetry: make array initialization more robust Bruce Richardson
2022-12-14 17:50 ` Tyler Retzlaff
2023-01-09 12:16 ` Bruce Richardson
2023-01-09 17:49 ` Tyler Retzlaff
2023-01-10 9:11 ` Ferruh Yigit
2022-12-13 18:27 ` [RFC PATCH 5/7] telemetry: update json functions to use int/uint in names Bruce Richardson
2022-12-13 18:27 ` [RFC PATCH 6/7] telemetry: make internal int representation 64-bits Bruce Richardson
2022-12-13 18:27 ` [RFC PATCH 7/7] telemetry: change public API to use 64-bit signed values Bruce Richardson
2022-12-13 20:19 ` Morten Brørup
2022-12-14 17:53 ` Tyler Retzlaff
2022-12-15 2:39 ` lihuisong (C)
2023-01-12 10:58 ` [PATCH v2 0/9] Standardize telemetry int types Bruce Richardson
2023-01-12 10:58 ` [PATCH v2 1/9] telemetry: remove RTE prefix from internal enum values Bruce Richardson
2023-01-12 10:58 ` [PATCH v2 2/9] telemetry: make array initialization more robust Bruce Richardson
2023-01-12 10:58 ` [PATCH v2 3/9] telemetry: rename unsigned 64-bit enum value to uint Bruce Richardson
2023-01-12 10:58 ` [PATCH v2 4/9] telemetry: add uint type as alias for u64 Bruce Richardson
2023-01-12 10:58 ` [PATCH v2 5/9] global: rename telemetry functions to newer versions Bruce Richardson
2023-01-12 10:59 ` [PATCH v2 6/9] telemetry: mark old names of renamed fns as deprecated Bruce Richardson
2023-01-12 10:59 ` [PATCH v2 7/9] telemetry: update json functions to use int/uint in names Bruce Richardson
2023-01-12 10:59 ` [PATCH v2 8/9] telemetry: make internal int representation 64-bits Bruce Richardson
2023-01-12 10:59 ` [PATCH v2 9/9] telemetry: change public API to use 64-bit signed values Bruce Richardson
2023-01-12 17:41 ` [PATCH v3 0/9] Standardize telemetry int types Bruce Richardson
2023-01-12 17:41 ` [PATCH v3 1/9] telemetry: remove RTE prefix from internal enum values Bruce Richardson
2023-01-12 17:41 ` [PATCH v3 2/9] telemetry: make array initialization more robust Bruce Richardson
2023-01-12 17:41 ` [PATCH v3 3/9] telemetry: rename unsigned 64-bit enum value to uint Bruce Richardson
2023-01-12 17:41 ` [PATCH v3 4/9] telemetry: add uint type as alias for u64 Bruce Richardson
2023-01-12 17:41 ` [PATCH v3 5/9] global: rename telemetry functions to newer versions Bruce Richardson
2023-01-12 17:41 ` Bruce Richardson [this message]
2023-01-12 17:41 ` [PATCH v3 7/9] telemetry: update json functions to use int/uint in names Bruce Richardson
2023-01-12 17:41 ` [PATCH v3 8/9] telemetry: make internal int representation 64-bits Bruce Richardson
2023-01-12 17:41 ` [PATCH v3 9/9] telemetry: change public API to use 64-bit signed values Bruce Richardson
2023-02-05 22:55 ` Thomas Monjalon
2023-01-13 16:39 ` [PATCH v3 0/9] Standardize telemetry int types Power, Ciara
2023-02-05 23:15 ` 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=20230112174116.2105237-7-bruce.richardson@intel.com \
--to=bruce.richardson@intel.com \
--cc=ciara.power@intel.com \
--cc=dev@dpdk.org \
/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).