Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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

authored by

Quentin Monnet and committed by
Andrii Nakryiko
986dec18 48f5aef4

+14 -14
+1 -1
tools/bpf/bpftool/Documentation/bpftool-btf.rst
··· 13 13 **bpftool** [*OPTIONS*] **btf** *COMMAND* 14 14 15 15 *OPTIONS* := { { **-j** | **--json** } [{ **-p** | **--pretty** }] | {**-d** | **--debug** } | 16 - { **-B** | **--base-btf** } } 16 + { **-B** | **--base-btf** } } 17 17 18 18 *COMMANDS* := { **dump** | **help** } 19 19
+1 -1
tools/bpf/bpftool/Documentation/bpftool-cgroup.rst
··· 13 13 **bpftool** [*OPTIONS*] **cgroup** *COMMAND* 14 14 15 15 *OPTIONS* := { { **-j** | **--json** } [{ **-p** | **--pretty** }] | { **-d** | **--debug** } | 16 - { **-f** | **--bpffs** } } 16 + { **-f** | **--bpffs** } } 17 17 18 18 *COMMANDS* := 19 19 { **show** | **list** | **tree** | **attach** | **detach** | **help** }
+1 -1
tools/bpf/bpftool/Documentation/bpftool-gen.rst
··· 13 13 **bpftool** [*OPTIONS*] **gen** *COMMAND* 14 14 15 15 *OPTIONS* := { { **-j** | **--json** } [{ **-p** | **--pretty** }] | { **-d** | **--debug** } | 16 - { **-L** | **--use-loader** } } 16 + { **-L** | **--use-loader** } } 17 17 18 18 *COMMAND* := { **object** | **skeleton** | **help** } 19 19
+1 -1
tools/bpf/bpftool/Documentation/bpftool-link.rst
··· 13 13 **bpftool** [*OPTIONS*] **link** *COMMAND* 14 14 15 15 *OPTIONS* := { { **-j** | **--json** } [{ **-p** | **--pretty** }] | { **-d** | **--debug** } | 16 - { **-f** | **--bpffs** } | { **-n** | **--nomount** } } 16 + { **-f** | **--bpffs** } | { **-n** | **--nomount** } } 17 17 18 18 *COMMANDS* := { **show** | **list** | **pin** | **help** } 19 19
+3 -3
tools/bpf/bpftool/Documentation/bpftool-map.rst
··· 13 13 **bpftool** [*OPTIONS*] **map** *COMMAND* 14 14 15 15 *OPTIONS* := { { **-j** | **--json** } [{ **-p** | **--pretty** }] | { **-d** | **--debug** } | 16 - { **-f** | **--bpffs** } | { **-n** | **--nomount** } } 16 + { **-f** | **--bpffs** } | { **-n** | **--nomount** } } 17 17 18 18 *COMMANDS* := 19 - { **show** | **list** | **create** | **dump** | **update** | **lookup** | **getnext** 20 - | **delete** | **pin** | **help** } 19 + { **show** | **list** | **create** | **dump** | **update** | **lookup** | **getnext** | 20 + **delete** | **pin** | **help** } 21 21 22 22 MAP COMMANDS 23 23 =============
+4 -4
tools/bpf/bpftool/Documentation/bpftool-prog.rst
··· 13 13 **bpftool** [*OPTIONS*] **prog** *COMMAND* 14 14 15 15 *OPTIONS* := { { **-j** | **--json** } [{ **-p** | **--pretty** }] | { **-d** | **--debug** } | 16 - { **-f** | **--bpffs** } | { **-m** | **--mapcompat** } | { **-n** | **--nomount** } | 17 - { **-L** | **--use-loader** } } 16 + { **-f** | **--bpffs** } | { **-m** | **--mapcompat** } | { **-n** | **--nomount** } | 17 + { **-L** | **--use-loader** } } 18 18 19 19 *COMMANDS* := 20 - { **show** | **list** | **dump xlated** | **dump jited** | **pin** | **load** 21 - | **loadall** | **help** } 20 + { **show** | **list** | **dump xlated** | **dump jited** | **pin** | **load** | 21 + **loadall** | **help** } 22 22 23 23 PROG COMMANDS 24 24 =============
+3 -3
tools/bpf/bpftool/Documentation/bpftool.rst
··· 19 19 *OBJECT* := { **map** | **program** | **cgroup** | **perf** | **net** | **feature** } 20 20 21 21 *OPTIONS* := { { **-V** | **--version** } | 22 - { **-j** | **--json** } [{ **-p** | **--pretty** }] | { **-d** | **--debug** } } 22 + { **-j** | **--json** } [{ **-p** | **--pretty** }] | { **-d** | **--debug** } } 23 23 24 24 *MAP-COMMANDS* := 25 25 { **show** | **list** | **create** | **dump** | **update** | **lookup** | **getnext** | 26 - **delete** | **pin** | **event_pipe** | **help** } 26 + **delete** | **pin** | **event_pipe** | **help** } 27 27 28 28 *PROG-COMMANDS* := { **show** | **list** | **dump jited** | **dump xlated** | **pin** | 29 - **load** | **attach** | **detach** | **help** } 29 + **load** | **attach** | **detach** | **help** } 30 30 31 31 *CGROUP-COMMANDS* := { **show** | **list** | **attach** | **detach** | **help** } 32 32