Skip to contentSkip to conversation

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

PATCH Applied Donald Hunter 2 participants 2 messages Nov 21, 2022 – Nov 23, 2022

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

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

Extend the libbpf documentation with a table of program types, attach points and ELF section names.

---
This latest version of the patchset uses an inline table that is formatted by hand. The section name extras are documented in footnotes with cross references from within the table.

v5 -> v6:
- Mention non-negative offset for kprobe, suggested by David Vernet
- Include this version history that was missing in v5

v4 -> v5:
- Use inline grid table format and add footnotes for section name extras
- Drop the generator script and makefile changes from the patchset

v3 -> v4:
- Fix typo reported by Jesper Brouer
- Move the generator from the Makefile to a separate script

v2 -> v3:
- Put program_types after API docs in TOC as suggested by Andrii Nakryiko
- Fix formatting as reported by Andrii Nakryiko
- Include USDT extras example as suggested by Andrii Nakryiko
- Include sample of program_types.csv as suggested by Andrii Nakryiko

v1 -> v2:
- Automate the generation of program_types.csv as suggested by
- Andrii Nakryiko.

Documentation/bpf/libbpf/index.rst | 3 +

 Documentation/bpf/libbpf/program_types.rst | 203 +++++++++++++++++++++
 Documentation/bpf/programs.rst             |   3 +
 3 files changed, 209 insertions(+)
 create mode 100644 Documentation/bpf/libbpf/program_types.rst
Documentation/bpf/libbpf/index.rst +3 -0
index 3722537d1384..f9b3b252e28f 100644
@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause)
 
+.. _libbpf:
+
 libbpf
 ======
 
@@ -7,6 +9,7 @@ libbpf
    :maxdepth: 1
 
    API Documentation <https://libbpf.readthedocs.io/en/latest/api.html>
+   program_types
    libbpf_naming_convention
    libbpf_build
 
Documentation/bpf/libbpf/program_types.rst new file +203 -0

203 lines not on this page · raw message

Documentation/bpf/programs.rst +3 -0
index 620eb667ac7a..c99000ab6d9b 100644
@@ -7,3 +7,6 @@ Program Types
    :glob:
 
    prog_*
+
+For a list of all program types, see :ref:`program_types_and_elf` in
+the :ref:`libbpf` documentation.
Signature · 1 line
2.38.1
#1 lore raw
This patch was applied to bpf/bpf-next.git (master) by Andrii Nakryiko <[email protected]>:

Hello:

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

Quoted 8 lines · On Mon, 21 Nov 2022 12:17:34 +0000 you wrote:

Extend the libbpf documentation with a table of program types, attach points and ELF section names.

[...]

Here is the summary with links:
- [bpf-next,v6] docs/bpf: Add table of BPF program types to libbpf docs

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

You are awesome, thank you!

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