diff options
| author |   Quentin Monnet <quentin@isovalent.com> | 2021-11-10 11:46:30 +0000 |
|---|---|---|
| committer |   Andrii Nakryiko <andrii@kernel.org> | 2021-11-14 18:35:02 -0800 |
| commit | 986dec18bbf41f50edc2e0aa4ac5ef8e0f64f328 (patch) | |
| tree | 52d1b86dece90300355d2b8bfccb0de56790364c /tools/bpf/bpftool/Documentation/bpftool.rst | |
| parent | bpftool: Remove inclusion of utilities.mak from Makefiles (diff) | |
| download | linux-dev-986dec18bbf41f50edc2e0aa4ac5ef8e0f64f328.tar.xz linux-dev-986dec18bbf41f50edc2e0aa4ac5ef8e0f64f328.zip | |
bpftool: Fix indent in option lists in the documentation
Mixed indentation levels in the lists of options in bpftool's
documentation produces some unexpected results. For the "bpftool" man
page, it prints a warning:
$ make -C bpftool.8
GEN bpftool.8
<stdin>:26: (ERROR/3) Unexpected indentation.
For other pages, there is no warning, but it results in a line break
appearing in the option lists in the generated man pages.
RST paragraphs should have a uniform indentation level. Let's fix it.
Fixes: c07ba629df97 ("tools: bpftool: Update and synchronise option list in doc and help msg")
Fixes: 8cc8c6357c8f ("tools: bpftool: Document and add bash completion for -L, -B options")
Signed-off-by: Quentin Monnet <quentin@isovalent.com>
Signed-off-by: Andrii Nakryiko <andrii@kernel.org>
Link: https://lore.kernel.org/bpf/20211110114632.24537-5-quentin@isovalent.com
Diffstat (limited to '')
| -rw-r--r-- | tools/bpf/bpftool/Documentation/bpftool.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/tools/bpf/bpftool/Documentation/bpftool.rst b/tools/bpf/bpftool/Documentation/bpftool.rst index bb23f55bb05a..8ac86565c501 100644 --- a/tools/bpf/bpftool/Documentation/bpftool.rst +++ b/tools/bpf/bpftool/Documentation/bpftool.rst @@ -19,14 +19,14 @@ SYNOPSIS *OBJECT* := { **map** | **program** | **cgroup** | **perf** | **net** | **feature** } *OPTIONS* := { { **-V** | **--version** } | - { **-j** | **--json** } [{ **-p** | **--pretty** }] | { **-d** | **--debug** } } + { **-j** | **--json** } [{ **-p** | **--pretty** }] | { **-d** | **--debug** } } *MAP-COMMANDS* := { **show** | **list** | **create** | **dump** | **update** | **lookup** | **getnext** | - **delete** | **pin** | **event_pipe** | **help** } + **delete** | **pin** | **event_pipe** | **help** } *PROG-COMMANDS* := { **show** | **list** | **dump jited** | **dump xlated** | **pin** | - **load** | **attach** | **detach** | **help** } + **load** | **attach** | **detach** | **help** } *CGROUP-COMMANDS* := { **show** | **list** | **attach** | **detach** | **help** } |