doc: announce renaming in crypto scheduler API
authorAdam Dybkowski <adamx.dybkowski@intel.com>
Mon, 27 Jul 2020 09:41:13 +0000 (11:41 +0200)
committerThomas Monjalon <thomas@monjalon.net>
Wed, 12 Aug 2020 12:22:20 +0000 (14:22 +0200)
This patch adds a deprecation notice about upcoming changes
in public API of the Scheduler PMD.

Signed-off-by: Adam Dybkowski <adamx.dybkowski@intel.com>
Acked-by: Fan Zhang <roy.fan.zhang@intel.com>
Acked-by: Thomas Monjalon <thomas@monjalon.net>
Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
doc/guides/rel_notes/deprecation.rst

index c2770fe..345c38d 100644 (file)
@@ -281,6 +281,13 @@ Deprecation Notices
   to one it means it represents IV, when is set to zero it means J0 is used
   directly, in this case 16 bytes of J0 need to be passed.
 
+* scheduler: The functions ``rte_cryptodev_scheduler_slave_attach``,
+  ``rte_cryptodev_scheduler_slave_detach`` and
+  ``rte_cryptodev_scheduler_slaves_get`` will be replaced in 20.11 by
+  ``rte_cryptodev_scheduler_worker_attach``,
+  ``rte_cryptodev_scheduler_worker_detach`` and
+  ``rte_cryptodev_scheduler_workers_get`` accordingly.
+
 * eventdev: Following structures will be modified to support DLB PMD
   and future extensions: