mbuf_offload: mark experimental state

Cryptodev was marked experimental and mbuf_offload depends on it.
The mbuf_offload library is one of the crypto area which requires
some discussions before having a stable API.

The experimental mark is also added to rte_cryptodev_configure()
to be sure one cannot miss it.

Fixes: 66874e55f550 ("cryptodev: mark experimental state")

Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>

diff --git a/MAINTAINERS b/MAINTAINERS
index a3ff3f2..3292e84 100644 (file)
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -217,7 +217,7 @@ F: lib/librte_mbuf/
 F: doc/guides/prog_guide/mbuf_lib.rst
 F: app/test/test_mbuf.c
 
-Packet buffer offload
+Packet buffer offload - EXPERIMENTAL
 M: Declan Doherty <declan.doherty@intel.com>
 F: lib/librte_mbuf_offload/
 

diff --git a/config/common_bsdapp b/config/common_bsdapp
index 07328d9..8a4d448 100644 (file)
--- a/config/common_bsdapp
+++ b/config/common_bsdapp
@@ -362,6 +362,7 @@ CONFIG_RTE_PKTMBUF_HEADROOM=128
 
 #
 # Compile librte_mbuf_offload
+# EXPERIMENTAL: API may change without prior notice
 #
 CONFIG_RTE_LIBRTE_MBUF_OFFLOAD=y
 CONFIG_RTE_LIBRTE_MBUF_OFFLOAD_DEBUG=n

diff --git a/config/common_linuxapp b/config/common_linuxapp
index ba9e55d..dda309c 100644 (file)
--- a/config/common_linuxapp
+++ b/config/common_linuxapp
@@ -379,6 +379,7 @@ CONFIG_RTE_PKTMBUF_HEADROOM=128
 
 #
 # Compile librte_mbuf_offload
+# EXPERIMENTAL: API may change without prior notice
 #
 CONFIG_RTE_LIBRTE_MBUF_OFFLOAD=y
 CONFIG_RTE_LIBRTE_MBUF_OFFLOAD_DEBUG=n

diff --git a/lib/librte_cryptodev/rte_cryptodev.h b/lib/librte_cryptodev/rte_cryptodev.h
index aa9f785..892375d 100644 (file)
--- a/lib/librte_cryptodev/rte_cryptodev.h
+++ b/lib/librte_cryptodev/rte_cryptodev.h
@@ -243,6 +243,8 @@ struct rte_cryptodev_config {
 /**
  * Configure a device.
  *
+ * EXPERIMENTAL: this API file may change without prior notice
+ *
  * This function must be invoked first before any other function in the
  * API. This function can also be re-invoked when a device is in the
  * stopped state.

diff --git a/lib/librte_mbuf_offload/rte_mbuf_offload.h b/lib/librte_mbuf_offload/rte_mbuf_offload.h
index f52f163..4345f06 100644 (file)
--- a/lib/librte_mbuf_offload/rte_mbuf_offload.h
+++ b/lib/librte_mbuf_offload/rte_mbuf_offload.h
@@ -51,6 +51,9 @@
  * operations, with supporting allocate and free functions. It also provides
  * APIs for attaching an offload to a mbuf, as well as an API to retrieve a
  * specified offload type from an mbuf offload chain.
+ *
+ * @warning
+ * @b EXPERIMENTAL: this API may change without prior notice
  */
 
 #include <rte_mbuf.h>
@@ -92,6 +95,8 @@ struct rte_pktmbuf_offload_pool_private {
 /**
  * Creates a mempool of rte_mbuf_offload objects
  *
+ * EXPERIMENTAL: this API file may change without prior notice
+ *
  * @param      name            mempool name
  * @param      size            number of objects in mempool
  * @param      cache_size      cache size of objects for each core