mbox series

[bpf-next,v2,0/2] Add table of BPF program types to docs

Message ID 20220824221018.24684-1-donald.hunter@gmail.com (mailing list archive)
Headers show
Series Add table of BPF program types to docs | expand

Message

Donald Hunter Aug. 24, 2022, 10:10 p.m. UTC
Extend the libbpf documentation with a table of program types, attach
points and ELF section names. The table uses data from program_types.csv
which is generated from tools/lib/bpf/libbpf.c during the documentation
build.

Patch 1 adds subdir support to Documentation/Makefile and changes
userspace-api/media to use this instead of being a special case.

Patch 2 adds the the program_types documentation with a new makefile in
the libbpf doc directory to generate program_types.csv

I plan to look at adding info about format of section "extras" as a
follow-on.

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


Donald Hunter (2):
  Add subdir support to Documentation makefile
  Add table of BPF program types to libbpf docs

 Documentation/Makefile                     | 16 ++++++++--
 Documentation/bpf/libbpf/Makefile          | 36 ++++++++++++++++++++++
 Documentation/bpf/libbpf/index.rst         |  3 ++
 Documentation/bpf/libbpf/program_types.rst | 18 +++++++++++
 Documentation/bpf/programs.rst             |  3 ++
 Documentation/userspace-api/media/Makefile |  2 ++
 6 files changed, 76 insertions(+), 2 deletions(-)
 create mode 100644 Documentation/bpf/libbpf/Makefile
 create mode 100644 Documentation/bpf/libbpf/program_types.rst