summaryrefslogtreecommitdiff
path: root/tools/bpf/bpftool/perf.c
diff options
context:
space:
mode:
authorQuentin Monnet <quentin@isovalent.com>2021-07-31 00:54:32 +0300
committerAndrii Nakryiko <andrii@kernel.org>2021-07-31 01:40:27 +0300
commitc07ba629df97b796ca7bbdfbf4748266ead27745 (patch)
treee37c339d347ac099ef50a9b0020676506d209b32 /tools/bpf/bpftool/perf.c
parentb544342e52fc3dfcc1d430fff8d1a7a3be920ffd (diff)
downloadlinux-c07ba629df97b796ca7bbdfbf4748266ead27745.tar.xz
tools: bpftool: Update and synchronise option list in doc and help msg
All bpftool commands support the options for JSON output and debug from libbpf. In addition, some commands support additional options corresponding to specific use cases. The list of options described in the man pages for the different commands are not always accurate. The messages for interactive help are mostly limited to HELP_SPEC_OPTIONS, and are even less representative of the actual set of options supported for the commands. Let's update the lists: - HELP_SPEC_OPTIONS is modified to contain the "default" options (JSON and debug), and to be extensible (no ending curly bracket). - All commands use HELP_SPEC_OPTIONS in their help message, and then complete the list with their specific options. - The lists of options in the man pages are updated. - The formatting of the list for bpftool.rst is adjusted to match formatting for the other man pages. This is for consistency, and also because it will be helpful in a future patch to automatically check that the files are synchronised. Signed-off-by: Quentin Monnet <quentin@isovalent.com> Signed-off-by: Andrii Nakryiko <andrii@kernel.org> Link: https://lore.kernel.org/bpf/20210730215435.7095-5-quentin@isovalent.com
Diffstat (limited to 'tools/bpf/bpftool/perf.c')
-rw-r--r--tools/bpf/bpftool/perf.c5
1 files changed, 4 insertions, 1 deletions
diff --git a/tools/bpf/bpftool/perf.c b/tools/bpf/bpftool/perf.c
index ad23934819c7..50de087b0db7 100644
--- a/tools/bpf/bpftool/perf.c
+++ b/tools/bpf/bpftool/perf.c
@@ -231,7 +231,10 @@ static int do_show(int argc, char **argv)
static int do_help(int argc, char **argv)
{
fprintf(stderr,
- "Usage: %1$s %2$s { show | list | help }\n"
+ "Usage: %1$s %2$s { show | list }\n"
+ " %1$s %2$s help }\n"
+ "\n"
+ " " HELP_SPEC_OPTIONS " }\n"
"",
bin_name, argv[-2]);