Re: [PATCH bpf-next 0/3] Autogenerating API documentation

[Jonathan Corbet <corbet@lwn.net>]

Grant Seltzer Richman <grantseltzer@gmail.com> writes:

> Andrii cuts releases of libbpf using the github mirror at
> github.com/libbpf/libbpf. There's more context in the README there,
> but most of the major distributions package libbpf from this mirror.
> Since developers that use libbpf in their applications include libbpf
> based on these github releases instead of versions of Linux (i.e. I
> use libbpf 0.4, not libbpf from linux 5.14), it's important to have
> the API documentation be labeled by the github release versions. Is
> there any mechanism in the kernel docs that would allow us to do that?
> Would it make more sense for the libbpf community to maintain their
> own documentation system/website for this purpose?

It depends on how you want that labeling to look, I guess.  One simple
thing might be to put a DOC: block into the libbpf code that holds the
version number, then use a kernel-doc directive to pull it in in the
appropriate place.  Alternatives might include adding a bit of magic to
Documentation/conf.py to fetch a "#define VERSION# out of the source
somewhere and stash the information away.

If you're wanting to replace the version code that appears at the top of
the left column in the HTML output, though, it's going to be a bit
harder.  I don't doubt we can do it, but it may require messing around
with template files and such.

Thanks,

jon