[dpdk-dev] [PATCH] cryptodev: mark experimental state

[Thomas Monjalon]

The crypto API is in an early state.
It requires more discussions and experiments to declare it stable,
as discussed in http://dpdk.org/ml/archives/dev/2015-November/028634.html

A documentation section will be required in the guides.

Signed-off-by: Thomas Monjalon <thomas.monjalon at 6wind.com>
---
 MAINTAINERS                            |  2 +-
 config/common_bsdapp                   |  1 +
 config/common_linuxapp                 |  1 +
 doc/guides/contributing/versioning.rst |  1 +
 doc/guides/rel_notes/release_2_2.rst   | 10 ++++++++++
 lib/librte_cryptodev/rte_cryptodev.h   |  3 +++
 6 files changed, 17 insertions(+), 1 deletion(-)

diff --git a/MAINTAINERS b/MAINTAINERS
index 7f3d967..460245b 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -219,7 +219,7 @@ M: Thomas Monjalon <thomas.monjalon at 6wind.com>
 F: lib/librte_ether/
 F: scripts/test-null.sh
 
-Crypto API
+Crypto API - EXPERIMENTAL
 M: Declan Doherty <declan.doherty at intel.com>
 F: lib/librte_cryptodev/
 F: app/test/test_cryptodev*
diff --git a/config/common_bsdapp b/config/common_bsdapp
index 56020b6..3286481 100644
--- a/config/common_bsdapp
+++ b/config/common_bsdapp
@@ -310,6 +310,7 @@ CONFIG_RTE_PMD_PACKET_PREFETCH=y
 
 #
 # Compile generic crypto device library
+# EXPERIMENTAL: API may change without prior notice
 #
 CONFIG_RTE_LIBRTE_CRYPTODEV=y
 CONFIG_RTE_LIBRTE_CRYPTODEV_DEBUG=n
diff --git a/config/common_linuxapp b/config/common_linuxapp
index eaad8d6..2866986 100644
--- a/config/common_linuxapp
+++ b/config/common_linuxapp
@@ -319,6 +319,7 @@ CONFIG_RTE_PMD_PACKET_PREFETCH=y
 
 #
 # Compile generic crypto device library
+# EXPERIMENTAL: API may change without prior notice
 #
 CONFIG_RTE_LIBRTE_CRYPTODEV=y
 CONFIG_RTE_LIBRTE_CRYPTODEV_DEBUG=n
diff --git a/doc/guides/contributing/versioning.rst b/doc/guides/contributing/versioning.rst
index 8a739dd..653c7d0 100644
--- a/doc/guides/contributing/versioning.rst
+++ b/doc/guides/contributing/versioning.rst
@@ -13,6 +13,7 @@ General Guidelines
 ------------------
 
 #. Whenever possible, ABI should be preserved
+#. The libraries marked in experimental state may change without constraint.
 #. The addition of symbols is generally not problematic
 #. The modification of symbols can generally be managed with versioning
 #. The removal of symbols generally is an ABI break and requires bumping of the
diff --git a/doc/guides/rel_notes/release_2_2.rst b/doc/guides/rel_notes/release_2_2.rst
index 8c77768..d0a9955 100644
--- a/doc/guides/rel_notes/release_2_2.rst
+++ b/doc/guides/rel_notes/release_2_2.rst
@@ -17,6 +17,16 @@ New Features
 
 * **Added keepalive support to EAL and example application.**
 
+* **Added experimental cryptodev API**
+
+  The cryptographic processing of packet is provided as a preview
+  with two drivers for:
+
+  * Intel QuickAssist devices
+  * Intel AES-NI multi-buffer library
+
+  Due to its experimental state, the API may change without prior notice.
+
 * **Added ethdev API to support IEEE1588.**
 
   Added functions to read, write and adjust system time in the NIC.
diff --git a/lib/librte_cryptodev/rte_cryptodev.h b/lib/librte_cryptodev/rte_cryptodev.h
index 04bade7..aa9f785 100644
--- a/lib/librte_cryptodev/rte_cryptodev.h
+++ b/lib/librte_cryptodev/rte_cryptodev.h
@@ -39,6 +39,9 @@
  *
  * Defines RTE Crypto Device APIs for the provisioning of cipher and
  * authentication operations.
+ *
+ * @warning
+ * @b EXPERIMENTAL: this API may change without prior notice
  */
 
 #ifdef __cplusplus
-- 
2.5.2