summaryrefslogtreecommitdiff
path: root/Documentation/bpf/libbpf
diff options
context:
space:
mode:
authorPu Lehui <pulehui@huawei.com>2022-07-08 07:27:36 +0300
committerDaniel Borkmann <daniel@iogearbox.net>2022-07-08 15:18:50 +0300
commitfb8ddf24c71dc97d6b07ecb7791b4fa5e7f48efc (patch)
tree5ffe644367dd2b234b28a11a839953b24a32c548 /Documentation/bpf/libbpf
parent2b4b2621fd6401865b31b9f403e4b936b7439e94 (diff)
downloadlinux-fb8ddf24c71dc97d6b07ecb7791b4fa5e7f48efc.tar.xz
bpf, docs: Remove deprecated xsk libbpf APIs description
Since xsk APIs has been removed from libbpf, let's clean up the BPF docs simutaneously. Signed-off-by: Pu Lehui <pulehui@huawei.com> Signed-off-by: Daniel Borkmann <daniel@iogearbox.net> Acked-by: Song Liu <song@kernel.org> Link: https://lore.kernel.org/bpf/20220708042736.669132-1-pulehui@huawei.com
Diffstat (limited to 'Documentation/bpf/libbpf')
-rw-r--r--Documentation/bpf/libbpf/libbpf_naming_convention.rst13
1 files changed, 2 insertions, 11 deletions
diff --git a/Documentation/bpf/libbpf/libbpf_naming_convention.rst b/Documentation/bpf/libbpf/libbpf_naming_convention.rst
index f86360f734a8..c5ac97f3d4c4 100644
--- a/Documentation/bpf/libbpf/libbpf_naming_convention.rst
+++ b/Documentation/bpf/libbpf/libbpf_naming_convention.rst
@@ -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
---