Re: [PATCH bpf-next v3 0/2] Add table of BPF program types to docs

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Mon, Aug 29, 2022 at 2:15 AM Donald Hunter <donald.hunter@xxxxxxxxx> wrote:
>
> 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 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 the format of section "extras" for
> each program type as a follow-on.
>
> 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.
>
> 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          | 49 ++++++++++++++++++++++
>  Documentation/bpf/libbpf/index.rst         |  3 ++
>  Documentation/bpf/libbpf/program_types.rst | 32 ++++++++++++++
>  Documentation/bpf/programs.rst             |  3 ++
>  Documentation/userspace-api/media/Makefile |  2 +
>  6 files changed, 103 insertions(+), 2 deletions(-)
>  create mode 100644 Documentation/bpf/libbpf/Makefile
>  create mode 100644 Documentation/bpf/libbpf/program_types.rst
>
> --
> 2.35.1
>

This is marked as Changes Requested, so I presume there are some
fixes/updates pending on top of v3? BPF CI should probably be done as
a follow up, though.

But otherwise looks good to me and I appreciate the effort to improve
libbpf's documentations.

Acked-by: Andrii Nakryiko <andrii@xxxxxxxxxx>



[Index of Archives]     [Linux Samsung SoC]     [Linux Rockchip SoC]     [Linux Actions SoC]     [Linux for Synopsys ARC Processors]     [Linux NFS]     [Linux NILFS]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]


  Powered by Linux