[1/2] timer: clarify subsystem_init return value

Message ID 20210326104759.280175-2-mk@semihalf.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series Fix unit tests execution for ENA PMD |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Michal Krawczyk March 26, 2021, 10:47 a.m. UTC
  From: Stanislaw Kardach <kda@semihalf.com>

rte_timer_subsystem_init() may return -EALREADY if it has been already
initialized. Therefore put explicitly into doxygen that this is not a
failure for the application.

Signed-off-by: Stanislaw Kardach <kda@semihalf.com>
Reviewed-by: Michal Krawczyk <mk@semihalf.com>
---
 lib/librte_timer/rte_timer.h | 1 +
 1 file changed, 1 insertion(+)
  

Comments

Carrillo, Erik G March 29, 2021, 8:50 p.m. UTC | #1
> -----Original Message-----
> From: Michal Krawczyk <mk@semihalf.com>
> Sent: Friday, March 26, 2021 5:48 AM
> To: dev@dpdk.org; Robert Sanford <rsanford@akamai.com>; Carrillo, Erik G
> <erik.g.carrillo@intel.com>
> Cc: Stanislaw Kardach <kda@semihalf.com>; Michal Krawczyk
> <mk@semihalf.com>
> Subject: [PATCH 1/2] timer: clarify subsystem_init return value
> 
> From: Stanislaw Kardach <kda@semihalf.com>
> 
> rte_timer_subsystem_init() may return -EALREADY if it has been already
> initialized. Therefore put explicitly into doxygen that this is not a failure for
> the application.
> 
> Signed-off-by: Stanislaw Kardach <kda@semihalf.com>
> Reviewed-by: Michal Krawczyk <mk@semihalf.com>
> ---

Thanks, Michal.

Acked-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>
  

Patch

diff --git a/lib/librte_timer/rte_timer.h b/lib/librte_timer/rte_timer.h
index 22a27aa08d..0f820555c0 100644
--- a/lib/librte_timer/rte_timer.h
+++ b/lib/librte_timer/rte_timer.h
@@ -171,6 +171,7 @@  int rte_timer_data_dealloc(uint32_t id);
  *   - 0: Success
  *   - -ENOMEM: Unable to allocate memory needed to initialize timer
  *      subsystem
+ *   - -EALREADY: timer subsystem was already initialized. Not an error.
  */
 int rte_timer_subsystem_init(void);