Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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

authored by

grantseltzer and committed by
Andrii Nakryiko
bb571649 3a4ce01b

+1 -36
+1 -9
Documentation/bpf/index.rst
··· 15 15 libbpf 16 16 ====== 17 17 18 - Libbpf is a userspace library for loading and interacting with bpf programs. 19 - 20 - .. toctree:: 21 - :maxdepth: 1 22 - 23 - libbpf/libbpf 24 - libbpf/libbpf_api 25 - libbpf/libbpf_build 26 - libbpf/libbpf_naming_convention 18 + Documentation/bpf/libbpf/libbpf.rst is a userspace library for loading and interacting with bpf programs. 27 19 28 20 BPF Type Format (BTF) 29 21 =====================
-27
Documentation/bpf/libbpf/libbpf_api.rst
··· 1 - .. SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) 2 - 3 - API 4 - === 5 - 6 - This documentation is autogenerated from header files in libbpf, tools/lib/bpf 7 - 8 - .. kernel-doc:: tools/lib/bpf/libbpf.h 9 - :internal: 10 - 11 - .. kernel-doc:: tools/lib/bpf/bpf.h 12 - :internal: 13 - 14 - .. kernel-doc:: tools/lib/bpf/btf.h 15 - :internal: 16 - 17 - .. kernel-doc:: tools/lib/bpf/xsk.h 18 - :internal: 19 - 20 - .. kernel-doc:: tools/lib/bpf/bpf_tracing.h 21 - :internal: 22 - 23 - .. kernel-doc:: tools/lib/bpf/bpf_core_read.h 24 - :internal: 25 - 26 - .. kernel-doc:: tools/lib/bpf/bpf_endian.h 27 - :internal: