[dpdk-dev] [PATCH] eal: fix doxygen for EAL cleanup
David Marchand
david.marchand at redhat.com
Fri Oct 9 09:15:54 CEST 2020
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);
--
2.23.0
More information about the dev
mailing list