Skip to contentSkip to conversation

Improve libbpf API documentation link position

PATCH Applied grantseltzer 2 participants 2 messages Apr 22, 2022

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

PATCH 1/1 Improve libbpf API documentation link position

From: Grant Seltzer <[email protected]>

This puts the link for libbpf API documentation into the sidebar for much easier navigation.

You can preview this change at:

https://libbpf-test.readthedocs.io/en/latest/

Note that the link is hardcoded to the production version, so you can see that it self references itself here for now:

https://libbpf-test.readthedocs.io/en/latest/api.html

This will need to make its way into the libbpf mirror, before being deployed to libbpf.readthedocs.org

---
 Documentation/bpf/libbpf/index.rst | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)
Documentation/bpf/libbpf/index.rst +1 -2
index 4e8c656b539a..3722537d1384 100644
@@ -6,14 +6,13 @@ libbpf
 .. toctree::
    :maxdepth: 1
 
+   API Documentation <https://libbpf.readthedocs.io/en/latest/api.html>
    libbpf_naming_convention
    libbpf_build
 
 This is documentation for libbpf, a userspace library for loading and
 interacting with bpf programs.
 
-For API documentation see the `versioned API documentation site <https://libbpf.readthedocs.io/en/latest/api.html>`_.
-
 All general BPF questions, including kernel functionality, libbpf APIs and
 their application, should be sent to [email protected] mailing list.
 You can `subscribe <http://vger.kernel.org/vger-lists.html#bpf>`_ to the
Signature · 1 line
2.34.1
#1 lore raw
This patch was applied to bpf/bpf-next.git (master) by Daniel Borkmann <[email protected]>:

Hello:

This patch was applied to bpf/bpf-next.git (master) by Daniel Borkmann <[email protected]>:

Quoted 8 lines · On Thu, 21 Apr 2022 23:10:50 -0400 you wrote:

From: Grant Seltzer <[email protected]>

This puts the link for libbpf API documentation into the sidebar for much easier navigation.

You can preview this change at:

[...]

Here is the summary with links:
- Improve libbpf API documentation link position

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

You are awesome, thank you!

Signature · 2 lines
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html