Commit 90040351 authored by Quentin Monnet's avatar Quentin Monnet Committed by Alexei Starovoitov
Browse files

tools, bpftool: Clean subcommand help messages 



This is a clean-up for the formatting of the do_help functions for
bpftool's subcommands. The following fixes are included:

- Do not use argv[-2] for "iter" help message, as the help is shown by
  default if no "iter" action is selected, resulting in messages looking
  like "./bpftool bpftool pin...".

- Do not print unused HELP_SPEC_PROGRAM in help message for "bpftool
  link".

- Andrii used argument indexing to avoid having multiple occurrences of
  bin_name and argv[-2] in the fprintf() for the help message, for
  "bpftool gen" and "bpftool link". Let's reuse this for all other help
  functions. We can remove up to thirty arguments for the "bpftool map"
  help message.

- Harmonise all functions, e.g. use ending quotes-comma on a separate
  line.

Signed-off-by: default avatarQuentin Monnet <quentin@isovalent.com>
Signed-off-by: default avatarDaniel Borkmann <daniel@iogearbox.net>
Link: https://lore.kernel.org/bpf/20200523010751.23465-1-quentin@isovalent.com


Signed-off-by: default avatarAlexei Starovoitov <ast@kernel.org>
parent eae9d3c0

tools/bpf/bpftool/btf.c

+4 −4
Original line number Diff line number Diff line
@@ -951,9 +951,9 @@ static int do_help(int argc, char **argv) 
	}



	fprintf(stderr,

		"Usage: %s btf { show | list } [id BTF_ID]\n"

		"       %s btf dump BTF_SRC [format FORMAT]\n"

		"       %s btf help\n"

		"Usage: %1$s %2$s { show | list } [id BTF_ID]\n"

		"       %1$s %2$s dump BTF_SRC [format FORMAT]\n"

		"       %1$s %2$s help\n"

		"\n"

		"       BTF_SRC := { id BTF_ID | prog PROG | map MAP [{key | value | kv | all}] | file FILE }\n"

		"       FORMAT  := { raw | c }\n"
@@ -961,7 +961,7 @@ static int do_help(int argc, char **argv) 
		"       " HELP_SPEC_PROGRAM "\n"

		"       " HELP_SPEC_OPTIONS "\n"

		"",

		bin_name, bin_name, bin_name);

		bin_name, "btf");



	return 0;

}

tools/bpf/bpftool/cgroup.c

+6 −8
Original line number Diff line number Diff line
@@ -491,20 +491,18 @@ static int do_help(int argc, char **argv) 
	}



	fprintf(stderr,

		"Usage: %s %s { show | list } CGROUP [**effective**]\n"

		"       %s %s tree [CGROUP_ROOT] [**effective**]\n"

		"       %s %s attach CGROUP ATTACH_TYPE PROG [ATTACH_FLAGS]\n"

		"       %s %s detach CGROUP ATTACH_TYPE PROG\n"

		"       %s %s help\n"

		"Usage: %1$s %2$s { show | list } CGROUP [**effective**]\n"

		"       %1$s %2$s tree [CGROUP_ROOT] [**effective**]\n"

		"       %1$s %2$s attach CGROUP ATTACH_TYPE PROG [ATTACH_FLAGS]\n"

		"       %1$s %2$s detach CGROUP ATTACH_TYPE PROG\n"

		"       %1$s %2$s help\n"

		"\n"

		HELP_SPEC_ATTACH_TYPES "\n"

		"       " HELP_SPEC_ATTACH_FLAGS "\n"

		"       " HELP_SPEC_PROGRAM "\n"

		"       " HELP_SPEC_OPTIONS "\n"

		"",

		bin_name, argv[-2],

		bin_name, argv[-2], bin_name, argv[-2],

		bin_name, argv[-2], bin_name, argv[-2]);

		bin_name, argv[-2]);



	return 0;

}

tools/bpf/bpftool/feature.c

+3 −3
Original line number Diff line number Diff line
@@ -937,12 +937,12 @@ static int do_help(int argc, char **argv) 
	}



	fprintf(stderr,

		"Usage: %s %s probe [COMPONENT] [full] [unprivileged] [macros [prefix PREFIX]]\n"

		"       %s %s help\n"

		"Usage: %1$s %2$s probe [COMPONENT] [full] [unprivileged] [macros [prefix PREFIX]]\n"

		"       %1$s %2$s help\n"

		"\n"

		"       COMPONENT := { kernel | dev NAME }\n"

		"",

		bin_name, argv[-2], bin_name, argv[-2]);

		bin_name, argv[-2]);



	return 0;

}

tools/bpf/bpftool/gen.c

+3 −3
Original line number Diff line number Diff line
@@ -586,12 +586,12 @@ static int do_help(int argc, char **argv) 
	}



	fprintf(stderr,

		"Usage: %1$s gen skeleton FILE\n"

		"       %1$s gen help\n"

		"Usage: %1$s %2$s skeleton FILE\n"

		"       %1$s %2$s help\n"

		"\n"

		"       " HELP_SPEC_OPTIONS "\n"

		"",

		bin_name);

		bin_name, "gen");



	return 0;

}

tools/bpf/bpftool/iter.c

+4 −4
Original line number Diff line number Diff line
@@ -68,10 +68,10 @@ close_obj: 
static int do_help(int argc, char **argv)

{

	fprintf(stderr,

		"Usage: %s %s pin OBJ PATH\n"

		"       %s %s help\n"

		"\n",

		bin_name, argv[-2], bin_name, argv[-2]);

		"Usage: %1$s %2$s pin OBJ PATH\n"

		"       %1$s %2$s help\n"

		"",

		bin_name, "iter");



	return 0;

}

CRA Git | Maintained and supported by SUSTech CRA and CCSE