Re: [dpdk-stable] [dpdk-dev] [PATCH] eal: fix doxygen for EAL cleanup

[Thomas Monjalon <thomas@monjalon.net>]

09/10/2020 09:24, David Marchand:
> > --- a/lib/librte_eal/include/rte_eal.h
> > +++ b/lib/librte_eal/include/rte_eal.h
> > @@ -130,8 +130,9 @@ int rte_eal_init(int argc, char **argv);
> >   * be made. It is expected that common usage of this function is to call it
> >   * just before terminating the process.
> >   *
> > - * @return 0 Successfully released all internal EAL resources
> > - * @return -EFAULT There was an error in releasing all resources.
> > + * @return
> > + *  - 0 Successfully released all internal EAL resources.
> > + *  - -EFAULT There was an error in releasing all resources.
> >   */
> >  int rte_eal_cleanup(void);
> 
> Side note, this function has never returned anything but 0.
> Is this some stale doxygen comment from the introduction of this function?
> 
> I wonder what an application could do if the cleanup failed, anyway.
> EAL will probably have error logs in such a situation?

I think it's quite useful to programmatically know
whether the cleanup was done properly or not.
There's nothing to do except warn the user that a reboot may be needed :)

Note ethdev close is returning error now.