patches for DPDK stable branches
 help / color / Atom feed
* [dpdk-stable] [PATCH 3/3] lib: remind experimental status in library headers
       [not found] <20200522065855.31056-1-david.marchand@redhat.com>
@ 2020-05-22  6:58 ` David Marchand
  2020-05-22 14:15   ` Honnappa Nagarahalli
  2020-05-26 13:28   ` Eads, Gage
       [not found] ` <20200625072112.22351-1-david.marchand@redhat.com>
       [not found] ` <20200626081638.29890-1-david.marchand@redhat.com>
  2 siblings, 2 replies; 8+ messages in thread
From: David Marchand @ 2020-05-22  6:58 UTC (permalink / raw)
  To: dev
  Cc: thomas, techboard, stable, Nicolas Chautru, Konstantin Ananyev,
	Fiona Trahe, Ashish Gupta, Vladimir Medvedkin, Bernard Iremonger,
	Honnappa Nagarahalli, Gage Eads, Olivier Matz, Kevin Laatz

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.
  *
  * 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


^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [dpdk-stable] [PATCH 3/3] lib: remind experimental status in library headers
  2020-05-22  6:58 ` [dpdk-stable] [PATCH 3/3] lib: remind experimental status in library headers David Marchand
@ 2020-05-22 14:15   ` Honnappa Nagarahalli
  2020-05-28  6:53     ` David Marchand
  2020-05-26 13:28   ` Eads, Gage
  1 sibling, 1 reply; 8+ messages in thread
From: Honnappa Nagarahalli @ 2020-05-22 14:15 UTC (permalink / raw)
  To: David Marchand, dev
  Cc: thomas, techboard, stable, Nicolas Chautru, Konstantin Ananyev,
	Fiona Trahe, Ashish Gupta, Vladimir Medvedkin, Bernard Iremonger,
	Gage Eads, Olivier Matz, Kevin Laatz, nd, Honnappa Nagarahalli,
	nd

<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


^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [dpdk-stable] [PATCH 3/3] lib: remind experimental status in library headers
  2020-05-22  6:58 ` [dpdk-stable] [PATCH 3/3] lib: remind experimental status in library headers David Marchand
  2020-05-22 14:15   ` Honnappa Nagarahalli
@ 2020-05-26 13:28   ` Eads, Gage
  2020-05-28  6:56     ` David Marchand
  1 sibling, 1 reply; 8+ messages in thread
From: Eads, Gage @ 2020-05-26 13:28 UTC (permalink / raw)
  To: David Marchand, dev
  Cc: thomas, techboard, stable, Chautru, Nicolas, Ananyev, Konstantin,
	Trahe, Fiona, Ashish Gupta, Medvedkin, Vladimir, Iremonger,
	Bernard, Honnappa Nagarahalli, Olivier Matz, Laatz, Kevin



> -----Original Message-----
> From: David Marchand <david.marchand@redhat.com>
> Sent: Friday, May 22, 2020 1:59 AM
> To: dev@dpdk.org
> Cc: thomas@monjalon.net; techboard@dpdk.org; stable@dpdk.org; Chautru,
> Nicolas <nicolas.chautru@intel.com>; Ananyev, Konstantin
> <konstantin.ananyev@intel.com>; Trahe, Fiona <fiona.trahe@intel.com>;
> Ashish Gupta <ashish.gupta@marvell.com>; Medvedkin, Vladimir
> <vladimir.medvedkin@intel.com>; Iremonger, Bernard
> <bernard.iremonger@intel.com>; Honnappa Nagarahalli
> <honnappa.nagarahalli@arm.com>; Eads, Gage <gage.eads@intel.com>; Olivier
> Matz <olivier.matz@6wind.com>; Laatz, Kevin <kevin.laatz@intel.com>
> 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

Thanks David. The stack library was added a year ago and its interfaces have been stable since then, so I think it better to drop its experimental tag altogether.

If there's no opposition to that, I can submit that patch separately.

Thanks,
Gage

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [dpdk-stable] [PATCH 3/3] lib: remind experimental status in library headers
  2020-05-22 14:15   ` Honnappa Nagarahalli
@ 2020-05-28  6:53     ` David Marchand
  2020-05-28 18:40       ` Honnappa Nagarahalli
  0 siblings, 1 reply; 8+ messages in thread
From: David Marchand @ 2020-05-28  6:53 UTC (permalink / raw)
  To: Honnappa Nagarahalli
  Cc: dev, thomas, techboard, stable, Nicolas Chautru,
	Konstantin Ananyev, Fiona Trahe, Ashish Gupta,
	Vladimir Medvedkin, Bernard Iremonger, Gage Eads, Olivier Matz,
	Kevin Laatz, nd, Ray Kinsella, Neil Horman

Hello Honnappa,

On Fri, May 22, 2020 at 4:16 PM Honnappa Nagarahalli
<Honnappa.Nagarahalli@arm.com> wrote:
> > @@ -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.

I used the same form than in the abi policy (that I wanted but forgot
to update in patch 1 afterwards... will be fixed in v2).

#. Libraries or APIs marked as :ref:`experimental <experimental_apis>` may
   change without constraint, as they are not considered part of an ABI version.
   Experimental libraries have the major ABI version ``0``.

No strong opinion, but I prefer keeping a single phrasing.
If we go with your suggestion, I will update the abi policy.


-- 
David Marchand


^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [dpdk-stable] [PATCH 3/3] lib: remind experimental status in library headers
  2020-05-26 13:28   ` Eads, Gage
@ 2020-05-28  6:56     ` David Marchand
  0 siblings, 0 replies; 8+ messages in thread
From: David Marchand @ 2020-05-28  6:56 UTC (permalink / raw)
  To: Eads, Gage, Olivier Matz
  Cc: dev, thomas, techboard, stable, Chautru, Nicolas, Ananyev,
	Konstantin, Trahe, Fiona, Ashish Gupta, Medvedkin, Vladimir,
	Iremonger, Bernard, Honnappa Nagarahalli, Laatz, Kevin

Hello Gage,

On Tue, May 26, 2020 at 3:29 PM Eads, Gage <gage.eads@intel.com> wrote:
> > 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
>
> Thanks David. The stack library was added a year ago and its interfaces have been stable since then, so I think it better to drop its experimental tag altogether.
>
> If there's no opposition to that, I can submit that patch separately.

Just saw your patch.
As long as Olivier and you are comfortable this API is mature enough,
I am fine with anything :-).


-- 
David Marchand


^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [dpdk-stable] [PATCH 3/3] lib: remind experimental status in library headers
  2020-05-28  6:53     ` David Marchand
@ 2020-05-28 18:40       ` Honnappa Nagarahalli
  0 siblings, 0 replies; 8+ messages in thread
From: Honnappa Nagarahalli @ 2020-05-28 18:40 UTC (permalink / raw)
  To: David Marchand
  Cc: dev, thomas, techboard, stable, Nicolas Chautru,
	Konstantin Ananyev, Fiona Trahe, Ashish Gupta,
	Honnappa Nagarahalli, Vladimir Medvedkin, Bernard Iremonger,
	Gage Eads, Olivier Matz, Kevin Laatz, nd, Ray Kinsella,
	Neil Horman, nd

<snip>

> 
> Hello Honnappa,
> 
> On Fri, May 22, 2020 at 4:16 PM Honnappa Nagarahalli
> <Honnappa.Nagarahalli@arm.com> wrote:
> > > @@ -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.
> 
> I used the same form than in the abi policy (that I wanted but forgot to
> update in patch 1 afterwards... will be fixed in v2).
> 
> #. Libraries or APIs marked as :ref:`experimental <experimental_apis>` may
>    change without constraint, as they are not considered part of an ABI version.
>    Experimental libraries have the major ABI version ``0``.
> 
> No strong opinion, but I prefer keeping a single phrasing.
> If we go with your suggestion, I will update the abi policy.
Agree on using the same wording.
IMO, we should capture the 'removed/disappear' wording in the ABI policy.

> 
> 
> --
> David Marchand


^ permalink raw reply	[flat|nested] 8+ messages in thread

* [dpdk-stable] [PATCH v2 3/3] lib: remind experimental status in library headers
       [not found] ` <20200625072112.22351-1-david.marchand@redhat.com>
@ 2020-06-25  7:21   ` " David Marchand
  0 siblings, 0 replies; 8+ messages in thread
From: David Marchand @ 2020-06-25  7:21 UTC (permalink / raw)
  To: dev
  Cc: thomas, honnappa.nagarahalli, techboard, stable, Ray Kinsella,
	Neil Horman, John McNamara, Marko Kovacevic, Nicolas Chautru,
	Konstantin Ananyev, Fiona Trahe, Ashish Gupta,
	Vladimir Medvedkin, Bernard Iremonger, Gage Eads, Olivier Matz,
	Kevin Laatz

The following libraries are experimental, all of their functions can
be changed or removed:

- 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 (aligned to ABI
docs).

Cc: stable@dpdk.org

Signed-off-by: David Marchand <david.marchand@redhat.com>
---
Changes since v1:
- updated wording following Honnappa comment

---
 doc/guides/contributing/abi_policy.rst       |  8 +++++---
 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 ++++++----
 13 files changed, 71 insertions(+), 16 deletions(-)

diff --git a/doc/guides/contributing/abi_policy.rst b/doc/guides/contributing/abi_policy.rst
index 1b2fa27865..d0affa9e60 100644
--- a/doc/guides/contributing/abi_policy.rst
+++ b/doc/guides/contributing/abi_policy.rst
@@ -27,7 +27,8 @@ General Guidelines
 #. The removal of symbols is considered an :ref:`ABI breakage <abi_breakages>`,
    once approved these will form part of the next ABI version.
 #. Libraries or APIs marked as :ref:`experimental <experimental_apis>` may
-   change without constraint, as they are not considered part of an ABI version.
+   be changed or removed without prior notice, as they are not considered part
+   of an ABI version.
 #. Updates to the :ref:`minimum hardware requirements <hw_rqmts>`, which drop
    support for hardware which was previously supported, should be treated as an
    ABI change.
@@ -294,7 +295,7 @@ APIs
 ~~~~
 
 APIs marked as ``experimental`` are not considered part of an ABI version and
-may change without warning at any time. Since changes to APIs are most likely
+may be changed or removed without prior notice. Since changes to APIs are most likely
 immediately after their introduction, as users begin to take advantage of those
 new APIs and start finding issues with them, new DPDK APIs will be automatically
 marked as ``experimental`` to allow for a period of stabilization before they
@@ -330,4 +331,5 @@ Libraries
 ~~~~~~~~~
 
 Libraries marked as ``experimental`` are entirely not considered part of an ABI
-version, and may change without warning at any time.
+version.
+All functions in such libraries may be changed or removed without prior notice.
diff --git a/lib/librte_bbdev/rte_bbdev.h b/lib/librte_bbdev/rte_bbdev.h
index ecd95a823d..57291373fa 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 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..e2d419b4ef 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 be changed or removed 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..2840c27c6c 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 be changed or removed 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..84ee774d2d 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 be changed or removed 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..bbfcf23a85 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 be changed or removed 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..82ea92b6a6 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 be changed or removed 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..de05f4e932 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 be changed or removed 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..a98e8f0f82 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 be changed or removed 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..da558c417e 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 be changed or removed 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..4b284c913c 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 be changed or removed 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..abf6420766 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 be changed or removed 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 eb7f2c917c..d13010b8fb 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 be changed or removed 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


^ permalink raw reply	[flat|nested] 8+ messages in thread

* [dpdk-stable] [PATCH v3 3/3] lib: remind experimental status in library headers
       [not found] ` <20200626081638.29890-1-david.marchand@redhat.com>
@ 2020-06-26  8:16   ` " David Marchand
  0 siblings, 0 replies; 8+ messages in thread
From: David Marchand @ 2020-06-26  8:16 UTC (permalink / raw)
  To: dev
  Cc: thomas, honnappa.nagarahalli, techboard, stable, Ray Kinsella,
	Neil Horman, John McNamara, Marko Kovacevic, Nicolas Chautru,
	Konstantin Ananyev, Fiona Trahe, Ashish Gupta,
	Vladimir Medvedkin, Bernard Iremonger, Jerin Jacob,
	Kiran Kumar K, Nithin Dabilpuram, Pavan Nikhilesh, Gage Eads,
	Olivier Matz, Kevin Laatz

The following libraries are experimental, all of their functions can
be changed or removed:

- librte_bbdev
- librte_bpf
- librte_compressdev
- librte_fib
- librte_flow_classify
- librte_graph
- librte_ipsec
- librte_node
- 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 (aligned to ABI
docs).

Cc: stable@dpdk.org

Signed-off-by: David Marchand <david.marchand@redhat.com>
---
Changes since v2:
- updated librte_graph and librte_node

Changes since v1:
- updated wording following Honnappa comment

---
 doc/guides/contributing/abi_policy.rst       |  8 +++++---
 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_graph/rte_graph.h                 |  3 ++-
 lib/librte_graph/rte_graph_worker.h          |  3 ++-
 lib/librte_ipsec/rte_ipsec.h                 |  6 +++++-
 lib/librte_node/rte_node_eth_api.h           |  3 ++-
 lib/librte_node/rte_node_ip4_api.h           |  3 ++-
 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 ++++++----
 17 files changed, 79 insertions(+), 20 deletions(-)

diff --git a/doc/guides/contributing/abi_policy.rst b/doc/guides/contributing/abi_policy.rst
index 1b2fa27865..d0affa9e60 100644
--- a/doc/guides/contributing/abi_policy.rst
+++ b/doc/guides/contributing/abi_policy.rst
@@ -27,7 +27,8 @@ General Guidelines
 #. The removal of symbols is considered an :ref:`ABI breakage <abi_breakages>`,
    once approved these will form part of the next ABI version.
 #. Libraries or APIs marked as :ref:`experimental <experimental_apis>` may
-   change without constraint, as they are not considered part of an ABI version.
+   be changed or removed without prior notice, as they are not considered part
+   of an ABI version.
 #. Updates to the :ref:`minimum hardware requirements <hw_rqmts>`, which drop
    support for hardware which was previously supported, should be treated as an
    ABI change.
@@ -294,7 +295,7 @@ APIs
 ~~~~
 
 APIs marked as ``experimental`` are not considered part of an ABI version and
-may change without warning at any time. Since changes to APIs are most likely
+may be changed or removed without prior notice. Since changes to APIs are most likely
 immediately after their introduction, as users begin to take advantage of those
 new APIs and start finding issues with them, new DPDK APIs will be automatically
 marked as ``experimental`` to allow for a period of stabilization before they
@@ -330,4 +331,5 @@ Libraries
 ~~~~~~~~~
 
 Libraries marked as ``experimental`` are entirely not considered part of an ABI
-version, and may change without warning at any time.
+version.
+All functions in such libraries may be changed or removed without prior notice.
diff --git a/lib/librte_bbdev/rte_bbdev.h b/lib/librte_bbdev/rte_bbdev.h
index ecd95a823d..57291373fa 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 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..e2d419b4ef 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 be changed or removed 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..2840c27c6c 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 be changed or removed 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..84ee774d2d 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 be changed or removed 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..bbfcf23a85 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 be changed or removed 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..82ea92b6a6 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 be changed or removed without prior notice.
  *
  * This library provides flow record information with some measured properties.
  *
diff --git a/lib/librte_graph/rte_graph.h b/lib/librte_graph/rte_graph.h
index 9a26ffc185..b32c4bc217 100644
--- a/lib/librte_graph/rte_graph.h
+++ b/lib/librte_graph/rte_graph.h
@@ -9,7 +9,8 @@
  * @file rte_graph.h
  *
  * @warning
- * @b EXPERIMENTAL: this API may change without prior notice
+ * @b EXPERIMENTAL:
+ * All functions in this file may be changed or removed without prior notice.
  *
  * Graph architecture abstracts the data processing functions as
  * "node" and "link" them together to create a complex "graph" to enable
diff --git a/lib/librte_graph/rte_graph_worker.h b/lib/librte_graph/rte_graph_worker.h
index 4c3ddcbdeb..eef77f732a 100644
--- a/lib/librte_graph/rte_graph_worker.h
+++ b/lib/librte_graph/rte_graph_worker.h
@@ -9,7 +9,8 @@
  * @file rte_graph_worker.h
  *
  * @warning
- * @b EXPERIMENTAL: this API may change without prior notice
+ * @b EXPERIMENTAL:
+ * All functions in this file may be changed or removed without prior notice.
  *
  * This API allows a worker thread to walk over a graph and nodes to create,
  * process, enqueue and move streams of objects to the next nodes.
diff --git a/lib/librte_ipsec/rte_ipsec.h b/lib/librte_ipsec/rte_ipsec.h
index 6666cf7619..de05f4e932 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 be changed or removed without prior notice.
+ *
  * librte_ipsec provides a framework for data-path IPsec protocol
  * processing (ESP/AH).
  */
diff --git a/lib/librte_node/rte_node_eth_api.h b/lib/librte_node/rte_node_eth_api.h
index e9a53afe5d..4e28f86d77 100644
--- a/lib/librte_node/rte_node_eth_api.h
+++ b/lib/librte_node/rte_node_eth_api.h
@@ -9,7 +9,8 @@
  * @file rte_node_eth_api.h
  *
  * @warning
- * @b EXPERIMENTAL: this API may change without prior notice
+ * @b EXPERIMENTAL:
+ * All functions in this file may be changed or removed without prior notice.
  *
  * This API allows to setup ethdev_rx and ethdev_tx nodes
  * and its queue associations.
diff --git a/lib/librte_node/rte_node_ip4_api.h b/lib/librte_node/rte_node_ip4_api.h
index 31a752b00b..eb9ebd5f89 100644
--- a/lib/librte_node/rte_node_ip4_api.h
+++ b/lib/librte_node/rte_node_ip4_api.h
@@ -9,7 +9,8 @@
  * @file rte_node_ip4_api.h
  *
  * @warning
- * @b EXPERIMENTAL: this API may change without prior notice
+ * @b EXPERIMENTAL:
+ * All functions in this file may be changed or removed without prior notice.
  *
  * This API allows to do control path functions of ip4_* nodes
  * like ip4_lookup, ip4_rewrite.
diff --git a/lib/librte_rcu/rte_rcu_qsbr.h b/lib/librte_rcu/rte_rcu_qsbr.h
index fd4eb52b7f..a98e8f0f82 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 be changed or removed 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..da558c417e 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 be changed or removed 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..4b284c913c 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 be changed or removed 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..abf6420766 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 be changed or removed 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 eb7f2c917c..d13010b8fb 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 be changed or removed 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


^ permalink raw reply	[flat|nested] 8+ messages in thread

end of thread, back to index

Thread overview: 8+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
     [not found] <20200522065855.31056-1-david.marchand@redhat.com>
2020-05-22  6:58 ` [dpdk-stable] [PATCH 3/3] lib: remind experimental status in library headers David Marchand
2020-05-22 14:15   ` Honnappa Nagarahalli
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

patches for DPDK stable branches

Archives are clonable:
	git clone --mirror http://inbox.dpdk.org/stable/0 stable/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 stable stable/ http://inbox.dpdk.org/stable \
		stable@dpdk.org
	public-inbox-index stable


Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.stable


AGPL code for this site: git clone https://public-inbox.org/ public-inbox