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

[Mcnamara, John]

> -----Original Message-----
> From: Akhil Goyal [mailto:akhil.goyal at nxp.com]
> Sent: Wednesday, November 1, 2017 6:21 AM
> To: Thomas Monjalon <thomas at monjalon.net>; Mcnamara, John
> <john.mcnamara at intel.com>
> Cc: dev at dpdk.org; Doherty, Declan <declan.doherty at intel.com>; De Lara
> Guarch, Pablo <pablo.de.lara.guarch at intel.com>; hemant.agrawal at nxp.com;
> Nicolau, Radu <radu.nicolau at intel.com>; borisp at mellanox.com;
> aviadye at mellanox.com; jerin.jacob at caviumnetworks.com; Ananyev, Konstantin
> <konstantin.ananyev at intel.com>
> Subject: Re: [PATCH] doc: update release notes for rte_security
> 
> Hi Thomas,
> On 10/30/2017 7:52 PM, Thomas Monjalon wrote:
> > 30/10/2017 13:27, Akhil Goyal:
> >> Removed the deprication notice for ABI breakage and updated release
> >> notes for rte_security.
> >>
> >> Signed-off-by: Akhil Goyal <akhil.goyal at nxp.com>
> >> ---
> >> +.. _security_library:
> >> +
> >>   Security Library
> >>   ================
> > [...]
> >> +* **Added the Security Offload Library.**
> >> +
> >> +  Added an experimental library - rte_security. It provide security
> >> + APIs for  protocols like IPSec using inline ipsec offload to
> >> + ethernet device or full  protocol offload with lookaside crypto
> device.
> >> +
> >> +  See the :ref:`Security Library <Security_Library>` documentation
> >> + in  the Programmers Guide document, for more information.
> >
> > I think the reference to the programmer's guide is not so useful.
> > I prefer avoiding it because it won't work in PDF format.
> >
> > John, any opinion?
> >
> 
> I added this reference as there was another one in the release notes
> already for membership library.
> 
> I will remove reference to security library, if it is not required.
> Please let me know.
> 

You could refer to it without a link:

    See the "Security_Library" section of the DPDK Programmers Guide document,
    for more information.

John