Skip to contentSkip to conversation

eal: fix doxygen for EAL cleanup

PATCH Applied David Marchand 2 participants 4 messages Oct 9, 2020 – Oct 12, 2020

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 eal: fix doxygen for EAL cleanup

Align rte_eal_cleanup return codes description to the rest of dpdk.

Fixes aec9c13c5257 ("eal: add function to release internal resources")
---
 lib/librte_eal/include/rte_eal.h | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
lib/librte_eal/include/rte_eal.h +3 -2
index ddcf6a2e7a..e3c2ef185e 100644
@@ -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);
 
Signature · 1 line
2.23.0
#1 lore raw
Quoted 17 lines · David Marchand

Align rte_eal_cleanup return codes description to the rest of dpdk.

Fixes aec9c13c5257 ("eal: add function to release internal resources")
---
 lib/librte_eal/include/rte_eal.h | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
lib/librte_eal/include/rte_eal.h +0 -0
index ddcf6a2e7a..e3c2ef185e 100644
@@ -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

lib/librte_eal/include/rte_eal.h int rte_eal_init(int argc, char **argv); · line 138

Quoted 10 lines
lib/librte_eal/include/rte_eal.h +3 -2
  * 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?

Signature · 1 line
David Marchand
#2 lore raw

09/10/2020 09:24, David Marchand:

Quoted 17 lines

lib/librte_eal/include/rte_eal.h int rte_eal_init(int argc, char **argv); · line 137

Quoted 13 lines
lib/librte_eal/include/rte_eal.h +3 -2
@@ -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?

Quoted 2 lines

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.