Skip to content

Commit

Permalink
bpftool: man: Add missing top level docs
Browse files Browse the repository at this point in the history
The top-level (bpftool.8) man page was missing docs for a few
subcommands and their respective sub-sub-commands.

This commit brings the top level man page up to date. Note that I've
kept the ordering of the subcommands the same as in `bpftool help`.

Signed-off-by: Daniel Xu <dxu@dxuuu.xyz>
Signed-off-by: Andrii Nakryiko <andrii@kernel.org>
Link: https://lore.kernel.org/bpf/3049ef5dc509c0d1832f0a8b2dba2ccaad0af688.1647213551.git.dxu@dxuuu.xyz
  • Loading branch information
danobi authored and anakryiko committed Mar 15, 2022
1 parent cbdaf71 commit 6585abe
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion tools/bpf/bpftool/Documentation/bpftool.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ SYNOPSIS

**bpftool** **version**

*OBJECT* := { **map** | **program** | **cgroup** | **perf** | **net** | **feature** }
*OBJECT* := { **map** | **program** | **link** | **cgroup** | **perf** | **net** | **feature** |
**btf** | **gen** | **struct_ops** | **iter** }

*OPTIONS* := { { **-V** | **--version** } | |COMMON_OPTIONS| }

Expand All @@ -31,6 +32,8 @@ SYNOPSIS
*PROG-COMMANDS* := { **show** | **list** | **dump jited** | **dump xlated** | **pin** |
**load** | **attach** | **detach** | **help** }

*LINK-COMMANDS* := { **show** | **list** | **pin** | **detach** | **help** }

*CGROUP-COMMANDS* := { **show** | **list** | **attach** | **detach** | **help** }

*PERF-COMMANDS* := { **show** | **list** | **help** }
Expand All @@ -39,6 +42,14 @@ SYNOPSIS

*FEATURE-COMMANDS* := { **probe** | **help** }

*BTF-COMMANDS* := { **show** | **list** | **dump** | **help** }

*GEN-COMMANDS* := { **object** | **skeleton** | **min_core_btf** | **help** }

*STRUCT-OPS-COMMANDS* := { **show** | **list** | **dump** | **register** | **unregister** | **help** }

*ITER-COMMANDS* := { **pin** | **help** }

DESCRIPTION
===========
*bpftool* allows for inspection and simple modification of BPF objects
Expand Down

0 comments on commit 6585abe

Please sign in to comment.