[PATCH v2 6/9] telemetry: mark old names of renamed fns as deprecated
Bruce Richardson
bruce.richardson at intel.com
Thu Jan 12 11:59:00 CET 2023
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 at 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
More information about the dev
mailing list