[dpdk-dev,v2,9/9] doc: add dpaa2 command interface rawdev to release notes

Message ID 1523111645-8076-10-git-send-email-nipun.gupta@nxp.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers

Checks

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

Commit Message

Nipun Gupta April 7, 2018, 2:34 p.m. UTC
  Signed-off-by: Nipun Gupta <nipun.gupta@nxp.com>
---
 doc/guides/rel_notes/release_18_05.rst | 7 +++++++
 1 file changed, 7 insertions(+)
  

Comments

Kovacevic, Marko April 23, 2018, 12:23 p.m. UTC | #1
> Signed-off-by: Nipun Gupta <nipun.gupta@nxp.com>
> ---
>  doc/guides/rel_notes/release_18_05.rst | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/release_18_05.rst
> b/doc/guides/rel_notes/release_18_05.rst
> index e5fac1c..0aebb18 100644
> --- a/doc/guides/rel_notes/release_18_05.rst
> +++ b/doc/guides/rel_notes/release_18_05.rst
> @@ -58,6 +58,13 @@ New Features
>    * Added support for NVGRE, VXLAN and GENEVE filters in flow API.
>    * Added support for DROP action in flow API.
> 
> +* **Added DPAA2 Command Interface Driver (in rawdev).**
> +
> +  The DPAA2 CMDIF is an implementation of the rawdev API, that provides
> + communication between the GPP and AIOP (Firmware). This is achieved
> + via using the DPCI devices exposed by MC for GPP <--> AIOP interaction.
> +
> +  See the :doc:`../rawdevs/dpaa2_cmdif.rst` guide for more details.

You need to remove the .rst extension from above for it to be a clickable and linked to the html version of the file.
Once it's done you can add my ack to the second version.

Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>
  
Shreyansh Jain April 25, 2018, 1:50 a.m. UTC | #2
> -----Original Message-----
> From: Nipun Gupta
> Sent: Saturday, April 7, 2018 8:04 PM
> To: thomas@monjalon.net; Hemant Agrawal <hemant.agrawal@nxp.com>;
> Shreyansh Jain <shreyansh.jain@nxp.com>
> Cc: dev@dpdk.org; Nipun Gupta <nipun.gupta@nxp.com>
> Subject: [PATCH v2 9/9] doc: add dpaa2 command interface rawdev to
> release notes
> 
> Signed-off-by: Nipun Gupta <nipun.gupta@nxp.com>
> ---
>  doc/guides/rel_notes/release_18_05.rst | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/release_18_05.rst
> b/doc/guides/rel_notes/release_18_05.rst
> index e5fac1c..0aebb18 100644
> --- a/doc/guides/rel_notes/release_18_05.rst
> +++ b/doc/guides/rel_notes/release_18_05.rst
> @@ -58,6 +58,13 @@ New Features
>    * Added support for NVGRE, VXLAN and GENEVE filters in flow API.
>    * Added support for DROP action in flow API.
> 
> +* **Added DPAA2 Command Interface Driver (in rawdev).**
> +
> +  The DPAA2 CMDIF is an implementation of the rawdev API, that
> provides

The ',' in '...rawdev API, that provides' is not required.

> +  communication between the GPP and AIOP (Firmware). This is achieved

Can you please state NXP's QorIQ based AIOP Block or, one liner about AIOP would help someone understand the context.

> +  via using the DPCI devices exposed by MC for GPP <--> AIOP
> interaction.
> +
> +  See the :doc:`../rawdevs/dpaa2_cmdif.rst` guide for more details.

Just like the QDMA series, you might want to remove 'rst' from the above.

> 
>  API Changes
>  -----------
> --
> 1.9.1
  

Patch

diff --git a/doc/guides/rel_notes/release_18_05.rst b/doc/guides/rel_notes/release_18_05.rst
index e5fac1c..0aebb18 100644
--- a/doc/guides/rel_notes/release_18_05.rst
+++ b/doc/guides/rel_notes/release_18_05.rst
@@ -58,6 +58,13 @@  New Features
   * Added support for NVGRE, VXLAN and GENEVE filters in flow API.
   * Added support for DROP action in flow API.
 
+* **Added DPAA2 Command Interface Driver (in rawdev).**
+
+  The DPAA2 CMDIF is an implementation of the rawdev API, that provides
+  communication between the GPP and AIOP (Firmware). This is achieved
+  via using the DPCI devices exposed by MC for GPP <--> AIOP interaction.
+
+  See the :doc:`../rawdevs/dpaa2_cmdif.rst` guide for more details.
 
 API Changes
 -----------