Commit d20b4111 authored by Grant Seltzer's avatar Grant Seltzer Committed by Andrii Nakryiko

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: default avatarGrant Seltzer <grantseltzer@gmail.com>
Signed-off-by: default avatarAndrii Nakryiko <andrii@kernel.org>
Link: https://lore.kernel.org/bpf/20210818151313.49992-1-grantseltzer@gmail.com
parent 8cacfc85
...@@ -3,6 +3,14 @@ ...@@ -3,6 +3,14 @@
libbpf 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 This is documentation for libbpf, a userspace library for loading and
interacting with bpf programs. interacting with bpf programs.
......
...@@ -69,7 +69,7 @@ functions. These can be mixed and matched. Note that these functions ...@@ -69,7 +69,7 @@ functions. These can be mixed and matched. Note that these functions
are not reentrant for performance reasons. are not reentrant for performance reasons.
ABI ABI
========== ---
libbpf can be both linked statically or used as DSO. To avoid possible libbpf can be both linked statically or used as DSO. To avoid possible
conflicts with other libraries an application is linked with, all conflicts with other libraries an application is linked with, all
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment