examples/performance-thread: mark as experimental

This commit removes the performance thread example from
examples/Makefile, and marks the example as "experimental"
in the release note, and it its API headers files.

Signed-off-by: Ian Betts <ian.betts@intel.com>

diff --git a/MAINTAINERS b/MAINTAINERS
index 6af0bc3..a3ff3f2 100644 (file)
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -563,6 +563,7 @@ F: doc/guides/sample_app_ug/load_balancer.rst
 F: examples/netmap_compat/
 F: doc/guides/sample_app_ug/netmap_compatibility.rst
 
+L-threads - EXPERIMENTAL
 M: Ian Betts <ian.betts@intel.com>
 F: examples/performance-thread/
 F: doc/guides/sample_app_ug/performance_thread.rst

diff --git a/doc/guides/rel_notes/release_2_2.rst b/doc/guides/rel_notes/release_2_2.rst
index 0368e04..591f4cc 100644 (file)
--- a/doc/guides/rel_notes/release_2_2.rst
+++ b/doc/guides/rel_notes/release_2_2.rst
@@ -131,6 +131,15 @@ New Features
 
 * **Added ethtool shim and sample application.**
 
+* **Added experimental performance thread example application.**
+
+  The application demonstrates L3 fowarding with different threading
+  models: pthreads, cgroups, or lighweight threads. The example inludes
+  a simple cooperative scheduler.
+
+  Due to its experimental state this application may change without notice.
+  The application is supported only for Linux x86_64.
+
 
 Resolved Issues
 ---------------

diff --git a/examples/Makefile b/examples/Makefile
index fc57e16..1cb4785 100644 (file)
--- a/examples/Makefile
+++ b/examples/Makefile
@@ -78,7 +78,5 @@ DIRS-y += vmdq
 DIRS-y += vmdq_dcb
 DIRS-$(CONFIG_RTE_LIBRTE_POWER) += vm_power_manager
 DIRS-$(CONFIG_RTE_LIBRTE_CRYPTODEV) += l2fwd-crypto
-ifneq ($(CONFIG_RTE_EXEC_ENV_LINUXAPP),)
-DIRS-$(CONFIG_RTE_ARCH_X86_64) += performance-thread
-endif
+
 include $(RTE_SDK)/mk/rte.extsubdir.mk

diff --git a/examples/performance-thread/common/lthread_api.h b/examples/performance-thread/common/lthread_api.h
index e5e7dcc..ec97610 100644 (file)
--- a/examples/performance-thread/common/lthread_api.h
+++ b/examples/performance-thread/common/lthread_api.h
@@ -60,7 +60,10 @@
  */
 
 /**
- *  @file
+ *  @file lthread_api.h
+ *
+ *  @warning
+ *  @b EXPERIMENTAL: this API may change without prior notice
  *
  *  This file contains the public API for the L-thread subsystem
  *

diff --git a/examples/performance-thread/common/lthread_diag_api.h b/examples/performance-thread/common/lthread_diag_api.h
index d8e477b..7ee514f 100644 (file)
--- a/examples/performance-thread/common/lthread_diag_api.h
+++ b/examples/performance-thread/common/lthread_diag_api.h
@@ -44,6 +44,12 @@
 #define LTHREAD_DIAG 0
 
 /**
+ *
+ * @file lthread_diag_api.h
+ *
+ * @warning
+ * @b EXPERIMENTAL: this API may change without prior notice
+ *
  * lthread diagnostic interface
  *
  * If enabled via configuration file option ( tbd ) the lthread subsystem