Skip to contentSkip to conversation

bpf, docs: Remove deprecated xsk libbpf APIs description

PATCH Applied Pu Lehui 3 participants 3 messages Jul 8, 2022

Subsystems (4)
lore
Share & tools
lore

Pu Lehui

author
#0 lore raw

PATCH 1/1 bpf, docs: Remove deprecated xsk libbpf APIs description

Since xsk APIs has been removed from libbpf, let's clean up the bpf docs simutaneously.

---
 .../bpf/libbpf/libbpf_naming_convention.rst         | 13 ++-----------
 1 file changed, 2 insertions(+), 11 deletions(-)
Documentation/bpf/libbpf/libbpf_naming_convention.rst +2 -11
index f86360f734a8..c5ac97f3d4c4 100644
@@ -9,8 +9,8 @@ described here. It's recommended to follow these conventions whenever a
 new function or type is added to keep libbpf API clean and consistent.
 
 All types and functions provided by libbpf API should have one of the
-following prefixes: ``bpf_``, ``btf_``, ``libbpf_``, ``xsk_``,
-``btf_dump_``, ``ring_buffer_``, ``perf_buffer_``.
+following prefixes: ``bpf_``, ``btf_``, ``libbpf_``, ``btf_dump_``,
+``ring_buffer_``, ``perf_buffer_``.
 
 System call wrappers
 --------------------
@@ -59,15 +59,6 @@ Auxiliary functions and types that don't fit well in any of categories
 described above should have ``libbpf_`` prefix, e.g.
 ``libbpf_get_error`` or ``libbpf_prog_type_by_name``.
 
-AF_XDP functions
--------------------
-
-AF_XDP functions should have an ``xsk_`` prefix, e.g.
-``xsk_umem__get_data`` or ``xsk_umem__create``. The interface consists
-of both low-level ring access functions and high-level configuration
-functions. These can be mixed and matched. Note that these functions
-are not reentrant for performance reasons.
-
 ABI
 ---
 
Signature · 1 line
2.25.1
Acked-by on v1 1/1
#1 lore raw
Quoted 8 lines · Pu Lehui

Since xsk APIs has been removed from libbpf, let's clean up the bpf docs simutaneously.

Quoted 38 lines

---
.../bpf/libbpf/libbpf_naming_convention.rst | 13 ++-----------

1 file changed, 2 insertions(+), 11 deletions(-)
Documentation/bpf/libbpf/libbpf_naming_convention.rst +0 -0
index f86360f734a8..c5ac97f3d4c4 100644
@@ -9,8 +9,8 @@ described here. It's recommended to follow these conventions whenever a

new function or type is added to keep libbpf API clean and consistent.

All types and functions provided by libbpf API should have one of the

Documentation/bpf/libbpf/libbpf_naming_convention.rst +2 -2
-following prefixes: ``bpf_``, ``btf_``, ``libbpf_``, ``xsk_``,
-``btf_dump_``, ``ring_buffer_``, ``perf_buffer_``.
+following prefixes: ``bpf_``, ``btf_``, ``libbpf_``, ``btf_dump_``,
+``ring_buffer_``, ``perf_buffer_``.

System call wrappers
--------------------

Documentation/bpf/libbpf/libbpf_naming_convention.rst +0 -0
@@ -59,15 +59,6 @@ Auxiliary functions and types that don't fit well in any of categories

described above should have ``libbpf_`` prefix, e.g. ``libbpf_get_error`` or ``libbpf_prog_type_by_name``.

Documentation/bpf/libbpf/libbpf_naming_convention.rst +0 -9
-AF_XDP functions
--------------------
-
-AF_XDP functions should have an ``xsk_`` prefix, e.g.
-``xsk_umem__get_data`` or ``xsk_umem__create``. The interface consists
-of both low-level ring access functions and high-level configuration
-functions. These can be mixed and matched. Note that these functions
-are not reentrant for performance reasons.
-

ABI
---

Signature · 1 line
2.25.1
#2 lore raw
In reply to Pu Lehui
This patch was applied to bpf/bpf-next.git (master) by Daniel Borkmann <[email protected]>:

Hello:

This patch was applied to bpf/bpf-next.git (master) by Daniel Borkmann <[email protected]>:

Quoted 7 lines · On Fri, 8 Jul 2022 12:27:36 +0800 you wrote:

Since xsk APIs has been removed from libbpf, let's clean up the bpf docs simutaneously.

---
 .../bpf/libbpf/libbpf_naming_convention.rst         | 13 ++-----------
 1 file changed, 2 insertions(+), 11 deletions(-)

Here is the summary with links:
- [bpf-next] bpf, docs: Remove deprecated xsk libbpf APIs description

    https://git.kernel.org/bpf/bpf-next/c/fb8ddf24c71d

You are awesome, thank you!

Signature · 2 lines
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html