From mboxrd@z Thu Jan 1 00:00:00 1970 From: Ian Betts Subject: [PATCH] examples: mark performance-thread example as experimental Date: Thu, 10 Dec 2015 12:24:58 +0000 Message-ID: <1449750298-6209-1-git-send-email-ian.betts@intel.com> Cc: Ian Betts To: dev@dpdk.org Return-path: Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id 87A1F8E79 for ; Thu, 10 Dec 2015 13:25:02 +0100 (CET) List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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 --- doc/guides/rel_notes/release_2_2.rst | 8 ++++++++ examples/Makefile | 4 +--- examples/performance-thread/common/lthread_api.h | 5 ++++- examples/performance-thread/common/lthread_diag_api.h | 6 ++++++ 4 files changed, 19 insertions(+), 4 deletions(-) diff --git a/doc/guides/rel_notes/release_2_2.rst b/doc/guides/rel_notes/release_2_2.rst index 0368e04..9ea0ba8 100644 --- a/doc/guides/rel_notes/release_2_2.rst +++ b/doc/guides/rel_notes/release_2_2.rst @@ -131,7 +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 --- 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 --- 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 --- 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 -- 1.9.3