[PATCHv2 bpf-next 00/15] Improve BPF syscall command documentation · Joe Stringer <hidden> · 2021-03-03
[PATCHv2 bpf-next 15/15] tools: Sync uapi bpf.h header with latest changes · Joe Stringer <hidden> · 2021-03-03
[PATCHv2 bpf-next 07/15] bpf: Document BPF_PROG_QUERY syscall command · Joe Stringer <hidden> · 2021-03-03
Re: [PATCHv2 bpf-next 07/15] bpf: Document BPF_PROG_QUERY syscall command · Yonghong Song <hidden> · 2021-03-03
[PATCHv2 bpf-next 05/15] bpf: Document BPF_PROG_ATTACH syscall command · Joe Stringer <hidden> · 2021-03-03
Re: [PATCHv2 bpf-next 05/15] bpf: Document BPF_PROG_ATTACH syscall command · Yonghong Song <hidden> · 2021-03-03
[PATCHv2 bpf-next 04/15] bpf: Document BPF_PROG_PIN syscall command · Joe Stringer <hidden> · 2021-03-03
Re: [PATCHv2 bpf-next 04/15] bpf: Document BPF_PROG_PIN syscall command · Yonghong Song <hidden> · 2021-03-03
[PATCHv2 bpf-next 02/15] bpf: Add minimal bpf() command documentation · Joe Stringer <hidden> · 2021-03-03
Re: [PATCHv2 bpf-next 02/15] bpf: Add minimal bpf() command documentation · Yonghong Song <hidden> · 2021-03-03
[PATCHv2 bpf-next 03/15] bpf: Document BPF_F_LOCK in syscall commands · Joe Stringer <hidden> · 2021-03-03
Re: [PATCHv2 bpf-next 03/15] bpf: Document BPF_F_LOCK in syscall commands · Yonghong Song <hidden> · 2021-03-03
[PATCHv2 bpf-next 06/15] bpf: Document BPF_PROG_TEST_RUN syscall command · Joe Stringer <hidden> · 2021-03-03
Re: [PATCHv2 bpf-next 06/15] bpf: Document BPF_PROG_TEST_RUN syscall command · Yonghong Song <hidden> · 2021-03-03
Re: [PATCHv2 bpf-next 06/15] bpf: Document BPF_PROG_TEST_RUN syscall command · Joe Stringer <hidden> · 2021-03-04
Re: [PATCHv2 bpf-next 06/15] bpf: Document BPF_PROG_TEST_RUN syscall command · Joe Stringer <hidden> · 2021-04-10
[PATCHv2 bpf-next 01/15] bpf: Import syscall arg documentation · Joe Stringer <hidden> · 2021-03-03
Re: [PATCHv2 bpf-next 01/15] bpf: Import syscall arg documentation · Yonghong Song <hidden> · 2021-03-03
Re: [PATCHv2 bpf-next 01/15] bpf: Import syscall arg documentation · Yonghong Song <hidden> · 2021-03-03
[PATCHv2 bpf-next 10/15] scripts/bpf: Add syscall commands printer · Joe Stringer <hidden> · 2021-03-03
[PATCHv2 bpf-next 14/15] docs/bpf: Add bpf() syscall command reference · Joe Stringer <hidden> · 2021-03-03
[PATCHv2 bpf-next 12/15] selftests/bpf: Templatize man page generation · Joe Stringer <hidden> · 2021-03-03
[PATCHv2 bpf-next 08/15] bpf: Document BPF_MAP_*_BATCH syscall commands · Joe Stringer <hidden> · 2021-03-03
Re: [PATCHv2 bpf-next 08/15] bpf: Document BPF_MAP_*_BATCH syscall commands · Brian Vazquez <hidden> · 2021-03-03
Re: [PATCHv2 bpf-next 08/15] bpf: Document BPF_MAP_*_BATCH syscall commands · Yonghong Song <hidden> · 2021-03-03
[PATCHv2 bpf-next 09/15] scripts/bpf: Abstract eBPF API target parameter · Joe Stringer <hidden> · 2021-03-03
[PATCHv2 bpf-next 13/15] selftests/bpf: Test syscall command parsing · Joe Stringer <hidden> · 2021-03-03
Re: [PATCHv2 bpf-next 13/15] selftests/bpf: Test syscall command parsing · Yonghong Song <hidden> · 2021-03-03
Re: [PATCHv2 bpf-next 13/15] selftests/bpf: Test syscall command parsing · Joe Stringer <hidden> · 2021-03-04
[PATCHv2 bpf-next 11/15] tools/bpf: Remove bpf-helpers from bpftool docs · Joe Stringer <hidden> · 2021-03-03
Re: [PATCHv2 bpf-next 00/15] Improve BPF syscall command documentation · Alexei Starovoitov <hidden> · 2021-03-05

Re: [PATCHv2 bpf-next 00/15] Improve BPF syscall command documentation

From: Alexei Starovoitov <hidden>
Date: 2021-03-05 02:51:50
Also in: bpf, linux-man

On Tue, Mar 2, 2021 at 9:20 AM Joe Stringer [off-list ref] wrote:

Rather than tackle everything at once, I have focused in this series on
the syscall commands, "enum bpf_cmd".

...

The eventual goal of this effort would be to extend the kernel UAPI
headers such that each of the categories I had listed above (commands,
maps, progs, hooks) have dedicated documentation in the kernel tree, and
that developers must update the comments in the headers to document the
APIs prior to patch acceptance, and that we could auto-generate the
latest version of the bpf(2) manual pages based on a few static
description sections combined with the dynamically-generated output from
the header.
v2:
* Remove build infrastructure in favor of kernel-doc directives
* Shift userspace-api docs under Documentation/userspace-api/ebpf
* Fix scripts/bpf_doc.py syscall --header (throw unsupported error)
* Improve .gitignore handling of newly autogenerated files

Looks great. Applied. Thanks!

`h`	back out one level
`j`	next message in thread
`k`	previous message in thread
`l`	drill in
`Esc`	close help / fold thread tree
`?`	toggle this help