From: Honnappa Nagarahalli <Honnappa.Nagarahalli@arm.com>
To: David Marchand <david.marchand@redhat.com>,
"dev@dpdk.org" <dev@dpdk.org>
Cc: "thomas@monjalon.net" <thomas@monjalon.net>,
"techboard@dpdk.org" <techboard@dpdk.org>,
"stable@dpdk.org" <stable@dpdk.org>,
Nicolas Chautru <nicolas.chautru@intel.com>,
Konstantin Ananyev <konstantin.ananyev@intel.com>,
Fiona Trahe <fiona.trahe@intel.com>,
Ashish Gupta <ashish.gupta@marvell.com>,
Vladimir Medvedkin <vladimir.medvedkin@intel.com>,
Bernard Iremonger <bernard.iremonger@intel.com>,
Gage Eads <gage.eads@intel.com>,
Olivier Matz <olivier.matz@6wind.com>,
Kevin Laatz <kevin.laatz@intel.com>, nd <nd@arm.com>,
Honnappa Nagarahalli <Honnappa.Nagarahalli@arm.com>,
nd <nd@arm.com>
Subject: Re: [dpdk-stable] [PATCH 3/3] lib: remind experimental status in library headers
Date: Fri, 22 May 2020 14:15:51 +0000 [thread overview]
Message-ID: <DBBPR08MB46462A19F0D9388542498D5998B40@DBBPR08MB4646.eurprd08.prod.outlook.com> (raw)
In-Reply-To: <20200522065855.31056-4-david.marchand@redhat.com>
<snip>
> Subject: [PATCH 3/3] lib: remind experimental status in library headers
>
> The following libraries are experimental, all of their functions can change or
> disappear:
>
> - librte_bbdev
> - librte_bpf
> - librte_compressdev
> - librte_fib
> - librte_flow_classify
> - librte_ipsec
> - librte_rcu
> - librte_rib
> - librte_stack
> - librte_telemetry
>
> Their status is properly announced in MAINTAINERS.
> Remind this status in their headers in a common fashion.
>
> Cc: stable@dpdk.org
>
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---
> lib/librte_bbdev/rte_bbdev.h | 3 ++-
> lib/librte_bpf/rte_bpf.h | 6 +++++-
> lib/librte_compressdev/rte_compressdev.h | 6 +++++-
> lib/librte_fib/rte_fib.h | 7 +++++++
> lib/librte_fib/rte_fib6.h | 7 +++++++
> lib/librte_flow_classify/rte_flow_classify.h | 6 ++++--
> lib/librte_ipsec/rte_ipsec.h | 6 +++++-
> lib/librte_rcu/rte_rcu_qsbr.h | 7 ++++++-
> lib/librte_rib/rte_rib.h | 7 +++++++
> lib/librte_rib/rte_rib6.h | 7 +++++++
> lib/librte_stack/rte_stack.h | 7 +++++--
> lib/librte_telemetry/rte_telemetry.h | 10 ++++++----
> 12 files changed, 66 insertions(+), 13 deletions(-)
>
> diff --git a/lib/librte_bbdev/rte_bbdev.h b/lib/librte_bbdev/rte_bbdev.h index
> ecd95a823d..ab4e1bd6f4 100644
> --- a/lib/librte_bbdev/rte_bbdev.h
> +++ b/lib/librte_bbdev/rte_bbdev.h
> @@ -11,7 +11,8 @@
> * Wireless base band device abstraction APIs.
> *
> * @warning
> - * @b EXPERIMENTAL: this API may change without prior notice
> + * @b EXPERIMENTAL:
> + * All functions in this file may change or disappear without prior notice.
nit, is 'removed' a better choice instead of 'disappear'? May be something like:
All functions in this file may be changed or removed without prior notice.
> *
> * This API allows an application to discover, configure and use a device to
> * process operations. An asynchronous API (enqueue, followed by later
> dequeue) diff --git a/lib/librte_bpf/rte_bpf.h b/lib/librte_bpf/rte_bpf.h index
> cbf1cddaca..ceb3e26b03 100644
> --- a/lib/librte_bpf/rte_bpf.h
> +++ b/lib/librte_bpf/rte_bpf.h
> @@ -7,9 +7,13 @@
>
> /**
> * @file rte_bpf.h
> - * @b EXPERIMENTAL: this API may change without prior notice
> *
> * RTE BPF support.
> + *
> + * @warning
> + * @b EXPERIMENTAL:
> + * All functions in this file may change or disappear without prior notice.
> + *
> * librte_bpf provides a framework to load and execute eBPF bytecode
> * inside user-space dpdk based applications.
> * It supports basic set of features from eBPF spec diff --git
> a/lib/librte_compressdev/rte_compressdev.h
> b/lib/librte_compressdev/rte_compressdev.h
> index 8052efe675..9c873b347d 100644
> --- a/lib/librte_compressdev/rte_compressdev.h
> +++ b/lib/librte_compressdev/rte_compressdev.h
> @@ -8,7 +8,11 @@
> /**
> * @file rte_compressdev.h
> *
> - * RTE Compression Device APIs
> + * RTE Compression Device APIs.
> + *
> + * @warning
> + * @b EXPERIMENTAL:
> + * All functions in this file may change or disappear without prior notice.
> *
> * Defines comp device APIs for the provisioning of compression operations.
> */
> diff --git a/lib/librte_fib/rte_fib.h b/lib/librte_fib/rte_fib.h index
> af3bbf07ee..b52d058406 100644
> --- a/lib/librte_fib/rte_fib.h
> +++ b/lib/librte_fib/rte_fib.h
> @@ -8,6 +8,13 @@
>
> /**
> * @file
> + *
> + * RTE FIB library.
> + *
> + * @warning
> + * @b EXPERIMENTAL:
> + * All functions in this file may change or disappear without prior notice.
> + *
> * FIB (Forwarding information base) implementation
> * for IPv4 Longest Prefix Match
> */
> diff --git a/lib/librte_fib/rte_fib6.h b/lib/librte_fib/rte_fib6.h index
> 66c71c84c9..e6e8892ecb 100644
> --- a/lib/librte_fib/rte_fib6.h
> +++ b/lib/librte_fib/rte_fib6.h
> @@ -8,6 +8,13 @@
>
> /**
> * @file
> + *
> + * RTE FIB6 library.
> + *
> + * @warning
> + * @b EXPERIMENTAL:
> + * All functions in this file may change or disappear without prior notice.
> + *
> * FIB (Forwarding information base) implementation
> * for IPv6 Longest Prefix Match
> */
> diff --git a/lib/librte_flow_classify/rte_flow_classify.h
> b/lib/librte_flow_classify/rte_flow_classify.h
> index 74d1ecaf50..ac5b08aa6d 100644
> --- a/lib/librte_flow_classify/rte_flow_classify.h
> +++ b/lib/librte_flow_classify/rte_flow_classify.h
> @@ -8,9 +8,11 @@
> /**
> * @file
> *
> - * RTE Flow Classify Library
> + * RTE Flow Classify Library.
> *
> - * @b EXPERIMENTAL: this API may change without prior notice
> + * @warning
> + * @b EXPERIMENTAL:
> + * All functions in this file may change or disappear without prior notice.
> *
> * This library provides flow record information with some measured
> properties.
> *
> diff --git a/lib/librte_ipsec/rte_ipsec.h b/lib/librte_ipsec/rte_ipsec.h index
> 6666cf7619..50f109553c 100644
> --- a/lib/librte_ipsec/rte_ipsec.h
> +++ b/lib/librte_ipsec/rte_ipsec.h
> @@ -7,9 +7,13 @@
>
> /**
> * @file rte_ipsec.h
> - * @b EXPERIMENTAL: this API may change without prior notice
> *
> * RTE IPsec support.
> + *
> + * @warning
> + * @b EXPERIMENTAL:
> + * All functions in this file may change or disappear without prior notice.
> + *
> * librte_ipsec provides a framework for data-path IPsec protocol
> * processing (ESP/AH).
> */
> diff --git a/lib/librte_rcu/rte_rcu_qsbr.h b/lib/librte_rcu/rte_rcu_qsbr.h index
> fd4eb52b7f..891f64725e 100644
> --- a/lib/librte_rcu/rte_rcu_qsbr.h
> +++ b/lib/librte_rcu/rte_rcu_qsbr.h
> @@ -7,7 +7,12 @@
>
> /**
> * @file
> - * RTE Quiescent State Based Reclamation (QSBR)
> + *
> + * RTE Quiescent State Based Reclamation (QSBR).
> + *
> + * @warning
> + * @b EXPERIMENTAL:
> + * All functions in this file may change or disappear without prior notice.
> *
> * Quiescent State (QS) is any point in the thread execution
> * where the thread does not hold a reference to a data structure diff --git
> a/lib/librte_rib/rte_rib.h b/lib/librte_rib/rte_rib.h index
> 6b70de980a..729177870f 100644
> --- a/lib/librte_rib/rte_rib.h
> +++ b/lib/librte_rib/rte_rib.h
> @@ -8,6 +8,13 @@
>
> /**
> * @file
> + *
> + * RTE RIB library.
> + *
> + * @warning
> + * @b EXPERIMENTAL:
> + * All functions in this file may change or disappear without prior notice.
> + *
> * Level compressed tree implementation for IPv4 Longest Prefix Match
> */
>
> diff --git a/lib/librte_rib/rte_rib6.h b/lib/librte_rib/rte_rib6.h index
> 871457138d..cbdb3fe5c2 100644
> --- a/lib/librte_rib/rte_rib6.h
> +++ b/lib/librte_rib/rte_rib6.h
> @@ -8,6 +8,13 @@
>
> /**
> * @file
> + *
> + * RTE rib6 library.
> + *
> + * @warning
> + * @b EXPERIMENTAL:
> + * All functions in this file may change or disappear without prior notice.
> + *
> * Level compressed tree implementation for IPv6 Longest Prefix Match
> */
>
> diff --git a/lib/librte_stack/rte_stack.h b/lib/librte_stack/rte_stack.h index
> 27ddb199e5..7ac0b49eb6 100644
> --- a/lib/librte_stack/rte_stack.h
> +++ b/lib/librte_stack/rte_stack.h
> @@ -4,9 +4,12 @@
>
> /**
> * @file rte_stack.h
> - * @b EXPERIMENTAL: this API may change without prior notice
> *
> - * RTE Stack
> + * RTE Stack.
> + *
> + * @warning
> + * @b EXPERIMENTAL:
> + * All functions in this file may change or disappear without prior notice.
> *
> * librte_stack provides an API for configuration and use of a bounded stack
> of
> * pointers. Push and pop operations are MT-safe, allowing concurrent access,
> diff --git a/lib/librte_telemetry/rte_telemetry.h
> b/lib/librte_telemetry/rte_telemetry.h
> index 2c3c96cf73..f42457911f 100644
> --- a/lib/librte_telemetry/rte_telemetry.h
> +++ b/lib/librte_telemetry/rte_telemetry.h
> @@ -20,11 +20,13 @@
> #define RTE_TEL_MAX_ARRAY_ENTRIES 512
>
> /**
> - * @warning
> - * @b EXPERIMENTAL: all functions in this file may change without prior
> notice
> - *
> * @file
> - * RTE Telemetry
> + *
> + * RTE Telemetry.
> + *
> + * @warning
> + * @b EXPERIMENTAL:
> + * All functions in this file may change or disappear without prior notice.
> *
> * The telemetry library provides a method to retrieve statistics from
> * DPDK by sending a request message over a socket. DPDK will send
> --
> 2.23.0
next prev parent reply other threads:[~2020-05-22 14:16 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20200522065855.31056-1-david.marchand@redhat.com>
2020-05-22 6:58 ` David Marchand
2020-05-22 14:15 ` Honnappa Nagarahalli [this message]
2020-05-28 6:53 ` David Marchand
2020-05-28 18:40 ` Honnappa Nagarahalli
2020-05-26 13:28 ` Eads, Gage
2020-05-28 6:56 ` David Marchand
[not found] ` <20200625072112.22351-1-david.marchand@redhat.com>
2020-06-25 7:21 ` [dpdk-stable] [PATCH v2 " David Marchand
[not found] ` <20200626081638.29890-1-david.marchand@redhat.com>
2020-06-26 8:16 ` [dpdk-stable] [PATCH v3 " David Marchand
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=DBBPR08MB46462A19F0D9388542498D5998B40@DBBPR08MB4646.eurprd08.prod.outlook.com \
--to=honnappa.nagarahalli@arm.com \
--cc=ashish.gupta@marvell.com \
--cc=bernard.iremonger@intel.com \
--cc=david.marchand@redhat.com \
--cc=dev@dpdk.org \
--cc=fiona.trahe@intel.com \
--cc=gage.eads@intel.com \
--cc=kevin.laatz@intel.com \
--cc=konstantin.ananyev@intel.com \
--cc=nd@arm.com \
--cc=nicolas.chautru@intel.com \
--cc=olivier.matz@6wind.com \
--cc=stable@dpdk.org \
--cc=techboard@dpdk.org \
--cc=thomas@monjalon.net \
--cc=vladimir.medvedkin@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).