doc: announce deprecation for security ops

Message ID 20230704194445.3332847-1-gakhil@marvell.com (mailing list archive)
State Accepted, archived
Delegated to: akhil goyal
Headers
Series doc: announce deprecation for security ops |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/intel-Functional success Functional PASS
ci/github-robot: build success github build: passed
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-unit-testing success Testing PASS
ci/iol-aarch-unit-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS

Commit Message

Akhil Goyal July 4, 2023, 7:44 p.m. UTC
  Structure rte_security_ops and rte_security_ctx are meant to
be used by rte_security library and the PMDs associated.
These will be moved to an internal header in DPDK 23.11 release.

Signed-off-by: Akhil Goyal <gakhil@marvell.com>
---
 doc/guides/rel_notes/deprecation.rst | 3 +++
 1 file changed, 3 insertions(+)
  

Comments

Hemant Agrawal July 5, 2023, 10:59 a.m. UTC | #1
Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>

On 05-Jul-23 1:14 AM, Akhil Goyal wrote:
> Caution: This is an external email. Please take care when clicking links or opening attachments. When in doubt, report the message using the 'Report this email' button
>
>
> Structure rte_security_ops and rte_security_ctx are meant to
> be used by rte_security library and the PMDs associated.
> These will be moved to an internal header in DPDK 23.11 release.
>
> Signed-off-by: Akhil Goyal <gakhil@marvell.com>
> ---
>   doc/guides/rel_notes/deprecation.rst | 3 +++
>   1 file changed, 3 insertions(+)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 8e1cdd677a..74bdb4f577 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -133,6 +133,9 @@ Deprecation Notices
>     ``rte_cryptodev_get_auth_algo_string``, ``rte_cryptodev_get_aead_algo_string`` and
>     ``rte_cryptodev_asym_get_xform_string`` respectively.
>
> +* security: Hide structures ``rte_security_ops`` and ``rte_security_ctx`` as these
> +  are internal to DPDK library and PMDs.
> +
>   * flow_classify: The flow_classify library and example have no maintainer.
>     The library is experimental and, as such, it could be removed from DPDK.
>     Its removal has been postponed to let potential users report interest
> --
> 2.25.1
>
  
Konstantin Ananyev July 5, 2023, 11:31 a.m. UTC | #2
04/07/2023 20:44, Akhil Goyal пишет:
> Structure rte_security_ops and rte_security_ctx are meant to
> be used by rte_security library and the PMDs associated.
> These will be moved to an internal header in DPDK 23.11 release.
> 
> Signed-off-by: Akhil Goyal <gakhil@marvell.com>
> ---
>   doc/guides/rel_notes/deprecation.rst | 3 +++
>   1 file changed, 3 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 8e1cdd677a..74bdb4f577 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -133,6 +133,9 @@ Deprecation Notices
>     ``rte_cryptodev_get_auth_algo_string``, ``rte_cryptodev_get_aead_algo_string`` and
>     ``rte_cryptodev_asym_get_xform_string`` respectively.
>   
> +* security: Hide structures ``rte_security_ops`` and ``rte_security_ctx`` as these
> +  are internal to DPDK library and PMDs.
> +
>   * flow_classify: The flow_classify library and example have no maintainer.
>     The library is experimental and, as such, it could be removed from DPDK.
>     Its removal has been postponed to let potential users report interest

Acked-by: Konstantin Ananyev <konstantin.v.ananyev@yandex.ru>
  
Jerin Jacob July 5, 2023, 2:06 p.m. UTC | #3
On Wed, Jul 5, 2023 at 5:01 PM Konstantin Ananyev
<konstantin.v.ananyev@yandex.ru> wrote:
>
> 04/07/2023 20:44, Akhil Goyal пишет:
> > Structure rte_security_ops and rte_security_ctx are meant to
> > be used by rte_security library and the PMDs associated.
> > These will be moved to an internal header in DPDK 23.11 release.
> >
> > Signed-off-by: Akhil Goyal <gakhil@marvell.com>
> > ---
> >   doc/guides/rel_notes/deprecation.rst | 3 +++
> >   1 file changed, 3 insertions(+)
> >
> > diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> > index 8e1cdd677a..74bdb4f577 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -133,6 +133,9 @@ Deprecation Notices
> >     ``rte_cryptodev_get_auth_algo_string``, ``rte_cryptodev_get_aead_algo_string`` and
> >     ``rte_cryptodev_asym_get_xform_string`` respectively.
> >
> > +* security: Hide structures ``rte_security_ops`` and ``rte_security_ctx`` as these
> > +  are internal to DPDK library and PMDs.
> > +
> >   * flow_classify: The flow_classify library and example have no maintainer.
> >     The library is experimental and, as such, it could be removed from DPDK.
> >     Its removal has been postponed to let potential users report interest
>
> Acked-by: Konstantin Ananyev <konstantin.v.ananyev@yandex.ru>

Acked-by: Jerin Jacob <jerinj@marvell.com>
  
Power, Ciara July 6, 2023, 10:53 a.m. UTC | #4
Hi Akhil,

> -----Original Message-----
> From: Akhil Goyal <gakhil@marvell.com>
> Sent: Tuesday 4 July 2023 20:45
> To: dev@dpdk.org
> Cc: thomas@monjalon.net; david.marchand@redhat.com;
> jerinj@marvell.com; anoobj@marvell.com; ndabilpuram@marvell.com; De
> Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>;
> hemant.agrawal@nxp.com; g.singh@nxp.com;
> konstantin.v.ananyev@yandex.ru; Nicolau, Radu <radu.nicolau@intel.com>;
> Power, Ciara <ciara.power@intel.com>; ruifeng.wang@arm.com;
> matan@nvidia.com; fanzhang.oss@gmail.com; Akhil Goyal
> <gakhil@marvell.com>
> Subject: [PATCH] doc: announce deprecation for security ops
> 
> Structure rte_security_ops and rte_security_ctx are meant to be used by
> rte_security library and the PMDs associated.
> These will be moved to an internal header in DPDK 23.11 release.
> 
> Signed-off-by: Akhil Goyal <gakhil@marvell.com>
> ---
<snip>

Seems a reasonable change to me.

Acked-by: Ciara Power <ciara.power@intel.com>
  
Akhil Goyal July 6, 2023, 6:32 p.m. UTC | #5
> > Subject: [PATCH] doc: announce deprecation for security ops
> >
> > Structure rte_security_ops and rte_security_ctx are meant to be used by
> > rte_security library and the PMDs associated.
> > These will be moved to an internal header in DPDK 23.11 release.
> >
> > Signed-off-by: Akhil Goyal <gakhil@marvell.com>
> > ---
> <snip>
> 
> Seems a reasonable change to me.
> 
> Acked-by: Ciara Power <ciara.power@intel.com>
Applied to dpdk-next-crypto
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 8e1cdd677a..74bdb4f577 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -133,6 +133,9 @@  Deprecation Notices
   ``rte_cryptodev_get_auth_algo_string``, ``rte_cryptodev_get_aead_algo_string`` and
   ``rte_cryptodev_asym_get_xform_string`` respectively.
 
+* security: Hide structures ``rte_security_ops`` and ``rte_security_ctx`` as these
+  are internal to DPDK library and PMDs.
+
 * flow_classify: The flow_classify library and example have no maintainer.
   The library is experimental and, as such, it could be removed from DPDK.
   Its removal has been postponed to let potential users report interest