patches for DPDK stable branches
 help / color / Atom feed
* [dpdk-stable] [PATCH] eal: fix doxygen for EAL cleanup
@ 2020-10-09  7:15 David Marchand
  2020-10-09  7:24 ` [dpdk-stable] [dpdk-dev] " David Marchand
  2020-10-12 12:20 ` David Marchand
  0 siblings, 2 replies; 4+ messages in thread
From: David Marchand @ 2020-10-09  7:15 UTC (permalink / raw)
  To: dev; +Cc: stable, Vipin Varghese, Harry van Haaren

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);
 
-- 
2.23.0


^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [dpdk-stable] [dpdk-dev] [PATCH] eal: fix doxygen for EAL cleanup
  2020-10-09  7:15 [dpdk-stable] [PATCH] eal: fix doxygen for EAL cleanup David Marchand
@ 2020-10-09  7:24 ` " David Marchand
  2020-10-09  7:41   ` Thomas Monjalon
  2020-10-12 12:20 ` David Marchand
  1 sibling, 1 reply; 4+ messages in thread
From: David Marchand @ 2020-10-09  7:24 UTC (permalink / raw)
  To: Harry van Haaren; +Cc: dpdk stable, dev, Vipin Varghese

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


^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [dpdk-stable] [dpdk-dev] [PATCH] eal: fix doxygen for EAL cleanup
  2020-10-09  7:24 ` [dpdk-stable] [dpdk-dev] " David Marchand
@ 2020-10-09  7:41   ` Thomas Monjalon
  0 siblings, 0 replies; 4+ messages in thread
From: Thomas Monjalon @ 2020-10-09  7:41 UTC (permalink / raw)
  To: David Marchand
  Cc: Harry van Haaren, dev, dpdk stable, Vipin Varghese, olivier.matz

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.



^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [dpdk-stable] [dpdk-dev] [PATCH] eal: fix doxygen for EAL cleanup
  2020-10-09  7:15 [dpdk-stable] [PATCH] eal: fix doxygen for EAL cleanup David Marchand
  2020-10-09  7:24 ` [dpdk-stable] [dpdk-dev] " David Marchand
@ 2020-10-12 12:20 ` David Marchand
  1 sibling, 0 replies; 4+ messages in thread
From: David Marchand @ 2020-10-12 12:20 UTC (permalink / raw)
  To: dev; +Cc: dpdk stable, Vipin Varghese, Harry van Haaren

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>
Acked-by: Thomas Monjalon <thomas@monjalon.net>

Applied.

-- 
David Marchand


^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, back to index

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-10-09  7:15 [dpdk-stable] [PATCH] eal: fix doxygen for EAL cleanup David Marchand
2020-10-09  7:24 ` [dpdk-stable] [dpdk-dev] " David Marchand
2020-10-09  7:41   ` Thomas Monjalon
2020-10-12 12:20 ` David Marchand

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