FM10K/dpdk-fm10k
FM10K/dpdk-fm10k
1
0
Fork 0
Code Issues Pull requests Releases Activity

lib: remind experimental status in headers

Browse source 
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>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
This commit is contained in:
David Marchand 2020-06-26 10:16:38 +02:00 committed by Thomas Monjalon
parent 1022ff0c33
commit 74f4d6424d
17 changed files with 79 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/guides/contributing/abi_policy.rst
View file

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

3
lib/librte_bbdev/rte_bbdev.h
View file

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

6
lib/librte_bpf/rte_bpf.h
View file

@ -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

6
lib/librte_compressdev/rte_compressdev.h
View file

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

7
lib/librte_fib/rte_fib.h
View file

@ -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
*/

7
lib/librte_fib/rte_fib6.h
View file

@ -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
*/

6
lib/librte_flow_classify/rte_flow_classify.h
View file

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

3
lib/librte_graph/rte_graph.h
View file

@ -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

3
lib/librte_graph/rte_graph_worker.h
View file

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

6
lib/librte_ipsec/rte_ipsec.h
View file

@ -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).
*/

3
lib/librte_node/rte_node_eth_api.h
View file

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

3
lib/librte_node/rte_node_ip4_api.h
View file

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

7
lib/librte_rcu/rte_rcu_qsbr.h
View file

@ -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

7
lib/librte_rib/rte_rib.h
View file

@ -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
*/

7
lib/librte_rib/rte_rib6.h
View file

@ -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
*/

7
lib/librte_stack/rte_stack.h
View file

@ -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,

10
lib/librte_telemetry/rte_telemetry.h
View file

@ -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