[dpdk-dev] [PATCH 2/2] doc: add notes regarding eventdev producer consumer dependency

[Jerin Jacob Kollanukkaran]

On Wed, 2019-02-27 at 20:00 +0000, Pavan Nikhilesh Bhagavatula wrote:
> From: Pavan Nikhilesh <pbhagavatula at marvell.com>
> 
> EventDev i.e consumer needs to be started before starting the
> event producers.
> Update documentation of EventDev and EventDev adapters.
> 


Adding all the eventdev adapter maintainers for the feedback.
It looks good to me as it is an natural flow(i.e
we need to start eventdev first to consume the adapter events)


> Signed-off-by: Pavan Nikhilesh <pbhagavatula at marvell.com>
> ---
>  doc/guides/prog_guide/event_crypto_adapter.rst      | 5 +++++
>  doc/guides/prog_guide/event_ethernet_rx_adapter.rst | 5 +++++
>  doc/guides/prog_guide/event_timer_adapter.rst       | 5 +++++
>  doc/guides/prog_guide/eventdev.rst                  | 5 +++++
>  4 files changed, 20 insertions(+)
> 
> diff --git a/doc/guides/prog_guide/event_crypto_adapter.rst
> b/doc/guides/prog_guide/event_crypto_adapter.rst
> index 9fe09c805..1e3eb7139 100644
> --- a/doc/guides/prog_guide/event_crypto_adapter.rst
> +++ b/doc/guides/prog_guide/event_crypto_adapter.rst
> @@ -286,6 +286,11 @@ service function if one exists.
>  
>          rte_event_crypto_adapter_start(id, mode);
>  
> +.. Note::
> +
> +         The eventdev to which the event_crypto_adapter is connected
> needs to
> +         be started before calling rte_event_crypto_adapter_start().


IMO, It is better to add @note under the all the *_adapter_start() APIs
to capture the notes on doxygen.