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

[Jani Nikula <jani.nikula@linux.intel.com>]

On Tue, 06 Sep 2022, Donald Hunter <donald.hunter@gmail.com> wrote:
> Jani Nikula <jani.nikula@linux.intel.com> writes:
>
>> On Mon, 29 Aug 2022, Donald Hunter <donald.hunter@gmail.com> wrote:
>>> Extend the libbpf documentation with a table of program types,
>>> attach points and ELF section names. This table uses data from
>>> program_types.csv which is generated from tools/lib/bpf/libbpf.c
>>> during the documentation build.
>>
>> Oh, would be nice to turn all of these into proper but simple Sphinx
>> extensions that take the deps into account in the Sphinx build
>> process. And, of course, would be pure python instead of a combo of
>> Make, shell, and awk.
>>
>> That's one of the reasons we chose Sphinx originally, to be able to
>> write Sphinx extensions and avoid complicated pipelines.
>
> I could look at this as a followup patch since I would need to learn how
> to write Sphinx extensions first. It seems that it will require a new
> reST directive, is that right?

Correct. It's not very complicated. The extension that handles
kernel-doc is under 200 lines, Documentation/sphinx/kerneldoc.py. And a
lot of that is just translating directive options to kernel-doc the perl
script options.

BR,
Jani.


-- 
Jani Nikula, Intel Open Source Graphics Center