diff mbox

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

Message ID 1515789935-3794-1-git-send-email-erik.g.carrillo@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Carrillo, Erik G Jan. 12, 2018, 8:45 p.m. UTC 
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(+)

Comments

Ferruh Yigit Feb. 13, 2018, 2:37 p.m. UTC | #1 
On 1/12/2018 8:45 PM, Erik Gabriel Carrillo wrote:
> 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>

Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
Van Haaren, Harry Feb. 13, 2018, 2:43 p.m. UTC | #2 
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Ferruh Yigit

> Sent: Tuesday, February 13, 2018 2:38 PM

> To: Carrillo, Erik G <erik.g.carrillo@intel.com>; nhorman@tuxdriver.com

> Cc: dev@dpdk.org; pbhagavatula@caviumnetworks.com; aconole@redhat.com;

> thomas@monjalon.net

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

> function

> 

> On 1/12/2018 8:45 PM, Erik Gabriel Carrillo wrote:

> > 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>

> 

> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>



Ah yes, lets make the return be 1 if the correct RTE_ROLE is probed - makes sense.

@Pavan, as original author of code, do you have an Ack for this? :)


Acked-by: Harry van Haaren <harry.van.haaren@intel.com>
Pavan Nikhilesh Feb. 13, 2018, 2:47 p.m. UTC | #3 
On Tue, Feb 13, 2018 at 02:43:39PM +0000, Van Haaren, Harry wrote:
> > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Ferruh Yigit
> > Sent: Tuesday, February 13, 2018 2:38 PM
> > To: Carrillo, Erik G <erik.g.carrillo@intel.com>; nhorman@tuxdriver.com
> > Cc: dev@dpdk.org; pbhagavatula@caviumnetworks.com; aconole@redhat.com;
> > thomas@monjalon.net
> > Subject: Re: [dpdk-dev] [PATCH 1/1] doc: announce API change to lcore role
> > function
> >
> > On 1/12/2018 8:45 PM, Erik Gabriel Carrillo wrote:
> > > 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>
> >
> > Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
>
>
> Ah yes, lets make the return be 1 if the correct RTE_ROLE is probed - makes sense.
>
> @Pavan, as original author of code, do you have an Ack for this? :)
>
>
> Acked-by: Harry van Haaren <harry.van.haaren@intel.com>

Acked-by: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
Thomas Monjalon Feb. 14, 2018, 12:09 a.m. UTC | #4 
12/01/2018 21:45, Erik Gabriel Carrillo:
> 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>
> ---
> +* 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.

It will introduce some subtle bugs in applications.
We must clearly advertise this API change in the release notes.

Acked-by: Thomas Monjalon <thomas@monjalon.net>
Thomas Monjalon Feb. 14, 2018, 10:59 a.m. UTC | #5 
14/02/2018 01:09, Thomas Monjalon:
> 12/01/2018 21:45, Erik Gabriel Carrillo:
> > 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>
> > ---
> > +* 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.
> 
> It will introduce some subtle bugs in applications.
> We must clearly advertise this API change in the release notes.
> 
> Acked-by: Thomas Monjalon <thomas@monjalon.net>

Applied
diff mbox

Patch

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: