[dpdk-dev,v4,5/5] doc: add event crypto adapter documentation
diff mbox

Message ID 20180509024549.GD19502@jerin
State Not Applicable, archived
Headers show

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/Intel-compilation fail apply issues

Commit Message

Jerin Jacob May 9, 2018, 2:45 a.m. UTC
-----Original Message-----
> Date: Wed, 9 May 2018 01:16:04 +0530
> From: Abhinandan Gujjar <abhinandan.gujjar@intel.com>
> To: jerin.jacob@caviumnetworks.com, hemant.agrawal@nxp.com,
>  akhil.goyal@nxp.com, dev@dpdk.org
> CC: narender.vangati@intel.com, abhinandan.gujjar@intel.com,
>  nikhil.rao@intel.com, gage.eads@intel.com
> Subject: [v4,5/5] doc: add event crypto adapter documentation
> X-Mailer: git-send-email 1.9.1
> 
> Add entries in the programmer's guide, API index, maintainer's file
> and release notes for the event crypto adapter.
> 
> Signed-off-by: Abhinandan Gujjar <abhinandan.gujjar@intel.com>
> Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
> ---
>  MAINTAINERS                                        |    1 +
>  doc/api/doxy-api-index.md                          |    1 +
>  doc/guides/prog_guide/event_crypto_adapter.rst     |  290 ++++++
>  .../img/event_crypto_adapter_op_forward.svg        | 1073 ++++++++++++++++++++
>  .../prog_guide/img/event_crypto_adapter_op_new.svg |  968 ++++++++++++++++++
>  doc/guides/prog_guide/index.rst                    |    1 +
>  doc/guides/rel_notes/release_18_05.rst             |    6 +
>  7 files changed, 2340 insertions(+)
>  create mode 100644 doc/guides/prog_guide/event_crypto_adapter.rst
>  create mode 100644 doc/guides/prog_guide/img/event_crypto_adapter_op_forward.svg
>  create mode 100644 doc/guides/prog_guide/img/event_crypto_adapter_op_new.svg

event_crypto_adapter_op_new.svg diagram is not updated. If you have time then please update the SVG
diagram else remove programmer guide for this patch series and submit
the documentation patch just after the RC3. Since it is documentation
patch, it can be merged after RC3. But I guess, not much time is
required to update the diagram.

Some suggestion to improve:

>

Patch
diff mbox

diff --git a/doc/guides/prog_guide/event_crypto_adapter.rst
b/doc/guides/prog_guide/event_crypto_adapter.rst
index e1670a6db..008faaef3 100644
--- a/doc/guides/prog_guide/event_crypto_adapter.rst
+++ b/doc/guides/prog_guide/event_crypto_adapter.rst
@@ -35,7 +35,7 @@  the ingress packet ordering.
 
 .. figure:: img/event_crypto_adapter_op_new.*
 
-Working model of RTE_EVENT_CRYPTO_ADAPTER_OP_NEW mode
+Working model of ``RTE_EVENT_CRYPTO_ADAPTER_OP_NEW`` mode:
 
 In the RTE_EVENT_CRYPTO_ADAPTER_OP_NEW mode, application submits crypto
 operations directly to crypto device. The adapter then dequeues crypto
@@ -47,7 +47,7 @@  enqueues to cryptodev without going through
crypto/atomic stage.
 
 .. figure:: img/event_crypto_adapter_op_forward.*
 
-Working model of RTE_EVENT_CRYPTO_ADAPTER_OP_FORWARD mode
+Working model of ``RTE_EVENT_CRYPTO_ADAPTER_OP_FORWARD`` mode: