[PATCH] doc: fix various minor issues in the event timer adapter guide

Mattias Rönnblom mattias.ronnblom at ericsson.com
Tue Nov 1 08:45:28 CET 2022


In the example:
* Properly initialize the socket id field.
* Remove comments redundant and/or not consistent with the code. 180
  seconds is not 2 minutes.
* Remove redundant pointer initialization.

In both the example and in one instance in the body text, the flags
field of the conf struct was erroneously referred to as
timer_adapter_flags.

Fixes: 30e7fbd62839 ("doc: add event timer adapter guide")
Cc: erik.g.carrillo at intel.com

Signed-off-by: Mattias Rönnblom <mattias.ronnblom at ericsson.com>
---
 doc/guides/prog_guide/event_timer_adapter.rst | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/doc/guides/prog_guide/event_timer_adapter.rst b/doc/guides/prog_guide/event_timer_adapter.rst
index 7547059a05..b28375855e 100644
--- a/doc/guides/prog_guide/event_timer_adapter.rst
+++ b/doc/guides/prog_guide/event_timer_adapter.rst
@@ -107,18 +107,19 @@ to ``rte_event_timer_adapter_create()``.
 
 .. code-block:: c
 
-	#define NSECPERSEC 1E9 // No of ns in 1 sec
+	#define NSECPERSEC 1E9
 	const struct rte_event_timer_adapter_conf adapter_config = {
                 .event_dev_id = event_dev_id,
                 .timer_adapter_id = 0,
+		.socket_id = rte_socket_id(),
                 .clk_src = RTE_EVENT_TIMER_ADAPTER_CPU_CLK,
-                .timer_tick_ns = NSECPERSEC / 10, // 100 milliseconds
-                .max_tmo_nsec = 180 * NSECPERSEC // 2 minutes
+                .timer_tick_ns = NSECPERSEC / 10,
+                .max_tmo_nsec = 180 * NSECPERSEC,
                 .nb_timers = 40000,
-                .timer_adapter_flags = 0,
+                .flags = 0,
 	};
 
-	struct rte_event_timer_adapter *adapter = NULL;
+	struct rte_event_timer_adapter *adapter;
 	adapter = rte_event_timer_adapter_create(&adapter_config);
 
 	if (adapter == NULL) { ... };
@@ -145,7 +146,7 @@ to support timers of the respective type. A periodic timer expires at a fixed
 time interval repeatedly till it is cancelled. A non-periodic timer expires only
 once. The periodic capability flag, ``RTE_EVENT_TIMER_ADAPTER_CAP_PERIODIC``,
 can be set for implementations that support periodic mode if desired. To
-configure an adapter in periodic mode, ``timer_adapter_flags`` of
+configure an adapter in periodic mode, ``flags`` of
 ``rte_event_timer_adapter_conf`` is set to include the periodic flag
 ``RTE_EVENT_TIMER_ADAPTER_F_PERIODIC``. Maximum timeout (``max_tmo_nsec``) does
 not apply to periodic mode.
-- 
2.34.1



More information about the stable mailing list