From d20b41115ad53293201cc07ee429a38740cb056b Mon Sep 17 00:00:00 2001 From: Grant Seltzer Date: Wed, 18 Aug 2021 11:13:13 -0400 Subject: 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 --- Documentation/bpf/libbpf/index.rst | 22 ++++++++++++++++++++++ Documentation/bpf/libbpf/libbpf.rst | 14 -------------- .../bpf/libbpf/libbpf_naming_convention.rst | 2 +- 3 files changed, 23 insertions(+), 15 deletions(-) create mode 100644 Documentation/bpf/libbpf/index.rst delete mode 100644 Documentation/bpf/libbpf/libbpf.rst diff --git a/Documentation/bpf/libbpf/index.rst b/Documentation/bpf/libbpf/index.rst new file mode 100644 index 000000000000..4f8adfc3ab83 --- /dev/null +++ b/Documentation/bpf/libbpf/index.rst @@ -0,0 +1,22 @@ +.. SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) + +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. + +All general BPF questions, including kernel functionality, libbpf APIs and +their application, should be sent to bpf@vger.kernel.org mailing list. +You can `subscribe `_ to the +mailing list search its `archive `_. +Please search the archive before asking new questions. It very well might +be that this was already addressed or answered before. diff --git a/Documentation/bpf/libbpf/libbpf.rst b/Documentation/bpf/libbpf/libbpf.rst deleted file mode 100644 index 1b1e61d5ead1..000000000000 --- a/Documentation/bpf/libbpf/libbpf.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) - -libbpf -====== - -This is documentation for libbpf, a userspace library for loading and -interacting with bpf programs. - -All general BPF questions, including kernel functionality, libbpf APIs and -their application, should be sent to bpf@vger.kernel.org mailing list. -You can `subscribe `_ to the -mailing list search its `archive `_. -Please search the archive before asking new questions. It very well might -be that this was already addressed or answered before. 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 -- cgit v1.2.3