kernel/linux.git/Documentation/bpf/libbpf, branch v6.18.21

docs/bpf: Add missing BPF program types to docs

2024-09-12T17:56:41+00:00

Update the table of program types in the libbpf documentation with the recently added program types. Signed-off-by: Donald Hunter Signed-off-by: Andrii Nakryiko Link: https://lore.kernel.org/bpf/20240912095944.6386-1-donald.hunter@gmail.com

libbpf: Configure log verbosity with env variable

2024-05-28T23:25:06+00:00

Configure logging verbosity by setting LIBBPF_LOG_LEVEL environment variable, which is applied only to default logger. Once user set their custom logging callback, it is up to them to handle filtering. Signed-off-by: Mykyta Yatsenko Signed-off-by: Andrii Nakryiko Link: https://lore.kernel.org/bpf/20240524131840.114289-1-yatsenko@meta.com

documentation/bpf: Document cgroup unix socket address hooks

2023-10-12T00:27:55+00:00

Update the documentation to mention the new cgroup unix sockaddr hooks. Signed-off-by: Daan De Meyer Link: https://lore.kernel.org/r/20231011185113.140426-8-daan.j.demeyer@gmail.com Signed-off-by: Martin KaFai Lau

bpf, docs: Libbpf overview documentation

2023-03-18T17:17:39+00:00

This patch documents overview of libbpf, including its features for developing BPF programs. Signed-off-by: Sreevani Sreejith Signed-off-by: Andrii Nakryiko Acked-by: David Vernet Link: https://lore.kernel.org/bpf/20230315195405.2051559-1-ssreevani@meta.com

Documentation: bpf: correct spelling

2023-01-28T20:22:20+00:00

Correct spelling problems for Documentation/bpf/ as reported by codespell. Signed-off-by: Randy Dunlap Cc: Andrii Nakryiko Cc: Alexei Starovoitov Cc: Daniel Borkmann Cc: bpf@vger.kernel.org Cc: Jonathan Corbet Cc: linux-doc@vger.kernel.org Reviewed-by: Bagas Sanjaya Link: https://lore.kernel.org/r/20230128195046.13327-1-rdunlap@infradead.org Signed-off-by: Alexei Starovoitov

docs/bpf: Add table of BPF program types to libbpf docs

2022-11-23T21:31:20+00:00

Extend the libbpf documentation with a table of program types, attach points and ELF section names. Signed-off-by: Donald Hunter Signed-off-by: Andrii Nakryiko Reviewed-by: Bagas Sanjaya Acked-by: David Vernet Link: https://lore.kernel.org/bpf/20221121121734.98329-1-donald.hunter@gmail.com

bpf, docs: Remove deprecated xsk libbpf APIs description

2022-07-08T12:18:50+00:00

Since xsk APIs has been removed from libbpf, let's clean up the BPF docs simutaneously. Signed-off-by: Pu Lehui Signed-off-by: Daniel Borkmann Acked-by: Song Liu Link: https://lore.kernel.org/bpf/20220708042736.669132-1-pulehui@huawei.com

libbpf: Improve libbpf API documentation link position

2022-04-22T14:21:56+00:00

This puts the link for libbpf API documentation into the sidebar for much easier navigation. You can preview this change at: https://libbpf-test.readthedocs.io/en/latest/ Note that the link is hardcoded to the production version, so you can see that it self references itself here for now: https://libbpf-test.readthedocs.io/en/latest/api.html This will need to make its way into the libbpf mirror, before being deployed to libbpf.readthedocs.org Signed-off-by: Grant Seltzer Signed-off-by: Daniel Borkmann Link: https://lore.kernel.org/bpf/20220422031050.303984-1-grantseltzer@gmail.com

bpf, docs: Fix ordering of bpf documentation

2021-11-17T22:24:01+00:00

This commit fixes the display of the BPF documentation in the sidebar when rendered as HTML. Before this patch, the sidebar would render as follows for some sections: | BPF Documentation |- BPF Type Format (BTF) |- BPF Type Format (BTF) This was due to creating a heading in index.rst followed by a sphinx toctree, where the file referenced carries the same title as the section heading. To fix this I applied a pattern that has been established in other subfolders of Documentation: 1. Re-wrote index.rst to have a single toctree 2. Split the sections out in to their own files Additionally maps.rst and programs.rst make use of a glob pattern to include map_* or prog_* rst files in their toctree, meaning future map or program type documentation will be automatically included. Signed-off-by: Dave Tucker Signed-off-by: Daniel Borkmann Link: https://lore.kernel.org/bpf/1a1eed800e7b9dc13b458de113a489641519b0cc.1636749493.git.dave@dtucker.co.uk

libbpf: Add API documentation convention guidelines

2021-10-06T19:34:02+00:00

This adds a section to the documentation for libbpf naming convention which describes how to document API features in libbpf, specifically the format of which API doc comments need to conform to. Signed-off-by: Grant Seltzer Signed-off-by: Andrii Nakryiko Acked-by: Song Liu Link: https://lore.kernel.org/bpf/20211004215644.497327-1-grantseltzer@gmail.com