[dpdk-dev] [PATCH] doc: announce the deprecation of lcore state FINISHED

[Honnappa Nagarahalli]

Lcore state FINISHED is used by the worker thread to indicate that
it has completed the assigned task. The state is changed to
WAIT by another thread after it observes the updated state. This
additional step is redundant. After this deprecation, the worker
thread will update the state to WAIT.

Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli at arm.com>
Reviewed-by: Ruifeng Wang <ruifeng.wang at arm.com>
---
More discussion at:
http://patches.dpdk.org/project/dpdk/patch/20210224212018.17576-4-honnappa.nagarahalli@arm.com/

 doc/guides/rel_notes/deprecation.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 9584d6bfd7..3adbde9e94 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -11,6 +11,10 @@ here.
 Deprecation Notices
 -------------------
 
+* eal: The lcore state FINISHED will be removed from the enum
+  rte_lcore_state_t. The lcore state WAIT is enough to represent the same
+  state.
+
 * kvargs: The function ``rte_kvargs_process`` will get a new parameter
   for returning key match count. It will ease handling of no-match case.
 
-- 
2.17.1