From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <marko.kovacevic@intel.com>
Received: from mga02.intel.com (mga02.intel.com [134.134.136.20])
 by dpdk.org (Postfix) with ESMTP id D14F14CA6
 for <dev@dpdk.org>; Wed, 25 Apr 2018 12:31:55 +0200 (CEST)
X-Amp-Result: SKIPPED(no attachment in message)
X-Amp-File-Uploaded: False
Received: from orsmga004.jf.intel.com ([10.7.209.38])
 by orsmga101.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;
 25 Apr 2018 03:31:54 -0700
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.49,325,1520924400"; d="scan'208";a="194251175"
Received: from irsmsx107.ger.corp.intel.com ([163.33.3.99])
 by orsmga004.jf.intel.com with ESMTP; 25 Apr 2018 03:31:53 -0700
Received: from irsmsx112.ger.corp.intel.com (10.108.20.5) by
 IRSMSX107.ger.corp.intel.com (163.33.3.99) with Microsoft SMTP Server (TLS)
 id 14.3.319.2; Wed, 25 Apr 2018 11:31:33 +0100
Received: from irsmsx104.ger.corp.intel.com ([169.254.5.171]) by
 irsmsx112.ger.corp.intel.com ([169.254.1.226]) with mapi id 14.03.0319.002;
 Wed, 25 Apr 2018 11:31:33 +0100
From: "Kovacevic, Marko" <marko.kovacevic@intel.com>
To: "Gujjar, Abhinandan S" <abhinandan.gujjar@intel.com>,
 "jerin.jacob@caviumnetworks.com" <jerin.jacob@caviumnetworks.com>,
 "hemant.agrawal@nxp.com" <hemant.agrawal@nxp.com>, "akhil.goyal@nxp.com"
 <akhil.goyal@nxp.com>, "dev@dpdk.org" <dev@dpdk.org>
CC: "Vangati, Narender" <narender.vangati@intel.com>, "Gujjar, Abhinandan S"
 <abhinandan.gujjar@intel.com>, "Rao, Nikhil" <nikhil.rao@intel.com>, "Eads,
 Gage" <gage.eads@intel.com>
Thread-Topic: [dpdk-dev] [v2,6/6] doc: add event crypto adapter documentation
Thread-Index: AQHT28oGRjWJNE7PIUKAE7dszYClO6QRN4kw
Date: Wed, 25 Apr 2018 10:31:33 +0000
Message-ID: <6DC05C7C5F25994B81B3F2F214251F66369CF6@IRSMSX104.ger.corp.intel.com>
References: <1524573807-168522-1-git-send-email-abhinandan.gujjar@intel.com>
 <1524573807-168522-7-git-send-email-abhinandan.gujjar@intel.com>
In-Reply-To: <1524573807-168522-7-git-send-email-abhinandan.gujjar@intel.com>
Accept-Language: en-US
Content-Language: en-US
X-MS-Has-Attach: 
X-MS-TNEF-Correlator: 
dlp-product: dlpe-windows
dlp-version: 11.0.200.100
dlp-reaction: no-action
x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiNWEwOWVkMjItZTc0OC00NDc2LWJjYTYtZGRjNmJkZmNiZmFiIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE2LjUuOS4zIiwiVHJ1c3RlZExhYmVsSGFzaCI6IkRBeEIxb0RLd0M2b05MbEJES3AyZ2tkdUFQUGtvSlNpMVpFekduQk0zZ289In0=
x-ctpclassification: CTP_NT
x-originating-ip: [163.33.239.181]
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
Subject: Re: [dpdk-dev] [v2, 6/6] doc: add event crypto adapter documentation
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Wed, 25 Apr 2018 10:31:56 -0000

Few things below.

> Signed-off-by: Abhinandan Gujjar <abhinandan.gujjar@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
> +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D
> +
> +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=20
can you link the file this way please,=20

: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=20

> +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=
"=20
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.