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

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

Bagas Sanjaya <bagasdotme@gmail.com> writes:

> On Thu, Sep 22, 2022 at 12:52:57PM +0100, Donald Hunter wrote:
>> +..
>> +  program_types.csv is generated from tools/lib/bpf/libbpf.c and is formatted like this:
>> +    Program Type,Attach Type,ELF Section Name,Sleepable
>> +    ``BPF_PROG_TYPE_SOCKET_FILTER``,,``socket``,
>> +    ``BPF_PROG_TYPE_SK_REUSEPORT``,``BPF_SK_REUSEPORT_SELECT_OR_MIGRATE``,``sk_reuseport/migrate``,
>> +    ``BPF_PROG_TYPE_SK_REUSEPORT``,``BPF_SK_REUSEPORT_SELECT``,``sk_reuseport``,
>> +    ``BPF_PROG_TYPE_KPROBE``,,``kprobe+``,
>> +    ``BPF_PROG_TYPE_KPROBE``,,``uprobe+``,
>> +    ``BPF_PROG_TYPE_KPROBE``,,``uprobe.s+``,Yes
>
> The note above doesn't get rendered on htmldocs output, so I have applied
> the fixup:

It was intended to be a comment to the reader of program_types.rst that
this is the format of the .csv file that will be rendered. It was not
meant to be a note on the rendered page.

The rendered page will show the table that is produced by the csv-table
directive which is self explanatory.

>
> ---- >8 ----
>
> diff --git a/Documentation/bpf/libbpf/program_types.rst b/Documentation/bpf/libbpf/program_types.rst
> index b74fbf3363dd6c..3ce0ec94b399b4 100644
> --- a/Documentation/bpf/libbpf/program_types.rst
> +++ b/Documentation/bpf/libbpf/program_types.rst
> @@ -16,15 +16,17 @@ When ``extras`` are specified, they provide details of how to auto-attach the BP
>  The format of ``extras`` depends on the program type, e.g. ``SEC("tracepoint/<category>/<name>")``
>  for tracepoints or ``SEC("usdt/<path-to-binary>:<usdt_provider>:<usdt_name>")`` for USDT probes.
>  
> -..
> -  program_types.csv is generated from tools/lib/bpf/libbpf.c and is formatted like this:
> -    Program Type,Attach Type,ELF Section Name,Sleepable
> -    ``BPF_PROG_TYPE_SOCKET_FILTER``,,``socket``,
> -    ``BPF_PROG_TYPE_SK_REUSEPORT``,``BPF_SK_REUSEPORT_SELECT_OR_MIGRATE``,``sk_reuseport/migrate``,
> -    ``BPF_PROG_TYPE_SK_REUSEPORT``,``BPF_SK_REUSEPORT_SELECT``,``sk_reuseport``,
> -    ``BPF_PROG_TYPE_KPROBE``,,``kprobe+``,
> -    ``BPF_PROG_TYPE_KPROBE``,,``uprobe+``,
> -    ``BPF_PROG_TYPE_KPROBE``,,``uprobe.s+``,Yes
> +.. note::
> +   The table below is generated from ``tools/lib/bpf/libbpf.c`` and is
> +   formatted like this (in CSV format)::
> +
> +     Program Type,Attach Type,ELF Section Name,Sleepable
> +     BPF_PROG_TYPE_SOCKET_FILTER,,socket,
> +     BPF_PROG_TYPE_SK_REUSEPORT,BPF_SK_REUSEPORT_SELECT_OR_MIGRATE,sk_reuseport/migrate,
> +     BPF_PROG_TYPE_SK_REUSEPORT,BPF_SK_REUSEPORT_SELECT,sk_reuseport,
> +     BPF_PROG_TYPE_KPROBE,,kprobe+,
> +     BPF_PROG_TYPE_KPROBE,,uprobe+,
> +     BPF_PROG_TYPE_KPROBE,,uprobe.s+,Yes
>  
>  .. csv-table:: Program Types and Their ELF Section Names
>     :file: program_types.csv
>  
> Thanks.