diff mbox series

[v3,20.08,1/6] doc: announce deprecation of master lcore

Message ID 20200806171947.6609-2-stephen@networkplumber.org (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series inclusive language fixes and deprecation notices |

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS

Commit Message

Stephen Hemminger Aug. 6, 2020, 5:19 p.m. UTC 
  Announce upcoming changes related to master/slave in reference
to lcore.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

Comments

Thomas Monjalon Aug. 7, 2020, 12:10 a.m. UTC | #1 
06/08/2020 19:19, Stephen Hemminger:
> Announce upcoming changes related to master/slave in reference
> to lcore.
> 
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Acked-by: Thomas Monjalon <thomas@monjalon.net>
diff mbox series

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 299e30d92184..47badff6119a 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -252,3 +252,23 @@  Deprecation Notices
   ``make``. Given environments are too much variables for such a simple script,
   it will be removed in DPDK 20.11.
   Some useful parts may be converted into specific scripts.
+
+* eal: To be more inclusive in choice of naming, the DPDK project
+  will replace uses of master/slave in the API's and command line arguments.
+
+  References to master/slave in relation to lcore will be renamed
+  to initial/worker.  The function ``rte_get_master_lcore()``
+  will be renamed to ``rte_get_initial_lcore()``.
+  For the 20.11 release, both names will be present and the
+  old function will be marked with the deprecated tag.
+  The old function will be removed in a future version.
+
+  The iterator for worker lcores will also change:
+  ``RTE_LCORE_FOREACH_SLAVE`` will be replaced with
+  ``RTE_LCORE_FOREACH_WORKER``.
+
+  The ``master-lcore`` argument to testpmd will be replaced
+  with ``initial-lcore``. The old ``master-lcore`` argument
+  will produce a runtime notification in 20.11 release, and
+  be remove completely in a future release.
+