From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <erik.g.carrillo@intel.com>
Received: from mga09.intel.com (mga09.intel.com [134.134.136.24])
 by dpdk.org (Postfix) with ESMTP id 291813257
 for <dev@dpdk.org>; Fri, 12 Jan 2018 21:45:47 +0100 (CET)
X-Amp-Result: SKIPPED(no attachment in message)
X-Amp-File-Uploaded: False
Received: from fmsmga004.fm.intel.com ([10.253.24.48])
 by orsmga102.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;
 12 Jan 2018 12:45:46 -0800
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.46,350,1511856000"; d="scan'208";a="20543874"
Received: from txasoft-yocto.an.intel.com (HELO txasoft-yocto.an.intel.com.)
 ([10.123.72.111])
 by fmsmga004.fm.intel.com with ESMTP; 12 Jan 2018 12:45:46 -0800
From: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>
To: nhorman@tuxdriver.com
Cc: dev@dpdk.org, pbhagavatula@caviumnetworks.com, aconole@redhat.com,
 thomas@monjalon.net
Date: Fri, 12 Jan 2018 14:45:35 -0600
Message-Id: <1515789935-3794-1-git-send-email-erik.g.carrillo@intel.com>
X-Mailer: git-send-email 1.7.10
Subject: [dpdk-dev] [PATCH 1/1] doc: announce API change to lcore role
	function
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Fri, 12 Jan 2018 20:45:48 -0000

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