mirror of
https://github.com/torvalds/linux
synced 2024-07-22 03:01:14 +00:00
f42cfb469f
This patch is meant to start the initiative to document libbpf. It includes .rst files which are text documentation describing building, API naming convention, as well as an index to generated API documentation. In this approach the generated API documentation is enabled by the kernels existing kernel documentation system which uses sphinx. The resulting docs would then be synced to kernel.org/doc You can test this by running `make htmldocs` and serving the html in Documentation/output. Since libbpf does not yet have comments in kernel doc format, see kernel.org/doc/html/latest/doc-guide/kernel-doc.html for an example so you can test this. The advantage of this approach is to use the existing sphinx infrastructure that the kernel has, and have libbpf docs in the same place as everything else. The current plan is to have the libbpf mirror sync the generated docs and version them based on the libbpf releases which are cut on github. This patch includes the addition of libbpf_api.rst which pulls comment documentation from header files in libbpf under tools/lib/bpf/. The comment docs would be of the standard kernel doc format. Signed-off-by: Grant Seltzer <grantseltzer@gmail.com> Signed-off-by: Andrii Nakryiko <andrii@kernel.org> Signed-off-by: Daniel Borkmann <daniel@iogearbox.net> Link: https://lore.kernel.org/bpf/20210618140459.9887-2-grantseltzer@gmail.com
37 lines
1.1 KiB
ReStructuredText
37 lines
1.1 KiB
ReStructuredText
.. SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause)
|
|
|
|
Building libbpf
|
|
===============
|
|
|
|
libelf and zlib are internal dependencies of libbpf and thus are required to link
|
|
against and must be installed on the system for applications to work.
|
|
pkg-config is used by default to find libelf, and the program called
|
|
can be overridden with PKG_CONFIG.
|
|
|
|
If using pkg-config at build time is not desired, it can be disabled by
|
|
setting NO_PKG_CONFIG=1 when calling make.
|
|
|
|
To build both static libbpf.a and shared libbpf.so:
|
|
|
|
.. code-block:: bash
|
|
|
|
$ cd src
|
|
$ make
|
|
|
|
To build only static libbpf.a library in directory build/ and install them
|
|
together with libbpf headers in a staging directory root/:
|
|
|
|
.. code-block:: bash
|
|
|
|
$ cd src
|
|
$ mkdir build root
|
|
$ BUILD_STATIC_ONLY=y OBJDIR=build DESTDIR=root make install
|
|
|
|
To build both static libbpf.a and shared libbpf.so against a custom libelf
|
|
dependency installed in /build/root/ and install them together with libbpf
|
|
headers in a build directory /build/root/:
|
|
|
|
.. code-block:: bash
|
|
|
|
$ cd src
|
|
$ PKG_CONFIG_PATH=/build/root/lib64/pkgconfig DESTDIR=/build/root make |