[dpdk-dev] cfgfile: fix return value comment

Message ID 1460761123-5752-1-git-send-email-bombermag@gmail.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers

Commit Message

Dmitriy Yakovlev April 15, 2016, 10:58 p.m. UTC
  Function rte_cfgfile_load can return NULL value, when something goes wrong.

Signed-off-by: Dmitriy Yakovlev <bombermag@gmail.com>
---
 lib/librte_cfgfile/rte_cfgfile.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Comments

Cristian Dumitrescu April 18, 2016, 8:21 a.m. UTC | #1
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Dmitriy Yakovlev
> Sent: Friday, April 15, 2016 11:59 PM
> To: dev@dpdk.org
> Cc: Dmitriy Yakovlev <bombermag@gmail.com>
> Subject: [dpdk-dev] [PATCH] cfgfile: fix return value comment
> 
> Function rte_cfgfile_load can return NULL value, when something goes
> wrong.
> 
> Signed-off-by: Dmitriy Yakovlev <bombermag@gmail.com>
> ---
>  lib/librte_cfgfile/rte_cfgfile.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/lib/librte_cfgfile/rte_cfgfile.h b/lib/librte_cfgfile/rte_cfgfile.h
> index 834f828..f649836 100644
> --- a/lib/librte_cfgfile/rte_cfgfile.h
> +++ b/lib/librte_cfgfile/rte_cfgfile.h
> @@ -72,7 +72,7 @@ struct rte_cfgfile_entry {
>  * @param flags
>  *   Config file flags, Reserved for future use. Must be set to 0.
>  * @return
> -*   Handle to configuration file
> +*   Handle to configuration file on success, NULL otherwise
>  */
>  struct rte_cfgfile *rte_cfgfile_load(const char *filename, int flags);
> 
> --
> 2.6.2.windows.1

Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
  
Thomas Monjalon May 2, 2016, 12:58 p.m. UTC | #2
> > Function rte_cfgfile_load can return NULL value, when something goes
> > wrong.
> > 
> > Signed-off-by: Dmitriy Yakovlev <bombermag@gmail.com>
> Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>

Applied, thanks
  

Patch

diff --git a/lib/librte_cfgfile/rte_cfgfile.h b/lib/librte_cfgfile/rte_cfgfile.h
index 834f828..f649836 100644
--- a/lib/librte_cfgfile/rte_cfgfile.h
+++ b/lib/librte_cfgfile/rte_cfgfile.h
@@ -72,7 +72,7 @@  struct rte_cfgfile_entry {
 * @param flags
 *   Config file flags, Reserved for future use. Must be set to 0.
 * @return
-*   Handle to configuration file
+*   Handle to configuration file on success, NULL otherwise
 */
 struct rte_cfgfile *rte_cfgfile_load(const char *filename, int flags);