DPDK patches and discussions
 help / color / mirror / Atom feed
From: Thomas Monjalon <thomas@monjalon.net>
To: "Carrillo, Erik G" <erik.g.carrillo@intel.com>
Cc: "Burakov, Anatoly" <anatoly.burakov@intel.com>,
	"dev@dpdk.org" <dev@dpdk.org>,
	Neil Horman <nhorman@tuxdriver.com>,
	"Mcnamara, John" <john.mcnamara@intel.com>,
	"Kovacevic, Marko" <marko.kovacevic@intel.com>,
	Robert Sanford <rsanford@akamai.com>,
	"olivier.matz@6wind.com" <olivier.matz@6wind.com>,
	"shreyansh.jain@nxp.com" <shreyansh.jain@nxp.com>
Subject: Re: [dpdk-dev] [PATCH] lcore: make semantics of lcore role function more intuitive
Date: Thu, 26 Apr 2018 16:54:42 +0200	[thread overview]
Message-ID: <5414097.qiRGovPonW@xps> (raw)
In-Reply-To: <BE54F058557D9A4FAC1D84E2FC6D87570EE2DACC@fmsmsx115.amr.corp.intel.com>

26/04/2018 16:44, Carrillo, Erik G:
> Thanks,  Anatoly and Thomas.  I had also considered the following chunk for the release notes:
> 
> diff --git a/doc/guides/rel_notes/release_18_05.rst b/doc/guides/rel_notes/release_18_05.rst
> index 04ff4fe..127a7e2 100644                                                   
> --- a/doc/guides/rel_notes/release_18_05.rst                                    
> +++ b/doc/guides/rel_notes/release_18_05.rst                                    
> @@ -72,6 +72,11 @@ API Changes                                                  
>     Also, make sure to start the actual text at the margin.                     
>     =========================================================                   
>                                                                                 
> +* **rte_lcore_has_role() return values changed**                               
> +                                                                               
> +  This function now returns 1 or 0 for true or false, respectively, rather        
> +  than 0 or <0 for success or failure to make use of the function more         
> +  intuitive.                                                                   
>                                                                                 
>  ABI Changes                                                                    
>  -----------
> 
> Do we want this note?  Also, it looks like the Doxygen documentation of the function in the header file didn't get updated.


Oh, you are right, this patch is not complete.
I've fixed it:

--- a/doc/guides/rel_notes/release_18_05.rst
+++ b/doc/guides/rel_notes/release_18_05.rst
@@ -161,6 +161,12 @@ API Changes
   announced at least one release before the ABI change is made. There are no
   ABI breaking changes planned.
 
+* eal: ``rte_lcore_has_role()`` return value changed.
+
+  This function now returns true or false, respectively, rather
+  than 0 or <0 for success or failure.
+  It makes use of the function more intuitive.
+
 * mempool: capability flags and related functions have been removed.
 
   Flags ``MEMPOOL_F_CAPA_PHYS_CONTIG`` and
diff --git a/lib/librte_eal/common/include/rte_lcore.h b/lib/librte_eal/common/include/rte_lcore.h
index 334a0629e..1a2f37eaa 100644
--- a/lib/librte_eal/common/include/rte_lcore.h
+++ b/lib/librte_eal/common/include/rte_lcore.h
@@ -311,7 +311,7 @@ rte_ctrl_thread_create(pthread_t *thread, const char *name,
  * @param role
  *   The role to be checked against.
  * @return
- *   On success, return 0; otherwise return a negative value.
+ *   Boolean value: positive if test is true; otherwise returns 0.
  */

Thanks Erik!

  reply	other threads:[~2018-04-26 14:54 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-04-26 13:42 Anatoly Burakov
2018-04-26 14:30 ` Thomas Monjalon
2018-04-26 14:44   ` Carrillo, Erik G
2018-04-26 14:54     ` Thomas Monjalon [this message]
2018-04-26 14:56       ` Carrillo, Erik G
2018-04-26 15:37         ` Stephen Hemminger
2018-04-26 15:38 ` Stephen Hemminger

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=5414097.qiRGovPonW@xps \
    --to=thomas@monjalon.net \
    --cc=anatoly.burakov@intel.com \
    --cc=dev@dpdk.org \
    --cc=erik.g.carrillo@intel.com \
    --cc=john.mcnamara@intel.com \
    --cc=marko.kovacevic@intel.com \
    --cc=nhorman@tuxdriver.com \
    --cc=olivier.matz@6wind.com \
    --cc=rsanford@akamai.com \
    --cc=shreyansh.jain@nxp.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).