linux-kernel - Re: [PATCH bpf-next] bpf, docs: Remove deprecated xsk libbpf APIs description

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <EC892D6C-2638-4C13-A725-536428582D63@fb.com>
Date:   Fri, 8 Jul 2022 05:02:07 +0000
From:   Song Liu <songliubraving@...com>
To:     Pu Lehui <pulehui@...wei.com>
CC:     bpf <bpf@...r.kernel.org>, Networking <netdev@...r.kernel.org>,
        lkml <linux-kernel@...r.kernel.org>,
        "linux-doc@...r.kernel.org" <linux-doc@...r.kernel.org>,
        Alexei Starovoitov <ast@...nel.org>,
        Daniel Borkmann <daniel@...earbox.net>,
        Andrii Nakryiko <andrii@...nel.org>,
        Jonathan Corbet <corbet@....net>, Martin Lau <kafai@...com>,
        Yonghong Song <yhs@...com>,
        John Fastabend <john.fastabend@...il.com>,
        KP Singh <kpsingh@...nel.org>,
        Grant Seltzer <grantseltzer@...il.com>,
        Randy Dunlap <rdunlap@...radead.org>
Subject: Re: [PATCH bpf-next] bpf, docs: Remove deprecated xsk libbpf APIs
 description



> On Jul 7, 2022, at 9:27 PM, Pu Lehui <pulehui@...wei.com> wrote:
> 
> Since xsk APIs has been removed from libbpf, let's clean
> up the bpf docs simutaneously.
> 
> Signed-off-by: Pu Lehui <pulehui@...wei.com>

Acked-by: Song Liu <song@...nel.org>

> ---
> .../bpf/libbpf/libbpf_naming_convention.rst         | 13 ++-----------
> 1 file 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
> ---
> 
> -- 
> 2.25.1
>