[dpdk-dev] [PATCH v1] doc: update release notes for 21.02

[dpdk-dev] [PATCH v1] doc: update release notes for 21.02

[John McNamara]

Fix grammar, spelling and formatting of DPDK 21.02 release notes.

Signed-off-by: John McNamara <john.mcnamara@intel.com>
---
 doc/guides/rel_notes/release_21_02.rst | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

diff --git a/doc/guides/rel_notes/release_21_02.rst b/doc/guides/rel_notes/release_21_02.rst
index 84b04a018..167eefb36 100644
--- a/doc/guides/rel_notes/release_21_02.rst
+++ b/doc/guides/rel_notes/release_21_02.rst
@@ -74,9 +74,9 @@ New Features
 
   Added support for matching and raw encap/decap of GENEVE TLV option.
 
-* **Added support of modify field action in the flow API.**
+* **Added support for Modify field action in the flow API.**
 
-  Added modify action support to perform various operations on
+  Added "modify" action support to rte_flow to perform various operations on
   any arbitrary header field (as well as mark, metadata or tag values):
   ``RTE_FLOW_ACTION_TYPE_MODIFY_FIELD``.
   Supported operations are: overwriting a field with the content from
@@ -90,22 +90,22 @@ New Features
 
 * **Updated Cisco enic driver.**
 
-  * Added support for 64B completion queue entries
+  * Added support for 64B completion queue entries.
 
 * **Updated Hisilicon hns3 driver.**
 
-  * Added support for traffic management
+  * Added support for traffic management.
 
 * **Updated Intel i40e driver.**
 
-  * Added support on Windows.
+  * Added Intel i40e support on Windows.
 
 * **Updated Intel ice driver.**
 
   Updated the Intel ice driver with new features and improvements, including:
 
   * Added Double VLAN support for DCF switch QinQ filtering.
-  * Added support for UDP dynamic port assignment for eCPRI tunnel in DCF.
+  * Added support for UDP dynamic port assignment for eCPRI tunnels in DCF.
 
 * **Updated Intel iavf driver.**
 
@@ -120,9 +120,9 @@ New Features
 
   * Introduced basic support on Windows.
   * Added GTP PDU session container matching and raw encap/decap.
-  * Added support for RSS action in the sample sub-actions list.
+  * Added support for a RSS action in the sample sub-actions list.
   * Added support for E-Switch mirroring and jump action in the same flow.
-  * Added support to handle modify action in correct order regarding the
+  * Added support to handle the modify action in correct order regarding the
     mirroring action on E-Switch.
   * Enlarged the number of flow priorities to 21844 (0 - 21843) for ingress or
     egress flow groups greater than 0 and for any transfer flow group.
@@ -152,10 +152,10 @@ New Features
 
   * Added inner UDP/IPv4 support for VXLAN IPv4 GSO.
 
-* **Added enqueue & dequeue callback APIs for cryptodev library.**
+* **Added enqueue and dequeue callback APIs for cryptodev library.**
 
-  Cryptodev library is added with enqueue & dequeue callback APIs to
-  enable applications to add/remove user callbacks which gets called
+  The Cryptodev library has been enhanced with enqueue and dequeue callback APIs to
+  enable applications to add/remove user callbacks which get called
   for every enqueue/dequeue operation.
 
 * **Updated the OCTEON TX2 crypto PMD.**
@@ -176,7 +176,7 @@ New Features
 
 * **Added python script to run crypto perf tests and graph the results.**
 
-  A new python script has been added to automate running crypto performance
+  A new Python script has been added to automate running crypto performance
   tests and output graphed results to PDF files.
   See the :doc:`../tools/cryptoperf` guide for more details.
 
-- 
2.25.1

Re: [dpdk-dev] [PATCH v1] doc: update release notes for 21.02

[Mcnamara, John]

> -----Original Message-----
> From: Mcnamara, John <john.mcnamara@intel.com>
> Sent: Thursday, February 11, 2021 12:04 PM
> To: dev@dpdk.org
> Cc: thomas@monjalon.net; Mcnamara, John <john.mcnamara@intel.com>
> Subject: [PATCH v1] doc: update release notes for 21.02
> 
> Fix grammar, spelling and formatting of DPDK 21.02 release notes.

Thomas,

I didn't remove the "Known Issues" section in case someone else adds something to it. If not you can remove it.

Also, there probably should be a note about the change to pmdinfogen in this release. I didn't know enough about it to add it myself.

John

Re: [dpdk-dev] [PATCH v1] doc: update release notes for 21.02

[Thomas Monjalon]

11/02/2021 13:08, Mcnamara, John:

> Thomas,
> 
> I didn't remove the "Known Issues" section in case someone else
> adds something to it. If not you can remove it.

OK, I will remove.

> Also, there probably should be a note about the change to pmdinfogen
> in this release. I didn't know enough about it to add it myself.

Yes it is a rewrite of a build tool.
The real new feature is the support of Windows for pmdinfo.

+Cc Dmitry for helping with the wording.

Re: [dpdk-dev] [PATCH v1] doc: update release notes for 21.02

[Dmitry Kozlyuk]

On Fri, 12 Feb 2021 00:33:35 +0100, Thomas Monjalon wrote:
> 11/02/2021 13:08, Mcnamara, John:
> > Also, there probably should be a note about the change to pmdinfogen
> > in this release. I didn't know enough about it to add it myself.  
> 
> Yes it is a rewrite of a build tool.
> The real new feature is the support of Windows for pmdinfo.
> 
> +Cc Dmitry for helping with the wording.

* **Added Windows support to pmdinfogen.**

  PMD information strings are added for Windows as well as for other OS.
  Extracting them from Windows DLLs is not yet supported. A build-time tool
  pmdinfogen is rewritten in Python, thus native compiler and libelf are not
  required for build machine anymore, but pyelftools build-time dependency is
  added.

Feel free to use and/or adjust.

Re: [dpdk-dev] [PATCH v1] doc: update release notes for 21.02

[Bruce Richardson]

On Fri, Feb 12, 2021 at 12:33:35AM +0100, Thomas Monjalon wrote:
> 11/02/2021 13:08, Mcnamara, John:
> 
> > Thomas,
> > 
> > I didn't remove the "Known Issues" section in case someone else
> > adds something to it. If not you can remove it.
> 
> OK, I will remove.
> 

Should the new dependency on pyelftools be called out here? Since it's not
a common package I think it needs to be emphasised as a new dependency and
instructions on how to get it.

> > Also, there probably should be a note about the change to pmdinfogen
> > in this release. I didn't know enough about it to add it myself.
> 
> Yes it is a rewrite of a build tool.
> The real new feature is the support of Windows for pmdinfo.
> 
> +Cc Dmitry for helping with the wording.
> 
> 

Re: [dpdk-dev] [PATCH v1] doc: update release notes for 21.02

[Thomas Monjalon]

12/02/2021 12:57, Bruce Richardson:
> On Fri, Feb 12, 2021 at 12:33:35AM +0100, Thomas Monjalon wrote:
> > 11/02/2021 13:08, Mcnamara, John:
> > 
> > > Thomas,
> > > 
> > > I didn't remove the "Known Issues" section in case someone else
> > > adds something to it. If not you can remove it.
> > 
> > OK, I will remove.
> 
> Should the new dependency on pyelftools be called out here? Since it's not
> a common package I think it needs to be emphasised as a new dependency and
> instructions on how to get it.

What do you think of this update?
https://patches.dpdk.org/patch/87883/

Re: [dpdk-dev] [PATCH v1] doc: update release notes for 21.02

[Bruce Richardson]

On Fri, Feb 12, 2021 at 01:49:27PM +0100, Thomas Monjalon wrote:
> 12/02/2021 12:57, Bruce Richardson:
> > On Fri, Feb 12, 2021 at 12:33:35AM +0100, Thomas Monjalon wrote:
> > > 11/02/2021 13:08, Mcnamara, John:
> > > 
> > > > Thomas,
> > > > 
> > > > I didn't remove the "Known Issues" section in case someone else
> > > > adds something to it. If not you can remove it.
> > > 
> > > OK, I will remove.
> > 
> > Should the new dependency on pyelftools be called out here? Since it's
> > not a common package I think it needs to be emphasised as a new
> > dependency and instructions on how to get it.
> 
> What do you think of this update?  https://patches.dpdk.org/patch/87883/
> 
I think that is ok as an update for that particular section of "new
features", but the fact is that that new feature introduces a new
dependency for everyone, which means it may be missed for those who aren't
interested in new features. Therefore, I think it should be called out
somewhere else too, to really call attention to it. The reason I would
suggest "known issues" is that it is a section that everyone looking at the
release notes is likely to pay attention to. However, other options, such
as a callout note at the top of the Release Notes i.e not in any particular
section, might work as well.

/Bruce

Re: [dpdk-dev] [PATCH v1] doc: update release notes for 21.02

[Thomas Monjalon]

12/02/2021 14:30, Bruce Richardson:
> On Fri, Feb 12, 2021 at 01:49:27PM +0100, Thomas Monjalon wrote:
> > 12/02/2021 12:57, Bruce Richardson:
> > > On Fri, Feb 12, 2021 at 12:33:35AM +0100, Thomas Monjalon wrote:
> > > > 11/02/2021 13:08, Mcnamara, John:
> > > > 
> > > > > Thomas,
> > > > > 
> > > > > I didn't remove the "Known Issues" section in case someone else
> > > > > adds something to it. If not you can remove it.
> > > > 
> > > > OK, I will remove.
> > > 
> > > Should the new dependency on pyelftools be called out here? Since it's
> > > not a common package I think it needs to be emphasised as a new
> > > dependency and instructions on how to get it.
> > 
> > What do you think of this update?  https://patches.dpdk.org/patch/87883/
> > 
> I think that is ok as an update for that particular section of "new
> features", but the fact is that that new feature introduces a new
> dependency for everyone, which means it may be missed for those who aren't
> interested in new features. Therefore, I think it should be called out
> somewhere else too, to really call attention to it. The reason I would
> suggest "known issues" is that it is a section that everyone looking at the
> release notes is likely to pay attention to. However, other options, such
> as a callout note at the top of the Release Notes i.e not in any particular
> section, might work as well.

I agree about the need,
but I don't think adding something in known issues is visible enough.
I will send a v2 with a note at the very beginning of the release notes.

Re: [dpdk-dev] [PATCH v1] doc: update release notes for 21.02

[Thomas Monjalon]

11/02/2021 13:04, John McNamara:
> Fix grammar, spelling and formatting of DPDK 21.02 release notes.
> 
> Signed-off-by: John McNamara <john.mcnamara@intel.com>

Removed empty "known issues" and applied, thanks.
The other comments about pyelftools were addressed in separate patches.