[PATCH] doc: fix event timer adapter guide

pbhagavatula at marvell.com pbhagavatula at marvell.com
Fri Apr 7 10:14:10 CEST 2023


From: Pavan Nikhilesh <pbhagavatula at marvell.com>

Remove incorrect spec definition from programmers guide, it is
applications responsibility to set ev.event_ptr to a valid value.

Fixes: 30e7fbd62839 ("doc: add event timer adapter guide")

Signed-off-by: Pavan Nikhilesh <pbhagavatula at marvell.com>
---
 doc/guides/prog_guide/event_timer_adapter.rst | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/doc/guides/prog_guide/event_timer_adapter.rst b/doc/guides/prog_guide/event_timer_adapter.rst
index 2a15ed8f5c..adeddbedfc 100644
--- a/doc/guides/prog_guide/event_timer_adapter.rst
+++ b/doc/guides/prog_guide/event_timer_adapter.rst
@@ -247,9 +247,7 @@ Note that it is necessary to initialize the event timer state to
 RTE_EVENT_TIMER_NOT_ARMED.  Also note that we have saved a pointer to the
 ``conn`` object in the timer's event payload. This will allow us to locate
 the connection object again once we dequeue the timer expiry event from the
-event device later.  As a convenience, the application may specify no value for
-ev.event_ptr, and the adapter will by default set it to point at the event
-timer itself.
+event device later.
 
 Now we can arm the event timer with ``rte_event_timer_arm_burst()``:
 
-- 
2.25.1



More information about the dev mailing list