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

[David Marchand]

On Fri, Oct 9, 2020 at 9:16 AM David Marchand <david.marchand at redhat.com> wrote:
>
> Align rte_eal_cleanup return codes description to the rest of dpdk.
>
> Fixes: aec9c13c5257 ("eal: add function to release internal resources")
> Cc: stable at dpdk.org
>
> Signed-off-by: David Marchand <david.marchand at redhat.com>
> ---
>  lib/librte_eal/include/rte_eal.h | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/lib/librte_eal/include/rte_eal.h b/lib/librte_eal/include/rte_eal.h
> index ddcf6a2e7a..e3c2ef185e 100644
> --- 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?


-- 
David Marchand