Skip to contentSkip to conversation

doc: add deprecation notice about upcoming change to ethdev API

PATCH Applied Stephen Hemminger 6 participants 6 messages Jun 3 – Jul 22

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: add deprecation notice about upcoming change to ethdev API

Inform users that rte_eth_dev_get_name_by_port() will add a size parameter in next release.

---
 doc/guides/rel_notes/deprecation.rst | 4 ++++
 1 file changed, 4 insertions(+)
doc/guides/rel_notes/deprecation.rst +4 -0
index 17f90a6352..d390a1640a 100644
@@ -158,3 +158,7 @@ Deprecation Notices
 * net/iavf: The dynamic mbuf field used to detect LLDP packets on the
   transmit path in the iavf PMD will be removed in a future release.
   After removal, only packet type-based detection will be supported.
+
+* ethdev: Starting in 26.11, the function ``rte_eth_dev_get_name_by_port()``
+  will take a size parameter as well as the string buffer.
+  This will detect and prevent accidental overwriting of caller provided buffer.
Signature · 1 line
2.53.0
Acked-by on v1 1/1
#1 lore raw
Quoted 5 lines · Stephen Hemminger

Inform users that rte_eth_dev_get_name_by_port() will add a size parameter in next release.

---

Quoted 18 lines
 doc/guides/rel_notes/deprecation.rst | 4 ++++
 1 file changed, 4 insertions(+)
doc/guides/rel_notes/deprecation.rst +4 -0
index 17f90a6352..d390a1640a 100644
@@ -158,3 +158,7 @@ Deprecation Notices
 * net/iavf: The dynamic mbuf field used to detect LLDP packets on the
   transmit path in the iavf PMD will be removed in a future release.
   After removal, only packet type-based detection will be supported.
+
+* ethdev: Starting in 26.11, the function ``rte_eth_dev_get_name_by_port()``
+  will take a size parameter as well as the string buffer.
+  This will detect and prevent accidental overwriting of caller provided buffer.
Signature · 1 line
2.53.0