]> git.baikalelectronics.ru Git - kernel.git/commit
bpf: Reconfigure libbpf docs to remove unversioned API
authorgrantseltzer <grantseltzer@gmail.com>
Tue, 10 Aug 2021 02:05:08 +0000 (22:05 -0400)
committerAndrii Nakryiko <andrii@kernel.org>
Tue, 17 Aug 2021 00:25:03 +0000 (17:25 -0700)
commitfcc3fec13cfc603aa7c9fec64210cd1437b8373e
treecc54c0df68cd916c5f842d3f2004f1de7afa60ff
parentd9fc53e0ac2fa79bdb7d9164bbc0aaedff18d94c
bpf: Reconfigure libbpf docs to remove unversioned API

This removes the libbpf_api.rst file from the kernel documentation.
The intention for this file was to pull documentation from comments
above API functions in libbpf. However, due to limitations of the
kernel documentation system, this API documentation could not be
versioned, which is counterintuative to how users expect to use it.
There is also currently no doc comments, making this a blank page.

Once the kernel comment documentation is actually contributed, it
will still exist in the kernel repository, just in the code itself.

A seperate site is being spun up to generate documentaiton from those
comments in a way in which it can be versioned properly.

This also reconfigures the bpf documentation index page to make it
easier to sync to the previously mentioned documentaiton site.

Signed-off-by: Grant Seltzer <grantseltzer@gmail.com>
Signed-off-by: Andrii Nakryiko <andrii@kernel.org>
Link: https://lore.kernel.org/bpf/20210810020508.280639-1-grantseltzer@gmail.com
Documentation/bpf/index.rst
Documentation/bpf/libbpf/libbpf_api.rst [deleted file]