Skip to contentSkip to conversation

bpf: Reconfigure libbpf docs to remove unversioned API

PATCH Applied grantseltzer 2 participants 3 messages Aug 10, 2021 – Aug 17, 2021

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 bpf: Reconfigure libbpf docs to remove unversioned API

This removes the libbpf_api.rst file from the kernel documentation. The intention for this file was to pull documentation from comments above API functions in libbpf. However, due to limitations of the kernel documentation system, this API documentation could not be versioned, which is counterintuative to how users expect to use it. There is also currently no doc comments, making this a blank page.

Once the kernel comment documentation is actually contributed, it will still exist in the kernel repository, just in the code itself.

A seperate site is being spun up to generate documentaiton from those comments in a way in which it can be versioned properly.

This also reconfigures the bpf documentation index page to make it easier to sync to the previously mentioned documentaiton site.

---
 Documentation/bpf/index.rst             | 10 +--------
 Documentation/bpf/libbpf/libbpf_api.rst | 27 -------------------------
 2 files changed, 1 insertion(+), 36 deletions(-)
 delete mode 100644 Documentation/bpf/libbpf/libbpf_api.rst
Documentation/bpf/index.rst +1 -9
index baea6c2abba5..1ceb5d704a97 100644
@@ -15,15 +15,7 @@ that goes into great technical depth about the BPF Architecture.
 libbpf
 ======
 
-Libbpf is a userspace library for loading and interacting with bpf programs.
-
-.. toctree::
-   :maxdepth: 1
-
-   libbpf/libbpf
-   libbpf/libbpf_api
-   libbpf/libbpf_build
-   libbpf/libbpf_naming_convention
+Documentation/bpf/libbpf/libbpf.rst is a userspace library for loading and interacting with bpf programs.
 
 BPF Type Format (BTF)
 =====================
Documentation/bpf/libbpf/libbpf_api.rst deleted +0 -27
deleted file mode 100644
index f07eecd054da..000000000000
@@ -1,27 +0,0 @@
-.. SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause)
-
-API
-===
-
-This documentation is autogenerated from header files in libbpf, tools/lib/bpf
-
-.. kernel-doc:: tools/lib/bpf/libbpf.h
-   :internal:
-
-.. kernel-doc:: tools/lib/bpf/bpf.h
-   :internal:
-
-.. kernel-doc:: tools/lib/bpf/btf.h
-   :internal:
-
-.. kernel-doc:: tools/lib/bpf/xsk.h
-   :internal:
-
-.. kernel-doc:: tools/lib/bpf/bpf_tracing.h
-   :internal:
-
-.. kernel-doc:: tools/lib/bpf/bpf_core_read.h
-   :internal:
-
-.. kernel-doc:: tools/lib/bpf/bpf_endian.h
-   :internal:
\ No newline at end of file
Signature · 1 line
2.31.1
#1 lore raw
Quoted 8 lines · grantseltzer

This removes the libbpf_api.rst file from the kernel documentation. The intention for this file was to pull documentation from comments above API functions in libbpf. However, due to limitations of the kernel documentation system, this API documentation could not be versioned, which is counterintuitive to how users expect to use it. There is also currently no doc comments, making this a blank page.

Quoted 5 lines

Once the kernel comment documentation is actually contributed, it will still exist in the kernel repository, just in the code itself.

A seperate site is being spun up to generate documentaiton from those comments in a way in which it can be versioned properly.

For more info regarding the above mentioned separate documentation site, see https://github.com/libbpf/libbpf/pull/357

#2 lore raw
In reply to grantseltzer
This patch was applied to bpf/bpf-next.git (refs/heads/master):

Hello:

This patch was applied to bpf/bpf-next.git (refs/heads/master):

Quoted 8 lines · On Mon, 9 Aug 2021 22:05:08 -0400 you wrote:

This removes the libbpf_api.rst file from the kernel documentation. The intention for this file was to pull documentation from comments above API functions in libbpf. However, due to limitations of the kernel documentation system, this API documentation could not be versioned, which is counterintuative to how users expect to use it. There is also currently no doc comments, making this a blank page.

[...]

Here is the summary with links:
- [bpf-next,v1] bpf: Reconfigure libbpf docs to remove unversioned API

    https://git.kernel.org/bpf/bpf-next/c/bb57164920d7

You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html