patches for DPDK stable branches
 help / color / Atom feed
From: David Marchand <david.marchand@redhat.com>
To: Harry van Haaren <harry.van.haaren@intel.com>
Cc: dpdk stable <stable@dpdk.org>, dev <dev@dpdk.org>,
	 Vipin Varghese <vipin.varghese@intel.com>
Subject: Re: [dpdk-stable] [dpdk-dev] [PATCH] eal: fix doxygen for EAL cleanup
Date: Fri, 9 Oct 2020 09:24:35 +0200
Message-ID: <CAJFAV8zRGs5h41rT7TEPDdBg5GQk8qhCd4_6F9oxp6HFLYW7EQ@mail.gmail.com> (raw)
In-Reply-To: <20201009071554.30510-1-david.marchand@redhat.com>

On Fri, Oct 9, 2020 at 9:16 AM David Marchand <david.marchand@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@dpdk.org
>
> Signed-off-by: David Marchand <david.marchand@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


  reply index

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-09  7:15 [dpdk-stable] " David Marchand
2020-10-09  7:24 ` David Marchand [this message]
2020-10-09  7:41   ` [dpdk-stable] [dpdk-dev] " Thomas Monjalon
2020-10-12 12:20 ` David Marchand

Reply instructions:

You may reply publically 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=CAJFAV8zRGs5h41rT7TEPDdBg5GQk8qhCd4_6F9oxp6HFLYW7EQ@mail.gmail.com \
    --to=david.marchand@redhat.com \
    --cc=dev@dpdk.org \
    --cc=harry.van.haaren@intel.com \
    --cc=stable@dpdk.org \
    --cc=vipin.varghese@intel.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

patches for DPDK stable branches

Archives are clonable:
	git clone --mirror http://inbox.dpdk.org/stable/0 stable/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 stable stable/ http://inbox.dpdk.org/stable \
		stable@dpdk.org
	public-inbox-index stable


Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.stable


AGPL code for this site: git clone https://public-inbox.org/ public-inbox