[5/5] eal: deprecate rte thread setname API

Message ID 1670439617-9054-6-git-send-email-roretzla@linux.microsoft.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series add lcore set name and get name API |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation fail Compilation issues
ci/intel-Testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-aarch64-unit-testing fail Testing issues
ci/github-robot: build fail github build: failed
ci/iol-testing fail Testing issues
ci/iol-x86_64-unit-testing fail Testing issues
ci/iol-x86_64-compile-testing fail Testing issues
ci/iol-aarch64-compile-testing fail Testing issues
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS

Commit Message

Tyler Retzlaff Dec. 7, 2022, 7 p.m. UTC
  Notify deprecation of rte_thread_setname API, it is being removed as it
exposes platform-specific thread details. The functionality it provided
is now implicitly provided via the rte_lcore_set_name API if the
underlying platform supports it.

Signed-off-by: Tyler Retzlaff <roretzla@linux.microsoft.com>
---
 doc/guides/rel_notes/deprecation.rst | 4 ++++
 lib/eal/include/rte_lcore.h          | 1 +
 2 files changed, 5 insertions(+)
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index b9b02dc..b03c935 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -119,3 +119,7 @@  Deprecation Notices
   Its removal has been postponed to let potential users report interest
   in maintaining it.
   In the absence of such interest, this library will be removed in DPDK 23.11.
+
+* eal: The function ``rte_thread_setname`` will be removed, continuing
+  the effort to decouple EAL from platform-specific thread
+  implementations.
diff --git a/lib/eal/include/rte_lcore.h b/lib/eal/include/rte_lcore.h
index 944d89e..3ca9c52 100644
--- a/lib/eal/include/rte_lcore.h
+++ b/lib/eal/include/rte_lcore.h
@@ -393,6 +393,7 @@  enum rte_lcore_role_t {
  * @return
  *   On success, return 0; otherwise return a negative value.
  */
+__rte_deprecated
 int rte_thread_setname(pthread_t id, const char *name);
 
 /**