[v4] doc: release note for the IPsec library and application

57168 diff mbox series

Update release notes for changes to the IPsec library.
Update release notes for changes to the IPsec Security Gateway application

Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
---
 doc/guides/rel_notes/release_19_08.rst | 17 +++++++++++++----
 1 file changed, 13 insertions(+), 4 deletions(-)

> 
> Update release notes for changes to the IPsec library.
> Update release notes for changes to the IPsec Security Gateway application

Description and the release note updates use redundant words which can be avoided.
It could be something like

"Update release notes for recently supported features in ipsec lib and application."

> 
> Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
> ---
>  doc/guides/rel_notes/release_19_08.rst | 17 +++++++++++++----
>  1 file changed, 13 insertions(+), 4 deletions(-)
> 
> diff --git a/doc/guides/rel_notes/release_19_08.rst
> b/doc/guides/rel_notes/release_19_08.rst
> index c9bd3ce..48319be 100644
> --- a/doc/guides/rel_notes/release_19_08.rst
> +++ b/doc/guides/rel_notes/release_19_08.rst
> @@ -200,11 +200,20 @@ New Features
>    handshake between two separate hosts and can share local memory for peer
>    host to directly access.
> 
> -* **Updated IPSec library Header Reconstruction.**
> +* **Updated IPSec library and IPsec Security Gateway application.**
> 
> -  Updated the IPSec library with ECN and DSCP field header reconstruction
> -  feature followed by RFC4301. The IPSec-secgw sample application is also
> -  updated to support this feature by default.
> +  Added the following functionality to ``librte_ipsec`` and ``ipsec-secgw``

Added following features to ``librte_ipsec``. Corresponding changes are also added in ``ipsec-secgw`` sample application.
> +
> +  * Updated ``librte_ipsec`` with ECN and DSCP field header reconstruction
> +    feature followed by RFC4301.

* ECN and DSCP field header reconstruction as per RFC4301

> +
> +  * Added support for transport mode with IPv6 extension headers to
> +    ``librte_ipsec``.

*  Transport mode with IPv6 extension headers

> +
> +  * Added support for packets that consist of multiple segments to
> +    ``librte_ipsec``.

* Support packets with multiple segments.

> +

> +  * Updated the ``ipsec-secgw`` sample application to support these features.

This bullet can be removed.
> 
>  * **Updated telemetry library for global metrics support.**
> 

-Akhil

Hi Akhil,

> -----Original Message-----
> From: Akhil Goyal [mailto:akhil.goyal@nxp.com]
> Sent: Friday, July 26, 2019 1:36 PM
> To: Iremonger, Bernard <bernard.iremonger@intel.com>; dev@dpdk.org;
> Ananyev, Konstantin <konstantin.ananyev@intel.com>; Mcnamara, John
> <john.mcnamara@intel.com>; Zhang, Roy Fan <roy.fan.zhang@intel.com>
> Subject: RE: [PATCH v4] doc: release note for the IPsec library and application
> 
> 
> >
> > Update release notes for changes to the IPsec library.
> > Update release notes for changes to the IPsec Security Gateway
> application
> 
> Description and the release note updates use redundant words which can be
> avoided.
> It could be something like
> 
> "Update release notes for recently supported features in ipsec lib and
> application."

Ok, will change.

> > Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
> > ---
> >  doc/guides/rel_notes/release_19_08.rst | 17 +++++++++++++----
> >  1 file changed, 13 insertions(+), 4 deletions(-)
> >
> > diff --git a/doc/guides/rel_notes/release_19_08.rst
> > b/doc/guides/rel_notes/release_19_08.rst
> > index c9bd3ce..48319be 100644
> > --- a/doc/guides/rel_notes/release_19_08.rst
> > +++ b/doc/guides/rel_notes/release_19_08.rst
> > @@ -200,11 +200,20 @@ New Features
> >    handshake between two separate hosts and can share local memory for
> peer
> >    host to directly access.
> >
> > -* **Updated IPSec library Header Reconstruction.**
> > +* **Updated IPSec library and IPsec Security Gateway application.**
> >
> > -  Updated the IPSec library with ECN and DSCP field header reconstruction
> > -  feature followed by RFC4301. The IPSec-secgw sample application is also
> > -  updated to support this feature by default.
> > +  Added the following functionality to ``librte_ipsec`` and ``ipsec-secgw``
> 
> Added following features to ``librte_ipsec``. Corresponding changes are also
> added in ``ipsec-secgw`` sample application.

Ok, will change.

> > +
> > +  * Updated ``librte_ipsec`` with ECN and DSCP field header reconstruction
> > +    feature followed by RFC4301.
> 
> * ECN and DSCP field header reconstruction as per RFC4301
> 
> > +
> > +  * Added support for transport mode with IPv6 extension headers to
> > +    ``librte_ipsec``.
> 
> *  Transport mode with IPv6 extension headers

Ok, will change
 
> > +
> > +  * Added support for packets that consist of multiple segments to
> > +    ``librte_ipsec``.
> 
> * Support packets with multiple segments.
> 

Ok, will change.

> > +
> 
> > +  * Updated the ``ipsec-secgw`` sample application to support these
> features.
> 
> This bullet can be removed.

Ok, will remove.

> >
> >  * **Updated telemetry library for global metrics support.**
> >
> 
> -Akhil

Regards,

Bernard.