doc: fix reference to event timer header

Message ID 20230220144711.2698257-1-david.marchand@redhat.com (mailing list archive)
State Accepted, archived
Delegated to: Jerin Jacob
Headers
Series doc: fix reference to event timer header |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/intel-Testing success Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/github-robot: build success github build: passed
ci/iol-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-abi-testing success Testing PASS

Commit Message

David Marchand Feb. 20, 2023, 2:47 p.m. UTC
  The event timer header is rte_event_timer_adapter.h.
Besides, we don't need to detail the full path to such a header.

Fixes: 30e7fbd62839 ("doc: add event timer adapter guide")
Cc: stable@dpdk.org

Signed-off-by: David Marchand <david.marchand@redhat.com>
---
 doc/guides/prog_guide/event_timer_adapter.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Comments

Jerin Jacob Feb. 23, 2023, 2:26 p.m. UTC | #1
On Mon, Feb 20, 2023 at 8:17 PM David Marchand
<david.marchand@redhat.com> wrote:
>
> The event timer header is rte_event_timer_adapter.h.
> Besides, we don't need to detail the full path to such a header.
>
> Fixes: 30e7fbd62839 ("doc: add event timer adapter guide")
> Cc: stable@dpdk.org
>
> Signed-off-by: David Marchand <david.marchand@redhat.com>

Applied to dpdk-next-net-eventdev/for-main. Thanks


> ---
>  doc/guides/prog_guide/event_timer_adapter.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/doc/guides/prog_guide/event_timer_adapter.rst b/doc/guides/prog_guide/event_timer_adapter.rst
> index 4e07f0cc23..2a15ed8f5c 100644
> --- a/doc/guides/prog_guide/event_timer_adapter.rst
> +++ b/doc/guides/prog_guide/event_timer_adapter.rst
> @@ -35,7 +35,7 @@ device upon timer expiration.
>
>  The Event Timer Adapter API represents each event timer with a generic struct,
>  which contains an event and user metadata.  The ``rte_event_timer`` struct is
> -defined in ``lib/event/librte_event_timer_adapter.h``.
> +defined in ``rte_event_timer_adapter.h``.
>
>  .. _timer_expiry_event:
>
> --
> 2.39.2
>
  

Patch

diff --git a/doc/guides/prog_guide/event_timer_adapter.rst b/doc/guides/prog_guide/event_timer_adapter.rst
index 4e07f0cc23..2a15ed8f5c 100644
--- a/doc/guides/prog_guide/event_timer_adapter.rst
+++ b/doc/guides/prog_guide/event_timer_adapter.rst
@@ -35,7 +35,7 @@  device upon timer expiration.
 
 The Event Timer Adapter API represents each event timer with a generic struct,
 which contains an event and user metadata.  The ``rte_event_timer`` struct is
-defined in ``lib/event/librte_event_timer_adapter.h``.
+defined in ``rte_event_timer_adapter.h``.
 
 .. _timer_expiry_event: