diff mbox

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

Message ID 20180130121415.16623-4-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 fail apply issues

Commit Message

De Lara Guarch, Pablo Jan. 30, 2018, 12:14 p.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 | 5 +++++
 lib/librte_cryptodev/rte_cryptodev.h | 2 ++
 2 files changed, 7 insertions(+)
diff mbox

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index bd4200bba..805fb885e 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -69,3 +69,8 @@  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.
+
+* cryptodev: 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 4597f864d..712342c72 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