Skip to content

Commit

Permalink
doc: fix event timer adapter guide
Browse files Browse the repository at this point in the history
[ upstream commit 4b6fad5cc8a54647a2ea0c0792b25932da9504fc ]

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

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

Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
Acked-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>
  • Loading branch information
PavanNikhilesh authored and kevintraynor committed Jul 11, 2023
1 parent 84d280e commit 87c6203
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions doc/guides/prog_guide/event_timer_adapter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -229,9 +229,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()``:

Expand Down

0 comments on commit 87c6203

Please sign in to comment.