diff mbox series

telemetry: mark init function as internal-only

Message ID 20210205212358.413871-1-bruce.richardson@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series telemetry: mark init function as internal-only |

Checks

Context Check Description
ci/Intel-compilation fail apply issues
ci/travis-robot warning Travis build: failed
ci/checkpatch success coding style OK

Commit Message

Bruce Richardson Feb. 5, 2021, 9:23 p.m. UTC 
  The "rte_telemetry_init()" function is for use by "rte_eal_init()" and
should not be part of the public API. Mark it as internal only.

Fixes: 6dd571fd07c3 ("telemetry: introduce new functionality")
Cc: stable@dpdk.org

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/guides/rel_notes/release_21_02.rst | 5 +++++
 lib/librte_telemetry/rte_telemetry.h   | 2 +-
 lib/librte_telemetry/version.map       | 5 ++++-
 3 files changed, 10 insertions(+), 2 deletions(-)

Comments

Thomas Monjalon Feb. 9, 2021, 2:10 p.m. UTC | #1 
05/02/2021 22:23, Bruce Richardson:
> The "rte_telemetry_init()" function is for use by "rte_eal_init()" and
> should not be part of the public API. Mark it as internal only.
> 
> Fixes: 6dd571fd07c3 ("telemetry: introduce new functionality")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>

Applied, thanks
diff mbox series

Patch

diff --git a/doc/guides/rel_notes/release_21_02.rst b/doc/guides/rel_notes/release_21_02.rst
index baf32151f..84b04a018 100644
--- a/doc/guides/rel_notes/release_21_02.rst
+++ b/doc/guides/rel_notes/release_21_02.rst
@@ -266,6 +266,11 @@  ABI Changes
 
 * No ABI change that would break compatibility with 20.11.
 
+* The experimental function ``rte_telemetry_init`` has been removed from the
+  public API and is now an internal-only function. Where telemetry library is
+  available, it is called automatically from ``rte_eal_init()`` and so no end
+  application need use it.
+
 
 Known Issues
 ------------
diff --git a/lib/librte_telemetry/rte_telemetry.h b/lib/librte_telemetry/rte_telemetry.h
index f6c3992a9..f7c8534b8 100644
--- a/lib/librte_telemetry/rte_telemetry.h
+++ b/lib/librte_telemetry/rte_telemetry.h
@@ -309,7 +309,7 @@  rte_telemetry_register_cmd(const char *cmd, telemetry_cb fn, const char *help);
  * @return
  *  -1 on failure.
  */
-__rte_experimental
+__rte_internal
 int
 rte_telemetry_init(const char *runtime_dir, const char *rte_version, rte_cpuset_t *cpuset,
 		const char **err_str);
diff --git a/lib/librte_telemetry/version.map b/lib/librte_telemetry/version.map
index d1dbf8d58..ec0ebc1be 100644
--- a/lib/librte_telemetry/version.map
+++ b/lib/librte_telemetry/version.map
@@ -14,9 +14,12 @@  EXPERIMENTAL {
 	rte_tel_data_start_array;
 	rte_tel_data_start_dict;
 	rte_tel_data_string;
-	rte_telemetry_init;
 	rte_telemetry_legacy_register;
 	rte_telemetry_register_cmd;
 
 	local: *;
 };
+
+INTERNAL {
+	rte_telemetry_init;
+};