[dpdk-dev] [PATCH v7 7/7] doc: add event timer adapter documentation

[Jerin Jacob]

-----Original Message-----
> Date: Thu, 8 Mar 2018 15:54:06 -0600
> From: Erik Gabriel Carrillo <erik.g.carrillo at intel.com>
> To: pbhagavatula at caviumnetworks.com
> CC: dev at dpdk.org, jerin.jacob at caviumnetworks.com, nipun.gupta at nxp.com,
>  hemant.agrawal at nxp.com
> Subject: [PATCH v7 7/7] doc: add event timer adapter documentation
> X-Mailer: git-send-email 1.7.10
> 
> Signed-off-by: Erik Gabriel Carrillo <erik.g.carrillo at intel.com>
> ---
>  MAINTAINERS                            |  7 +++++++
>  doc/api/doxy-api-index.md              | 32 +++-----------------------------
>  doc/guides/rel_notes/release_18_05.rst |  5 +++++
>  3 files changed, 15 insertions(+), 29 deletions(-)
> 
> diff --git a/MAINTAINERS b/MAINTAINERS
> index a646ca3..abebf6d 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -317,6 +317,13 @@ F: lib/librte_eventdev/*eth_rx_adapter*
>  F: test/test/test_event_eth_rx_adapter.c
>  F: doc/guides/prog_guide/event_ethernet_rx_adapter.rst
>  
> +Eventdev Timer Adapter API - EXPERIMENTAL
> +M: Erik Gabriel Carrillo <erik.g.carrillo at intel.com>
> +T: git://dpdk.org/next/dpdk-next-eventdev
> +F: lib/librte_eventdev/*timer_adapter*
> +F: test/test/test_event_timer_adapter.c
> +F: doc/guides/prog_guide/event_timer_adapter.rst
> +
>  The public API headers are grouped by topics:
> @@ -47,6 +20,7 @@ The public API headers are grouped by topics:
>    [security]           (@ref rte_security.h),
>    [eventdev]           (@ref rte_eventdev.h),
>    [event_eth_rx_adapter]   (@ref rte_event_eth_rx_adapter.h),
> +  [event_timer_adapter]    (@ref rte_event_timer_adapter.h),
>    [rawdev]             (@ref rte_rawdev.h),
>    [metrics]            (@ref rte_metrics.h),
>    [bitrate]            (@ref rte_bitrate.h),
> diff --git a/doc/guides/rel_notes/release_18_05.rst b/doc/guides/rel_notes/release_18_05.rst
> index 3923dc2..2b93a1e 100644
> --- a/doc/guides/rel_notes/release_18_05.rst
> +++ b/doc/guides/rel_notes/release_18_05.rst
> @@ -41,6 +41,11 @@ New Features
>       Also, make sure to start the actual text at the margin.
>       =========================================================
>  
> +* **Added the Event Timer Adapter Library.**
> +
> +  The Event Timer Adapter Library extends the event-based model by introducing
> +  APIs that allow applications to generate timer expiry events that are

How about ?
API that allow applications to arm/cancel the timer expiry events that are

In any case,
Acked-by: Jerin Jacob <jerin.jacob at caviumnetworks.com>

> +  scheduled by an event device along with existing types of events.
>  
>  API Changes
>  -----------
> -- 
> 2.6.4
>