kernel/git/stable/linux-stable.git/Documentation/bpf/libbpf/index.rst, branch master

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

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

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: Rename libbpf documentation index file

2021-08-18T15:45:25+00:00

This patch renames a documentation libbpf.rst to index.rst. In order for readthedocs.org to pick this file up and properly build the documentation site. It also changes the title type of the ABI subsection in the naming convention doc. This is so that readthedocs.org doesn't treat this section as a separate document. Signed-off-by: Grant Seltzer Signed-off-by: Andrii Nakryiko Link: https://lore.kernel.org/bpf/20210818151313.49992-1-grantseltzer@gmail.com