From: Jerin Jacob <jerin.jacob@caviumnetworks.com>
To: Abhinandan Gujjar <abhinandan.gujjar@intel.com>
Cc: hemant.agrawal@nxp.com, akhil.goyal@nxp.com, dev@dpdk.org,
narender.vangati@intel.com, nikhil.rao@intel.com,
gage.eads@intel.com
Subject: Re: [dpdk-dev] [v4, 5/5] doc: add event crypto adapter documentation
Date: Wed, 9 May 2018 08:15:50 +0530 [thread overview]
Message-ID: <20180509024549.GD19502@jerin> (raw)
In-Reply-To: <1525808764-109595-6-git-send-email-abhinandan.gujjar@intel.com>
-----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:
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:
>
prev parent reply other threads:[~2018-05-09 2:46 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-05-08 19:45 [dpdk-dev] [v4,0/5] eventdev: cover letter - crypto adapter Abhinandan Gujjar
2018-05-08 19:46 ` [dpdk-dev] [v4,1/5] eventdev: introduce event " Abhinandan Gujjar
2018-05-09 2:34 ` Jerin Jacob
2018-05-09 7:01 ` Akhil Goyal
2018-05-09 7:26 ` Gujjar, Abhinandan S
2018-05-08 19:46 ` [dpdk-dev] [v4, 2/5] eventdev: add APIs and PMD callbacks for " Abhinandan Gujjar
2018-05-09 2:35 ` Jerin Jacob
2018-05-08 19:46 ` [dpdk-dev] [v4,3/5] eventdev: add crypto adapter implementation Abhinandan Gujjar
2018-05-09 2:36 ` [dpdk-dev] [v4, 3/5] " Jerin Jacob
2018-05-08 19:46 ` [dpdk-dev] [v4,4/5] test: add event crypto adapter auto-test Abhinandan Gujjar
2018-05-08 19:46 ` [dpdk-dev] [v4,5/5] doc: add event crypto adapter documentation Abhinandan Gujjar
2018-05-09 2:45 ` Jerin Jacob [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180509024549.GD19502@jerin \
--to=jerin.jacob@caviumnetworks.com \
--cc=abhinandan.gujjar@intel.com \
--cc=akhil.goyal@nxp.com \
--cc=dev@dpdk.org \
--cc=gage.eads@intel.com \
--cc=hemant.agrawal@nxp.com \
--cc=narender.vangati@intel.com \
--cc=nikhil.rao@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).