[dpdk-dev] [PATCH 1/1] doc: announce API change to lcore role function

[Erik Gabriel Carrillo <erik.g.carrillo@intel.com>]

This an API/ABI change notice for DPDK 18.05 announcing a change in
the meaning of the return values of the rte_lcore_has_role() function.

Signed-off-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 13e8543..15a94cf 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -21,6 +21,11 @@ Deprecation Notices
   - ``rte_eal_devargs_type_count``
   - ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse``
 
+* eal: The semantics of the return value for the ``rte_lcore_has_role`` function
+  are planned to change in v18.05. The function currently returns 0 and <0 for
+  success and failure, respectively.  This will change to 1 and 0 for true and
+  false, respectively, to make use of the function more intuitive.
+
 * pci: Several exposed functions are misnamed.
   The following functions are deprecated starting from v17.11 and are replaced:
 
-- 
2.6.4