diff options
| author | Quentin Monnet <quentin@isovalent.com> | 2020-09-09 17:24:59 +0100 |
|---|---|---|
| committer | Alexei Starovoitov <ast@kernel.org> | 2020-09-10 11:16:46 -0700 |
| commit | f28ef96d7b04a76575a020a9da4f92358abe68c6 (patch) | |
| tree | cab44cc5075ad0a04ff13d0d8f80426918661ac3 /tools/bpf/bpftool/Documentation/bpftool-iter.rst | |
| parent | 82b8cf0acc7bfe7b247e5ddc4417f6146d74c0b8 (diff) | |
tools: bpftool: Include common options from separate file
Nearly all man pages for bpftool have the same common set of option
flags (--help, --version, --json, --pretty, --debug). The description is
duplicated across all the pages, which is more difficult to maintain if
the description of an option changes. It may also be confusing to sort
out what options are not "common" and should not be copied when creating
new manual pages.
Let's move the description for those common options to a separate file,
which is included with a RST directive when generating the man pages.
Signed-off-by: Quentin Monnet <quentin@isovalent.com>
Signed-off-by: Alexei Starovoitov <ast@kernel.org>
Acked-by: Andrii Nakryiko <andriin@fb.com>
Link: https://lore.kernel.org/bpf/20200909162500.17010-3-quentin@isovalent.com
Diffstat (limited to 'tools/bpf/bpftool/Documentation/bpftool-iter.rst')
| -rw-r--r-- | tools/bpf/bpftool/Documentation/bpftool-iter.rst | 11 |
1 files changed, 1 insertions, 10 deletions
diff --git a/tools/bpf/bpftool/Documentation/bpftool-iter.rst b/tools/bpf/bpftool/Documentation/bpftool-iter.rst index 070ffacb42b5..b688cf11805c 100644 --- a/tools/bpf/bpftool/Documentation/bpftool-iter.rst +++ b/tools/bpf/bpftool/Documentation/bpftool-iter.rst @@ -51,16 +51,7 @@ DESCRIPTION OPTIONS ======= - -h, --help - Print short generic help message (similar to **bpftool help**). - - -V, --version - Print version number (similar to **bpftool version**). - - -d, --debug - Print all logs available, even debug-level information. This - includes logs from libbpf as well as from the verifier, when - attempting to load programs. + .. include:: common_options.rst EXAMPLES ======== |