diff options
| author | Grant Seltzer <grantseltzer@gmail.com> | 2021-08-18 18:13:13 +0300 |
|---|---|---|
| committer | Andrii Nakryiko <andrii@kernel.org> | 2021-08-18 18:45:25 +0300 |
| commit | d20b41115ad53293201cc07ee429a38740cb056b (patch) | |
| tree | 85af38b7e5e4ced66a3b4bf0ed8f418e311ec6fe /Documentation/bpf | |
| parent | 8cacfc85b615cc0bae01241593c4b25da6570efc (diff) | |
| download | linux-d20b41115ad53293201cc07ee429a38740cb056b.tar.xz | |
libbpf: Rename libbpf documentation index file
This patch renames a documentation libbpf.rst to index.rst. In order
for readthedocs.org to pick this file up and properly build the
documentation site.
It also changes the title type of the ABI subsection in the
naming convention doc. This is so that readthedocs.org doesn't treat this
section as a separate document.
Signed-off-by: Grant Seltzer <grantseltzer@gmail.com>
Signed-off-by: Andrii Nakryiko <andrii@kernel.org>
Link: https://lore.kernel.org/bpf/20210818151313.49992-1-grantseltzer@gmail.com
Diffstat (limited to 'Documentation/bpf')
| -rw-r--r-- | Documentation/bpf/libbpf/index.rst (renamed from Documentation/bpf/libbpf/libbpf.rst) | 8 | ||||
| -rw-r--r-- | Documentation/bpf/libbpf/libbpf_naming_convention.rst | 2 |
2 files changed, 9 insertions, 1 deletions
diff --git a/Documentation/bpf/libbpf/libbpf.rst b/Documentation/bpf/libbpf/index.rst index 1b1e61d5ead1..4f8adfc3ab83 100644 --- a/Documentation/bpf/libbpf/libbpf.rst +++ b/Documentation/bpf/libbpf/index.rst @@ -3,6 +3,14 @@ libbpf ====== +For API documentation see the `versioned API documentation site <https://libbpf.readthedocs.io/en/latest/api.html>`_. + +.. toctree:: + :maxdepth: 1 + + libbpf_naming_convention + libbpf_build + This is documentation for libbpf, a userspace library for loading and interacting with bpf programs. diff --git a/Documentation/bpf/libbpf/libbpf_naming_convention.rst b/Documentation/bpf/libbpf/libbpf_naming_convention.rst index 6bf9c5ac7576..9c68d5014ff1 100644 --- a/Documentation/bpf/libbpf/libbpf_naming_convention.rst +++ b/Documentation/bpf/libbpf/libbpf_naming_convention.rst @@ -69,7 +69,7 @@ functions. These can be mixed and matched. Note that these functions are not reentrant for performance reasons. ABI -========== +--- libbpf can be both linked statically or used as DSO. To avoid possible conflicts with other libraries an application is linked with, all |