From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 35FA8423B9; Thu, 12 Jan 2023 18:42:35 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 029A242DC3; Thu, 12 Jan 2023 18:42:12 +0100 (CET) Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by mails.dpdk.org (Postfix) with ESMTP id C110E42DAD for ; Thu, 12 Jan 2023 18:42:09 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1673545329; x=1705081329; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=+dOFKOrRDPR4Lsn7E6XKEDj8KbRarU0Cc1BYIqPh/Bk=; b=LLBdHMP8HthLg35UeLi9lZDv7DMID0ow5wFiEOEqIiJbo3a8TgU1R96U tJhGdjCitv0X4WaBfpbRPtLZtoaL6b+aedt5Y8XuLCiLvITdpe+vJqY2V //q1wNkD6AYp4e1rAGQrfZVZnusmoe9xKB4ZrfxJ0/BQNdM0//77C52WT mqGmWSb/VkqYDX8LScwOfnnHQu8obKBM5U629bt0yT/Iv/GyAYOzQc78H vPlV9emecxfDOQkjdxNkDB1nv0k8QH2zH5YvSVaiPY8+7o5I0LiOb3e8n BPj7OxvSCVru6Asa0kJJuxnxBZwAVezrThhdAcRmIy1BIuGpVCfnRS3Zj g==; X-IronPort-AV: E=McAfee;i="6500,9779,10588"; a="388264906" X-IronPort-AV: E=Sophos;i="5.97,211,1669104000"; d="scan'208";a="388264906" Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by orsmga105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 12 Jan 2023 09:42:09 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6500,9779,10588"; a="986678213" X-IronPort-AV: E=Sophos;i="5.97,211,1669104000"; d="scan'208";a="986678213" Received: from silpixa00401385.ir.intel.com ([10.237.214.166]) by fmsmga005.fm.intel.com with ESMTP; 12 Jan 2023 09:42:08 -0800 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson , Ciara Power Subject: [PATCH v3 6/9] telemetry: mark old names of renamed fns as deprecated Date: Thu, 12 Jan 2023 17:41:13 +0000 Message-Id: <20230112174116.2105237-7-bruce.richardson@intel.com> X-Mailer: git-send-email 2.37.2 In-Reply-To: <20230112174116.2105237-1-bruce.richardson@intel.com> References: <20221213182730.97065-1-bruce.richardson@intel.com> <20230112174116.2105237-1-bruce.richardson@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org 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 --- 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 +#include #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