Several commands and objects implemented in bpftool are currently missing from the SYNOPSIS sections in the man pages, causing documentation drift. Update the documentation across bpftool man pages: - Add the missing 'token' object and its commands to bpftool.rst. - Add missing subcommands to the SYNOPSIS blocks of btf, feature, gen, link, map, net, and prog man pages to reflect existing implementations. - Update help command headings in the cgroup and token documentation to reference their respective objects instead of prog. Signed-off-by: Dhanush Arivappagari --- tools/bpf/bpftool/Documentation/bpftool-btf.rst | 2 +- .../bpftool/Documentation/bpftool-cgroup.rst | 2 +- .../bpftool/Documentation/bpftool-feature.rst | 2 +- tools/bpf/bpftool/Documentation/bpftool-gen.rst | 2 +- .../bpf/bpftool/Documentation/bpftool-link.rst | 2 +- tools/bpf/bpftool/Documentation/bpftool-map.rst | 3 ++- .../bpf/bpftool/Documentation/bpftool-prog.rst | 2 +- .../bpf/bpftool/Documentation/bpftool-token.rst | 2 +- tools/bpf/bpftool/Documentation/bpftool.rst | 17 ++++++++++------- 9 files changed, 19 insertions(+), 15 deletions(-) diff --git a/tools/bpf/bpftool/Documentation/bpftool-btf.rst b/tools/bpf/bpftool/Documentation/bpftool-btf.rst index c6dc445cd4a1..e25277260ceb 100644 --- a/tools/bpf/bpftool/Documentation/bpftool-btf.rst +++ b/tools/bpf/bpftool/Documentation/bpftool-btf.rst @@ -18,7 +18,7 @@ SYNOPSIS *OPTIONS* := { |COMMON_OPTIONS| | [{ **-B** | **--base-btf**} *FILE*]... } -*COMMANDS* := { **dump** | **help** } +*COMMANDS* := { **show** | **list** | **dump** | **help** } BTF COMMANDS ============= diff --git a/tools/bpf/bpftool/Documentation/bpftool-cgroup.rst b/tools/bpf/bpftool/Documentation/bpftool-cgroup.rst index d1b8193dc576..7633a42b54b0 100644 --- a/tools/bpf/bpftool/Documentation/bpftool-cgroup.rst +++ b/tools/bpf/bpftool/Documentation/bpftool-cgroup.rst @@ -131,7 +131,7 @@ bpftool cgroup attach *CGROUP* *ATTACH_TYPE* *PROG* [*ATTACH_FLAGS*] bpftool cgroup detach *CGROUP* *ATTACH_TYPE* *PROG* Detach *PROG* from the cgroup *CGROUP* and attach type *ATTACH_TYPE*. -bpftool prog help +bpftool cgroup help Print short help message. OPTIONS diff --git a/tools/bpf/bpftool/Documentation/bpftool-feature.rst b/tools/bpf/bpftool/Documentation/bpftool-feature.rst index c7f837898bc7..9ed5ff93ebdb 100644 --- a/tools/bpf/bpftool/Documentation/bpftool-feature.rst +++ b/tools/bpf/bpftool/Documentation/bpftool-feature.rst @@ -18,7 +18,7 @@ SYNOPSIS *OPTIONS* := { |COMMON_OPTIONS| } -*COMMANDS* := { **probe** | **help** } +*COMMANDS* := { **probe** | **list_builtins** | **help** } FEATURE COMMANDS ================ diff --git a/tools/bpf/bpftool/Documentation/bpftool-gen.rst b/tools/bpf/bpftool/Documentation/bpftool-gen.rst index d0a36f442db7..0c0f9616f676 100644 --- a/tools/bpf/bpftool/Documentation/bpftool-gen.rst +++ b/tools/bpf/bpftool/Documentation/bpftool-gen.rst @@ -18,7 +18,7 @@ SYNOPSIS *OPTIONS* := { |COMMON_OPTIONS| | { **-L** | **--use-loader** } | [ { **-S** | **--sign** } {**-k** } **-i** ] } -*COMMAND* := { **object** | **skeleton** | **help** } +*COMMAND* := { **object** | **skeleton** | **subskeleton** | **min_core_btf** | **help** } GEN COMMANDS ============= diff --git a/tools/bpf/bpftool/Documentation/bpftool-link.rst b/tools/bpf/bpftool/Documentation/bpftool-link.rst index 6f09d4405ed8..21b22aa70fdc 100644 --- a/tools/bpf/bpftool/Documentation/bpftool-link.rst +++ b/tools/bpf/bpftool/Documentation/bpftool-link.rst @@ -18,7 +18,7 @@ SYNOPSIS *OPTIONS* := { |COMMON_OPTIONS| | { **-f** | **--bpffs** } | { **-n** | **--nomount** } } -*COMMANDS* := { **show** | **list** | **pin** | **help** } +*COMMANDS* := { **show** | **list** | **pin** | **detach** | **help** } LINK COMMANDS ============= diff --git a/tools/bpf/bpftool/Documentation/bpftool-map.rst b/tools/bpf/bpftool/Documentation/bpftool-map.rst index e4ed7e701c9e..391b0c6c0c6a 100644 --- a/tools/bpf/bpftool/Documentation/bpftool-map.rst +++ b/tools/bpf/bpftool/Documentation/bpftool-map.rst @@ -20,7 +20,8 @@ SYNOPSIS *COMMANDS* := { **show** | **list** | **create** | **dump** | **update** | **lookup** | **getnext** | -**delete** | **pin** | **help** } +**delete** | **pin** | **event_pipe** | **peek** | **push** | **pop** | **enqueue** | **dequeue** | +**freeze** | **help** } MAP COMMANDS ============= diff --git a/tools/bpf/bpftool/Documentation/bpftool-prog.rst b/tools/bpf/bpftool/Documentation/bpftool-prog.rst index 8dbd34ef3d8b..c239cb506c38 100644 --- a/tools/bpf/bpftool/Documentation/bpftool-prog.rst +++ b/tools/bpf/bpftool/Documentation/bpftool-prog.rst @@ -23,7 +23,7 @@ SYNOPSIS *COMMANDS* := { **show** | **list** | **dump xlated** | **dump jited** | **pin** | **load** | -**loadall** | **help** } +**loadall** | **attach** | **detach** | **tracelog** | **run** | **profile** | **help** } PROG COMMANDS ============= diff --git a/tools/bpf/bpftool/Documentation/bpftool-token.rst b/tools/bpf/bpftool/Documentation/bpftool-token.rst index d082c499cfe3..1f4e6f4f64b0 100644 --- a/tools/bpf/bpftool/Documentation/bpftool-token.rst +++ b/tools/bpf/bpftool/Documentation/bpftool-token.rst @@ -35,7 +35,7 @@ bpftool token { show | list } **bpf**\ () system call commands, maps, programs, and attach types for the token. -bpftool prog help +bpftool token help Print short help message. OPTIONS diff --git a/tools/bpf/bpftool/Documentation/bpftool.rst b/tools/bpf/bpftool/Documentation/bpftool.rst index f38ae5c40439..a213f7032d8d 100644 --- a/tools/bpf/bpftool/Documentation/bpftool.rst +++ b/tools/bpf/bpftool/Documentation/bpftool.rst @@ -21,35 +21,38 @@ SYNOPSIS **bpftool** **version** *OBJECT* := { **map** | **prog** | **link** | **cgroup** | **perf** | **net** | **feature** | -**btf** | **gen** | **struct_ops** | **iter** } +**btf** | **gen** | **struct_ops** | **iter** | **token** } *OPTIONS* := { { **-V** | **--version** } | |COMMON_OPTIONS| } *MAP-COMMANDS* := { **show** | **list** | **create** | **dump** | **update** | **lookup** | **getnext** | -**delete** | **pin** | **event_pipe** | **help** } +**delete** | **pin** | **event_pipe** | **peek** | **push** | **pop** | **enqueue** | **dequeue** | +**freeze** | **help** } *PROG-COMMANDS* := { **show** | **list** | **dump jited** | **dump xlated** | **pin** | -**load** | **attach** | **detach** | **help** } +**load** | **loadall** | **attach** | **detach** | **run** | **profile** | **tracelog** | **help** } *LINK-COMMANDS* := { **show** | **list** | **pin** | **detach** | **help** } -*CGROUP-COMMANDS* := { **show** | **list** | **attach** | **detach** | **help** } +*CGROUP-COMMANDS* := { **show** | **list** | **tree** | **attach** | **detach** | **help** } *PERF-COMMANDS* := { **show** | **list** | **help** } -*NET-COMMANDS* := { **show** | **list** | **help** } +*NET-COMMANDS* := { **show** | **list** | **attach** | **detach** | **help** } -*FEATURE-COMMANDS* := { **probe** | **help** } +*FEATURE-COMMANDS* := { **probe** | **list_builtins** | **help** } *BTF-COMMANDS* := { **show** | **list** | **dump** | **help** } -*GEN-COMMANDS* := { **object** | **skeleton** | **min_core_btf** | **help** } +*GEN-COMMANDS* := { **object** | **skeleton** | **subskeleton** | **min_core_btf** | **help** } *STRUCT-OPS-COMMANDS* := { **show** | **list** | **dump** | **register** | **unregister** | **help** } *ITER-COMMANDS* := { **pin** | **help** } +*TOKEN-COMMANDS* := { **show** | **list** | **help** } + DESCRIPTION =========== *bpftool* allows for inspection and simple modification of BPF objects on the