From d0c398be4f08645b4f2b5d99f7531c9000841250 Mon Sep 17 00:00:00 2001 From: Grant Seltzer Date: Wed, 18 Aug 2021 11:13:13 -0400 Subject: [PATCH] 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 Signed-off-by: Andrii Nakryiko Link: https://lore.kernel.org/bpf/20210818151313.49992-1-grantseltzer@gmail.com --- docs/{libbpf.rst => index.rst} | 8 ++++++++ docs/libbpf_naming_convention.rst | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) rename docs/{libbpf.rst => index.rst} (75%) diff --git a/docs/libbpf.rst b/docs/index.rst similarity index 75% rename from docs/libbpf.rst rename to docs/index.rst index 1b1e61d..4f8adfc 100644 --- a/docs/libbpf.rst +++ b/docs/index.rst @@ -3,6 +3,14 @@ libbpf ====== +For API documentation see the `versioned API documentation site `_. + +.. 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/docs/libbpf_naming_convention.rst b/docs/libbpf_naming_convention.rst index 6bf9c5a..9c68d50 100644 --- a/docs/libbpf_naming_convention.rst +++ b/docs/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