[dpdk-stable] patch 'eal: fix doxygen for EAL cleanup' has been queued to LTS release 18.11.11

[Kevin Traynor]

Hi,

FYI, your patch has been queued to LTS release 18.11.11

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 11/10/20. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Queued patches are on a temporary branch at:
https://github.com/kevintraynor/dpdk-stable-queue

This queued commit can be viewed at:
https://github.com/kevintraynor/dpdk-stable-queue/commit/1854fc6fee339fd00078fa4d591c3aefac9f7c7e

Thanks.

Kevin.

---
>From 1854fc6fee339fd00078fa4d591c3aefac9f7c7e Mon Sep 17 00:00:00 2001
From: David Marchand <david.marchand at redhat.com>
Date: Fri, 9 Oct 2020 09:15:54 +0200
Subject: [PATCH] eal: fix doxygen for EAL cleanup

[ upstream commit 1a11380bf45be83d66493819f3a6e8c9868869be ]

Align rte_eal_cleanup return codes description to the rest of dpdk.

Fixes: aec9c13c5257 ("eal: add function to release internal resources")

Signed-off-by: David Marchand <david.marchand at redhat.com>
Acked-by: Thomas Monjalon <thomas at monjalon.net>
---
 lib/librte_eal/common/include/rte_eal.h | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/lib/librte_eal/common/include/rte_eal.h b/lib/librte_eal/common/include/rte_eal.h
index 595efdca50..94912a8afa 100644
--- a/lib/librte_eal/common/include/rte_eal.h
+++ b/lib/librte_eal/common/include/rte_eal.h
@@ -185,6 +185,7 @@ int rte_eal_init(int argc, char **argv);
  * 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_experimental rte_eal_cleanup(void);
-- 
2.26.2

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2020-11-05 12:38:55.317970459 +0000
+++ 0055-eal-fix-doxygen-for-EAL-cleanup.patch	2020-11-05 12:38:54.255896031 +0000
@@ -1 +1 @@
-From 1a11380bf45be83d66493819f3a6e8c9868869be Mon Sep 17 00:00:00 2001
+From 1854fc6fee339fd00078fa4d591c3aefac9f7c7e Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit 1a11380bf45be83d66493819f3a6e8c9868869be ]
+
@@ -9 +10,0 @@
-Cc: stable at dpdk.org
@@ -14 +15 @@
- lib/librte_eal/include/rte_eal.h | 5 +++--
+ lib/librte_eal/common/include/rte_eal.h | 5 +++--
@@ -17,5 +18,5 @@
-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
-@@ -131,6 +131,7 @@ int rte_eal_init(int argc, char **argv);
+diff --git a/lib/librte_eal/common/include/rte_eal.h b/lib/librte_eal/common/include/rte_eal.h
+index 595efdca50..94912a8afa 100644
+--- a/lib/librte_eal/common/include/rte_eal.h
++++ b/lib/librte_eal/common/include/rte_eal.h
+@@ -185,6 +185,7 @@ int rte_eal_init(int argc, char **argv);
@@ -30 +31 @@
- int rte_eal_cleanup(void);
+ int __rte_experimental rte_eal_cleanup(void);