diff mbox series

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

Message ID 20200727192015.26418-2-stephen@networkplumber.org (mailing list archive)
State Superseded, 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-broadcom-Performance success Performance Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/Intel-compilation success Compilation OK
ci/iol-testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS

Commit Message

Stephen Hemminger July 27, 2020, 7:20 p.m. UTC 
  Announce upcoming changes related to master/slave in reference
to lcore.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/rel_notes/deprecation.rst | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

Comments

Burakov, Anatoly July 29, 2020, 9:23 a.m. UTC | #1 
On 27-Jul-20 8:20 PM, Stephen Hemminger wrote:
> Announce upcoming changes related to master/slave in reference
> to lcore.
> 
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> ---
>   doc/guides/rel_notes/deprecation.rst | 17 +++++++++++++++++
>   1 file changed, 17 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 99c98062ffc2..31a2b942fba5 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -148,3 +148,20 @@ Deprecation Notices
>     Python 2 support will be completely removed in 20.11.
>     In 20.08, explicit deprecation warnings will be displayed when running
>     scripts with Python 2.
> +
> +* 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 21.11 version.
> +
> +  The macros related to primary and secondary lcore will also
> +  be change:  ``RTE_LCORE_FOREACH_SLAVE`` will be replaced

^^

I think this was supposed to be either "will also change" or "will also 
be changed", but got mashed together :)

> +  with ``RTE_LCORE_FOREACH_WORKER``.
> +
> +  The ``master-lcore`` argument to testpmd will be replaced
> +  with ``initial-lcore``.
>
diff mbox series

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 99c98062ffc2..31a2b942fba5 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -148,3 +148,20 @@  Deprecation Notices
   Python 2 support will be completely removed in 20.11.
   In 20.08, explicit deprecation warnings will be displayed when running
   scripts with Python 2.
+
+* 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 21.11 version.
+
+  The macros related to primary and secondary lcore will also
+  be 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``.