[dpdk-stable] patch 'lib: remind experimental status in headers' has been queued to LTS release 18.11.10

[Kevin Traynor <ktraynor@redhat.com>]

Hi,

FYI, your patch has been queued to LTS release 18.11.10

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 07/23/20. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Queued patches are on a temporary branch at:
https://github.com/kevintraynor/dpdk-stable-queue

This queued commit can be viewed at:
https://github.com/kevintraynor/dpdk-stable-queue/commit/876256d77a4adaa9199815faa85b655c2a660577

Thanks.

Kevin.

---
From 876256d77a4adaa9199815faa85b655c2a660577 Mon Sep 17 00:00:00 2001
From: David Marchand <david.marchand@redhat.com>
Date: Fri, 26 Jun 2020 10:16:38 +0200
Subject: [PATCH] lib: remind experimental status in headers

[ upstream commit 74f4d6424da1297bd6e83dcb7bd84444ca8c59dd ]

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

Signed-off-by: David Marchand <david.marchand@redhat.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
---
 lib/librte_bbdev/rte_bbdev.h                 | 3 ++-
 lib/librte_bpf/rte_bpf.h                     | 6 +++++-
 lib/librte_compressdev/rte_compressdev.h     | 6 +++++-
 lib/librte_flow_classify/rte_flow_classify.h | 6 ++++--
 lib/librte_telemetry/rte_telemetry.h         | 7 ++++++-
 5 files changed, 22 insertions(+), 6 deletions(-)

diff --git a/lib/librte_bbdev/rte_bbdev.h b/lib/librte_bbdev/rte_bbdev.h
index f53ee101da..105468d61a 100644
--- a/lib/librte_bbdev/rte_bbdev.h
+++ b/lib/librte_bbdev/rte_bbdev.h
@@ -12,5 +12,6 @@
  *
  * @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
diff --git a/lib/librte_bpf/rte_bpf.h b/lib/librte_bpf/rte_bpf.h
index c8b9601764..3d4e9b9f69 100644
--- a/lib/librte_bpf/rte_bpf.h
+++ b/lib/librte_bpf/rte_bpf.h
@@ -8,7 +8,11 @@
 /**
  * @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.
diff --git a/lib/librte_compressdev/rte_compressdev.h b/lib/librte_compressdev/rte_compressdev.h
index 7b68170a5f..ea19014874 100644
--- a/lib/librte_compressdev/rte_compressdev.h
+++ b/lib/librte_compressdev/rte_compressdev.h
@@ -9,5 +9,9 @@
  * @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_flow_classify/rte_flow_classify.h b/lib/librte_flow_classify/rte_flow_classify.h
index 01e88e543a..10b39ac7b1 100644
--- a/lib/librte_flow_classify/rte_flow_classify.h
+++ b/lib/librte_flow_classify/rte_flow_classify.h
@@ -9,7 +9,9 @@
  * @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_telemetry/rte_telemetry.h b/lib/librte_telemetry/rte_telemetry.h
index 119db16fee..41c211dea5 100644
--- a/lib/librte_telemetry/rte_telemetry.h
+++ b/lib/librte_telemetry/rte_telemetry.h
@@ -10,5 +10,10 @@
 /**
  * @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
-- 
2.21.3

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2020-07-17 17:17:01.224876080 +0100
+++ 0022-lib-remind-experimental-status-in-headers.patch	2020-07-17 17:17:00.000770996 +0100
@@ -1 +1 @@
-From 74f4d6424da1297bd6e83dcb7bd84444ca8c59dd Mon Sep 17 00:00:00 2001
+From 876256d77a4adaa9199815faa85b655c2a660577 Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit 74f4d6424da1297bd6e83dcb7bd84444ca8c59dd ]
+
@@ -26,2 +27,0 @@
-Cc: stable@dpdk.org
-
@@ -31,18 +31,6 @@
- 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(-)
+ lib/librte_bbdev/rte_bbdev.h                 | 3 ++-
+ lib/librte_bpf/rte_bpf.h                     | 6 +++++-
+ lib/librte_compressdev/rte_compressdev.h     | 6 +++++-
+ lib/librte_flow_classify/rte_flow_classify.h | 6 ++++--
+ lib/librte_telemetry/rte_telemetry.h         | 7 ++++++-
+ 5 files changed, 22 insertions(+), 6 deletions(-)
@@ -50,25 +37,0 @@
-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
-@@ -28,5 +28,6 @@ General Guidelines
-    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
-@@ -295,5 +296,5 @@ 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
-@@ -331,3 +332,4 @@ 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.
@@ -76 +39 @@
-index ecd95a823d..57291373fa 100644
+index f53ee101da..105468d61a 100644
@@ -88 +51 @@
-index cbf1cddaca..e2d419b4ef 100644
+index c8b9601764..3d4e9b9f69 100644
@@ -105 +68 @@
-index 8052efe675..2840c27c6c 100644
+index 7b68170a5f..ea19014874 100644
@@ -119,32 +81,0 @@
-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
-@@ -9,4 +9,11 @@
- /**
-  * @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
-@@ -9,4 +9,11 @@
- /**
-  * @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
@@ -152 +83 @@
-index 74d1ecaf50..82ea92b6a6 100644
+index 01e88e543a..10b39ac7b1 100644
@@ -167,130 +97,0 @@
-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
-@@ -10,5 +10,6 @@
-  *
-  * @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
-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
-@@ -10,5 +10,6 @@
-  *
-  * @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,
-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
-@@ -8,7 +8,11 @@
- /**
-  * @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
-@@ -10,5 +10,6 @@
-  *
-  * @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
-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
-@@ -10,5 +10,6 @@
-  *
-  * @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
-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
-@@ -8,5 +8,10 @@
- /**
-  * @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
-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
-@@ -9,4 +9,11 @@
- /**
-  * @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
-@@ -9,4 +9,11 @@
- /**
-  * @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
-@@ -5,7 +5,10 @@
- /**
-  * @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
@@ -298 +99 @@
-index eb7f2c917c..d13010b8fb 100644
+index 119db16fee..41c211dea5 100644
@@ -301,2 +102 @@
-@@ -21,9 +21,11 @@
- 
+@@ -10,5 +10,10 @@
@@ -304,3 +103,0 @@
-- * @warning
-- * @b EXPERIMENTAL: all functions in this file may change without prior notice
-- *