From: grantseltzer <grantseltzer@gmail.com>
To: bpf@vger.kernel.org
Cc: andrii@kernel.org, Grant Seltzer <grantseltzer@gmail.com>
Subject: [PATCH] Improve libbpf API documentation link position
Date: Thu, 21 Apr 2022 23:10:50 -0400 [thread overview]
Message-ID: <20220422031050.303984-1-grantseltzer@gmail.com> (raw)
From: Grant Seltzer <grantseltzer@gmail.com>
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
Signed-off-by: Grant Seltzer <grantseltzer@gmail.com>
---
Documentation/bpf/libbpf/index.rst | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/Documentation/bpf/libbpf/index.rst b/Documentation/bpf/libbpf/index.rst
index 4e8c656b539a..3722537d1384 100644
--- a/Documentation/bpf/libbpf/index.rst
+++ b/Documentation/bpf/libbpf/index.rst
@@ -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 bpf@vger.kernel.org mailing list.
You can `subscribe <http://vger.kernel.org/vger-lists.html#bpf>`_ to the
--
2.34.1
next reply other threads:[~2022-04-22 3:11 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-22 3:10 grantseltzer [this message]
2022-04-22 14:30 ` [PATCH] Improve libbpf API documentation link position patchwork-bot+netdevbpf
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220422031050.303984-1-grantseltzer@gmail.com \
--to=grantseltzer@gmail.com \
--cc=andrii@kernel.org \
--cc=bpf@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox