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

[Donald Hunter <donald.hunter@gmail.com>]

Andrii Nakryiko <andrii.nakryiko@gmail.com> writes:

> On Tue, Aug 23, 2022 at 9:56 AM Donald Hunter <donald.hunter@gmail.com> wrote:
>>
>> Extend the BPF program types documentation with a table of
>> program types, attach points and ELF section names.
>>
>> The program_types.csv file is generated from tools/lib/bpf/libbpf.c
>> and a script is included for regenerating the .csv file.
>>
>> I have not integrated the script into the doc build but if that
>> is desirable then please suggest the preferred way to do so.
>>
>> Signed-off-by: Donald Hunter <donald.hunter@gmail.com>
>> ---
>
> It does seem cleaner to generate this .csv during docs build, instead
> of having to manually regenerate it all the time? Should we also put
> it under Documentation/bpf/libbpf/ as it's libbpf-specific? Having it
> under libbpf subdir would also make it simpler to expose it in libbpf
> docs at libbpf.readthedocs.io/

Agreed about generating the .csv as part of the doc build. I will look
at adding it to the docs Makefile.

I'm happy to put it in Documentation/bpf/libbpf and link to it from
Documentation/bpf/programs.rst.

> We can probably also establish some special comment format next to
> SEC_DEF() to specify the format of those "extras", I think it would be
> useful for users. WDYT?

Yes this would be a useful addition. Are the extras always for
auto-attach? If so, then I can add that to the rules.

I'd prefer to modify the existing ELF section name column to replace '+'
with extras since the table is already wide.

> CC'ing Grant as well, who worked on building libbpf docs.