From: Jonathan Corbet <corbet@lwn.net>
To: grantseltzer <grantseltzer@gmail.com>,
andrii@kernel.org, daniel@iogearbox.net
Cc: linux-doc@vger.kernel.org, grantseltzer@gmail.com, bpf@vger.kernel.org
Subject: Re: [PATCH bpf-next 0/2] Autogenerating libbpf API documentation
Date: Tue, 01 Jun 2021 12:58:11 -0600 [thread overview]
Message-ID: <871r9lbef0.fsf@meer.lwn.net> (raw)
In-Reply-To: <20210531195553.168298-1-grantseltzer@gmail.com>
grantseltzer <grantseltzer@gmail.com> writes:
> This patch series is meant to start the initiative to document libbpf.
> It includes .rst files which are text documentation describing building,
> API naming convention, as well as an index to generated API documentation.
>
> In this approach the generated API documentation is enabled by the kernels
> existing kernel documentation system which uses sphinx. The resulting docs
> would then be synced to kernel.org/doc
>
> You can test this by running `make htmldocs` and serving the html in
> Documentation/output. Since libbpf does not yet have comments in kernel
> doc format, see kernel.org/doc/html/latest/doc-guide/kernel-doc.html for
> an example so you can test this.
>
> The advantage of this approach is to use the existing sphinx
> infrastructure that the kernel has, and have libbpf docs in
> the same place as everything else.
>
> The perhaps large disadvantage of this approach is that libbpf versions
> independently from the kernel. If it's possible to version libbpf
> separately without having duplicates that would be the ideal scenario.
I'm happy to see things going this direction; it looks like a good start
to me.
Let me know if you'd like this to go through the docs tree, or feel free
to add:
Acked-by: Jonathan Corbet <corbet@lwn.net>
if you want to route it via some other path.
Thanks,
jon
next prev parent reply other threads:[~2021-06-01 18:58 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-31 19:55 [PATCH bpf-next 0/2] Autogenerating libbpf API documentation grantseltzer
2021-05-31 19:55 ` [PATCH bpf-next 1/2] Add documentation for libbpf including API autogen grantseltzer
2021-05-31 20:05 ` Matthew Wilcox
2021-06-02 20:36 ` Andrii Nakryiko
2021-06-05 18:20 ` Grant Seltzer Richman
2021-05-31 19:55 ` [PATCH bpf-next 2/2] Remove duplicate README doc from libbpf grantseltzer
2021-06-02 20:38 ` Andrii Nakryiko
2021-06-01 18:58 ` Jonathan Corbet [this message]
2021-06-02 20:37 ` [PATCH bpf-next 0/2] Autogenerating libbpf API documentation Andrii Nakryiko
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=871r9lbef0.fsf@meer.lwn.net \
--to=corbet@lwn.net \
--cc=andrii@kernel.org \
--cc=bpf@vger.kernel.org \
--cc=daniel@iogearbox.net \
--cc=grantseltzer@gmail.com \
--cc=linux-doc@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;
as well as URLs for NNTP newsgroup(s).