[dpdk-dev] [v2, 6/6] doc: add event crypto adapter documentation

[Gujjar, Abhinandan S]

Hi Marko,

Thanks for reviewing.
I will update the below links and also replace tab with 8 spaces for the code blocks.

Regards
Abhinandan

> -----Original Message-----
> From: Kovacevic, Marko
> Sent: Wednesday, April 25, 2018 4:02 PM
> To: Gujjar, Abhinandan S <abhinandan.gujjar at intel.com>;
> jerin.jacob at caviumnetworks.com; hemant.agrawal at nxp.com;
> akhil.goyal at nxp.com; dev at dpdk.org
> Cc: Vangati, Narender <narender.vangati at intel.com>; Gujjar, Abhinandan S
> <abhinandan.gujjar at intel.com>; Rao, Nikhil <nikhil.rao at intel.com>; Eads, Gage
> <gage.eads at intel.com>
> Subject: RE: [dpdk-dev] [v2,6/6] doc: add event crypto adapter documentation
> 
> Few things below.
> 
> > Signed-off-by: Abhinandan Gujjar <abhinandan.gujjar at intel.com>
> > ---
> >  MAINTAINERS                                    |   7 +
> >  doc/api/doxy-api-index.md                      |   1 +
> >  doc/guides/prog_guide/event_crypto_adapter.rst | 236
> >  doc/guides/prog_guide/index.rst                |   1 +
> >  doc/guides/rel_notes/release_18_05.rst         |   6 +
> >  5 files changed, 251 insertions(+)
> >  create mode 100644 doc/guides/prog_guide/event_crypto_adapter.rst
> 
> <...>
> 
> > +Event Crypto Adapter Library
> > +============================
> > +
> > +The DPDK Event device library
> > +'<http://dpdk.org/doc/guides/prog_guide/eventdev.html>`_
> 
> I'd suggest making a change to the link it looks messy the way it is at the
> moment can you link the file this way please,
> 
> :doc:`DPDK Event device library <eventdev>`
> 
> 
> > +provides event driven programming model with features to schedule
> > events.
> > +The cryptodev library
> > +'<http://dpdk.org/doc/guides/prog_guide/cryptodev_lib.html>`_
> 
> Same above:   :doc:`cryptodev library <cryptodev_lib>`
> 
> 
> > +provides interface to crypto poll mode drivers which supports
> > +different
> > crypto operations.
> > +The Event Crypto Adapter is one of the event adapter which is
> > +intended to bridge between event devices and cryptodev.
> 
> <...>
> 
> > +The ``rte_event_crypto_adapter_create_ext()`` function is passed as a
> > +callback function. The callback function is invoked if the adapter
> > +needs to use a service function and needs to create an event port for
> > +it. The callback is expected to fill the ``struct
> > +rte_event_crypto_adapter_conf`` structure passed to it.
> > +
> > +For ENQ-DEQ mode, the event port created by adapter can be retrived
> 
> Spelling     retrived / retrieved
> 
> > +using ``rte_event_crypto_adapter_event_port_get()`` API.
> > +Application can use this event port to link with event queue on which
> > +it enqueue events towards the crypto adapter.
> 
> 
> <...>
> 
> > +
> > +Adding queue pair to the adapter instance
> > +-----------------------------------------
> > +
> > +Cryptodev device id and queue pair are created using cryptodev APIs.
> > +Refer '<http://dpdk.org/doc/guides/prog_guide/cryptodev_lib.html>`_.
> 
> Change above:
> And maybe instead of just Refer, maybe try "For more information click here"
> Just a suggestion
> 
> :doc:`here  <cryptodev_lib>`.
> 
> <...>
> 
> > +
> > +Get adapter statistics
> > +----------------------
> > +
> > +The  rte_event_crypto_adapter_stats_get()`` function reports counters
> 
> Missing a `` at the beginning of this function above.
> 
> 
> > +defined in struct ``rte_event_crypto_adapter_stats``. The received
> > +packet and enqueued event counts are a sum of the counts from the
> > +eventdev PMD callbacks if the callback is supported, and the counts
> > +maintained by the service function, if one exists.
> 
> <...>
> 
> Also try and keep the code blocks with 4 to 8 spaces in some cases there is a lot
> of tabs.
> Especially as you  have spaces in a few and not others.
> 
> Thanks
> 
> Marko K.