From mboxrd@z Thu Jan  1 00:00:00 1970
From: Panu Matilainen <pmatilai@redhat.com>
Subject: Re: [PATCH] cryptodev: mark experimental state
Date: Thu, 26 Nov 2015 09:39:09 +0200
Message-ID: <5656B71D.7030704@redhat.com>
References: <1448473135-19604-1-git-send-email-thomas.monjalon@6wind.com>
Mime-Version: 1.0
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Transfer-Encoding: 7bit
Cc: dev@dpdk.org
To: Thomas Monjalon <thomas.monjalon@6wind.com>, declan.doherty@intel.com
Return-path: <dev-bounces@dpdk.org>
Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28])
 by dpdk.org (Postfix) with ESMTP id 8B692C312
 for <dev@dpdk.org>; Thu, 26 Nov 2015 08:39:12 +0100 (CET)
In-Reply-To: <1448473135-19604-1-git-send-email-thomas.monjalon@6wind.com>
List-Id: patches and discussions about DPDK <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

On 11/25/2015 07:38 PM, Thomas Monjalon wrote:
> 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@6wind.com>
> ---
[...]
> --- 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
[...]

I think an experimental library which declares itself exempt from the 
ABI policy should not be compiled by default. That way anybody wanting 
to try it out will be forced to notice the experimental status.

More generally / longer term, perhaps there should be a 
CONFIG_RTE_EXPERIMENTAL which wraps all experimental features and 
defaults to off.

	- Panu -