diff mbox

[dpdk-dev,v3,4/4] doc: announce deprecation in crypto queue pair start/stop

Message ID 20180517090056.11349-5-pablo.de.lara.guarch@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Pablo de Lara Guarch
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

De Lara Guarch, Pablo May 17, 2018, 9 a.m. UTC 
  Functions rte_cryptodev_queue_pair_start/stop
are not really used in any of the crypto drivers
(they all just return 0 or -ENOTSUP).
Therefore, this API can be deprecated from 18.02
and removed in 18.05.

Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
---
 doc/guides/rel_notes/deprecation.rst | 4 ++++
 lib/librte_cryptodev/rte_cryptodev.h | 2 ++
 2 files changed, 6 insertions(+)

Comments

Fiona Trahe May 17, 2018, 11:32 a.m. UTC | #1 
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Pablo de Lara
> Sent: Thursday, May 17, 2018 10:01 AM
> To: Doherty, Declan <declan.doherty@intel.com>; akhil.goyal@nxp.com
> Cc: dev@dpdk.org; De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
> Subject: [dpdk-dev] [PATCH v3 4/4] doc: announce deprecation in crypto queue pair start/stop
> 
> Functions rte_cryptodev_queue_pair_start/stop
> are not really used in any of the crypto drivers
> (they all just return 0 or -ENOTSUP).
> Therefore, this API can be deprecated from 18.02
> and removed in 18.05.
> 
> Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
> Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
[Fiona] I guess you mean 18.05/18.08. Apart from that 
Acked-by: Fiona Trahe <fiona.trahe@intel.com>
diff mbox

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index cd75150a6..6c7978d1b 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -84,3 +84,7 @@  Deprecation Notices
     ``rte_cryptodev_queue_pair_dettach_sym_session()`` will be deprecated from
     18.02 and removed in 18.05, as there are no drivers doing anything useful
     with them.
+  - Functions ``rte_cryptodev_queue_pair_start()`` and
+    ``rte_cryptodev_queue_pair_stop()`` will be deprecated from 18.02
+    and removed in 18.05, as there are no drivers doing anything useful
+    with them.
diff --git a/lib/librte_cryptodev/rte_cryptodev.h b/lib/librte_cryptodev/rte_cryptodev.h
index 93eb9ffe2..364cc4399 100644
--- a/lib/librte_cryptodev/rte_cryptodev.h
+++ b/lib/librte_cryptodev/rte_cryptodev.h
@@ -602,6 +602,7 @@  rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
 		struct rte_mempool *session_pool);
 
 /**
+ * @deprecated
  * Start a specified queue pair of a device. It is used
  * when deferred_start flag of the specified queue is true.
  *
@@ -619,6 +620,7 @@  extern int
 rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id);
 
 /**
+ * @deprecated
  * Stop specified queue pair of a device
  *
  * @param	dev_id		The identifier of the device