Re: [dpdk-dev] [PATCH v3] doc: add cryptodev xform deprecation notice

[Thomas Monjalon <thomas@monjalon.net>]

29/03/2019 16:59, Akhil Goyal:
> 
> On 3/29/2019 9:19 PM, Akhil Goyal wrote:
> >
> > On 3/29/2019 7:45 PM, Akhil Goyal wrote:
> >> On 3/29/2019 7:29 PM, Akhil Goyal wrote:
> >>> On 3/22/2019 10:04 PM, Fan Zhang wrote:
> >>>> This patch adds the deprecation notice of changing Cryptodev
> >>>> symmetric xform structure. The proposed change is to making
> >>>> key pointers in the crypto xforms (cipher, auth, aead) to
> >>>> indicate neither the library or the drivers will not change
> >>>> the content of the key buffer.
> >>>>
> >>>> Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>
> >>>> ---
> >>>> v3:
> >>>> - Removed target release.
> >>>>
> >>>> v2:
> >>>> - Added description.
> >>>>
> >>>>      doc/guides/rel_notes/deprecation.rst | 4 ++++
> >>>>      1 file changed, 4 insertions(+)
> >>>>
> >>>> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> >>>> index 1b4fcb7e6..f35ac5b96 100644
> >>>> --- a/doc/guides/rel_notes/deprecation.rst
> >>>> +++ b/doc/guides/rel_notes/deprecation.rst
> >>>> @@ -75,3 +75,7 @@ Deprecation Notices
> >>>>      
> >>>>      * crypto/aesni_mb: the minimum supported intel-ipsec-mb library version will be
> >>>>        changed from 0.49.0 to 0.52.0.
> >>>> +
> >>>> +* cryptodev: the ``uint8_t *data`` member of ``key`` structure in the xforms
> >>>> +  structure (``rte_crypto_cipher_xform``, ``rte_crypto_auth_xform``, and
> >>>> +  ``rte_crypto_aead_xform``) will be changed to ``const uint8_t *data``.
> >>> Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
> >> delegated to master.
> >> should be applied along with
> >> http://patches.dpdk.org/patch/51395/
> >>
> > Applied to dpdk-next-crypto
> > Thanks.
> >
> This patch is proposing that there will be change in the xform 
> structure(API breakage) and the change is happening in the same release. 
> I suppose this is not allowed.
> 
> @Thomas: Could you please suggest if the deprecation notice should be 
> added in this release and the changes in the next release?

First of all, we must avoid breaking API.
If it is not avoidable, we must announce it and do the change in
the next release.