bpf.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH bpf-next v1] bpf: Reconfigure libbpf docs to remove unversioned API
@ 2021-08-10  2:05 grantseltzer
  2021-08-10  2:11 ` Grant Seltzer Richman
  2021-08-17  0:40 ` patchwork-bot+netdevbpf
  0 siblings, 2 replies; 3+ messages in thread
From: grantseltzer @ 2021-08-10  2:05 UTC (permalink / raw)
  To: andrii; +Cc: bpf, corbet, linux-doc, 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 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.

Signed-off-by: Grant Seltzer <grantseltzer@gmail.com>
---
 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

diff --git a/Documentation/bpf/index.rst b/Documentation/bpf/index.rst
index baea6c2abba5..1ceb5d704a97 100644
--- a/Documentation/bpf/index.rst
+++ b/Documentation/bpf/index.rst
@@ -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)
 =====================
diff --git a/Documentation/bpf/libbpf/libbpf_api.rst b/Documentation/bpf/libbpf/libbpf_api.rst
deleted file mode 100644
index f07eecd054da..000000000000
--- a/Documentation/bpf/libbpf/libbpf_api.rst
+++ /dev/null
@@ -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
-- 
2.31.1


^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH bpf-next v1] bpf: Reconfigure libbpf docs to remove unversioned API
  2021-08-10  2:05 [PATCH bpf-next v1] bpf: Reconfigure libbpf docs to remove unversioned API grantseltzer
@ 2021-08-10  2:11 ` Grant Seltzer Richman
  2021-08-17  0:40 ` patchwork-bot+netdevbpf
  1 sibling, 0 replies; 3+ messages in thread
From: Grant Seltzer Richman @ 2021-08-10  2:11 UTC (permalink / raw)
  To: Andrii Nakryiko; +Cc: bpf, Jonathan Corbet, linux-doc

On Mon, Aug 9, 2021 at 10:05 PM grantseltzer <grantseltzer@gmail.com> 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 counterintuitive 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.

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

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH bpf-next v1] bpf: Reconfigure libbpf docs to remove unversioned API
  2021-08-10  2:05 [PATCH bpf-next v1] bpf: Reconfigure libbpf docs to remove unversioned API grantseltzer
  2021-08-10  2:11 ` Grant Seltzer Richman
@ 2021-08-17  0:40 ` patchwork-bot+netdevbpf
  1 sibling, 0 replies; 3+ messages in thread
From: patchwork-bot+netdevbpf @ 2021-08-17  0:40 UTC (permalink / raw)
  To: Grant Seltzer Richman; +Cc: andrii, bpf, corbet, linux-doc

Hello:

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

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



^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2021-08-17  0:40 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-08-10  2:05 [PATCH bpf-next v1] bpf: Reconfigure libbpf docs to remove unversioned API grantseltzer
2021-08-10  2:11 ` Grant Seltzer Richman
2021-08-17  0:40 ` patchwork-bot+netdevbpf

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).