diff options
| author |   Quentin Monnet <quentin@isovalent.com> | 2020-05-11 17:15:35 +0100 |
|---|---|---|
| committer |   Daniel Borkmann <daniel@iogearbox.net> | 2020-05-11 21:20:53 +0200 |
| commit | ab8d78093dfa2e7820ca0c28dda9142aa771c510 (patch) | |
| tree | 9a70e74818d4814e139bb87636b482eb3ec740c8 /scripts | |
| parent | tools, bpftool: Minor fixes for documentation (diff) | |
| download | wireguard-linux-ab8d78093dfa2e7820ca0c28dda9142aa771c510.tar.xz wireguard-linux-ab8d78093dfa2e7820ca0c28dda9142aa771c510.zip | |
bpf: Minor fixes to BPF helpers documentation
Minor improvements to the documentation for BPF helpers:
* Fix formatting for the description of "bpf_socket" for
bpf_getsockopt() and bpf_setsockopt(), thus suppressing two warnings
from rst2man about "Unexpected indentation".
* Fix formatting for return values for bpf_sk_assign() and seq_file
helpers.
* Fix and harmonise formatting, in particular for function/struct names.
* Remove blank lines before "Return:" sections.
* Replace tabs found in the middle of text lines.
* Fix typos.
* Add a note to the footer (in Python script) about "bpftool feature
probe", including for listing features available to unprivileged
users, and add a reference to bpftool man page.
Thanks to Florian for reporting two typos (duplicated words).
Signed-off-by: Quentin Monnet <quentin@isovalent.com>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
Link: https://lore.kernel.org/bpf/20200511161536.29853-4-quentin@isovalent.com
Diffstat (limited to 'scripts')
| -rwxr-xr-x | scripts/bpf_helpers_doc.py | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/scripts/bpf_helpers_doc.py b/scripts/bpf_helpers_doc.py index ded304c96a05..91fa668fa860 100755 --- a/scripts/bpf_helpers_doc.py +++ b/scripts/bpf_helpers_doc.py @@ -318,6 +318,11 @@ may be interested in: of eBPF maps are used with a given helper function. * *kernel/bpf/* directory contains other files in which additional helpers are defined (for cgroups, sockmaps, etc.). +* The bpftool utility can be used to probe the availability of helper functions + on the system (as well as supported program and map types, and a number of + other parameters). To do so, run **bpftool feature probe** (see + **bpftool-feature**\ (8) for details). Add the **unprivileged** keyword to + list features available to unprivileged users. Compatibility between helper functions and program types can generally be found in the files where helper functions are defined. Look for the **struct @@ -338,6 +343,7 @@ SEE ALSO ======== **bpf**\ (2), +**bpftool**\ (8), **cgroups**\ (7), **ip**\ (8), **perf_event_open**\ (2), |