diff mbox series

[ovs-dev] docs: Note ALLOW_EXPERIMENTAL_API for tunnel offloads

Message ID 20220417084309.1731075-1-elibr@nvidia.com
State Accepted
Commit 6882c45d4300e1b69101444d5de6cc60bb696906
Headers show
Series [ovs-dev] docs: Note ALLOW_EXPERIMENTAL_API for tunnel offloads | expand

Checks

Context Check Description
ovsrobot/apply-robot success apply and check: success
ovsrobot/intel-ovs-compilation success test: success
ovsrobot/github-robot-_Build_and_Test success github build: passed

Commit Message

Eli Britstein April 17, 2022, 8:43 a.m. UTC
Tunnel offload APIs have '__rte_experimental' attribute, therefore
available only if ALLOW_EXPERIMENTAL_API is defined. Documente it.

Signed-off-by: Eli Britstein <elibr@nvidia.com>
---
 Documentation/howto/dpdk.rst | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Ilya Maximets May 4, 2022, 9:29 p.m. UTC | #1
On 4/17/22 10:43, Eli Britstein wrote:
> Tunnel offload APIs have '__rte_experimental' attribute, therefore
> available only if ALLOW_EXPERIMENTAL_API is defined. Documente it.
> 
> Signed-off-by: Eli Britstein <elibr@nvidia.com>
> ---
>  Documentation/howto/dpdk.rst | 4 ++++
>  1 file changed, 4 insertions(+)

Applied.  Thanks!

Best regards, Ilya Maximets.
diff mbox series

Patch

diff --git a/Documentation/howto/dpdk.rst b/Documentation/howto/dpdk.rst
index 81f236d3b..04609b20b 100644
--- a/Documentation/howto/dpdk.rst
+++ b/Documentation/howto/dpdk.rst
@@ -402,6 +402,10 @@  Supported actions for hardware offload are:
 - Clone/output (tnl_push and output) for encapsulating over a tunnel.
 - Tunnel pop, for packets received on physical ports.
 
+.. note::
+  Tunnel offloads are experimental APIs in DPDK. In order to enable it,
+  compile with -DALLOW_EXPERIMENTAL_API.
+
 Multiprocess
 ------------