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

diff --git a/tools/bpf/bpftool/Documentation/bpftool-btf.rst b/tools/bpf/bpftool/Documentation/bpftool-btf.rst
index 88b28aa7431f62b63987f493d6458d4501bc578f..4425d942dd39a45c76d745db96890550a3b5768b 100644 (file)
--- a/tools/bpf/bpftool/Documentation/bpftool-btf.rst
+++ b/tools/bpf/bpftool/Documentation/bpftool-btf.rst
@@ -13,7 +13,7 @@ SYNOPSIS
        **bpftool** [*OPTIONS*] **btf** *COMMAND*
 
        *OPTIONS* := { { **-j** | **--json** } [{ **-p** | **--pretty** }] | {**-d** | **--debug** } |
-               { **-B** | **--base-btf** } }
+       { **-B** | **--base-btf** } }
 
        *COMMANDS* := { **dump** | **help** }
 

diff --git a/tools/bpf/bpftool/Documentation/bpftool-cgroup.rst b/tools/bpf/bpftool/Documentation/bpftool-cgroup.rst
index 3e4395eede4f7b9894159e1da2bb77a25bd1d32c..13a217a2503d84f53d37aad92d27d85f187bd7e3 100644 (file)
--- a/tools/bpf/bpftool/Documentation/bpftool-cgroup.rst
+++ b/tools/bpf/bpftool/Documentation/bpftool-cgroup.rst
@@ -13,7 +13,7 @@ SYNOPSIS
        **bpftool** [*OPTIONS*] **cgroup** *COMMAND*
 
        *OPTIONS* := { { **-j** | **--json** } [{ **-p** | **--pretty** }] | { **-d** | **--debug** } |
-               { **-f** | **--bpffs** } }
+       { **-f** | **--bpffs** } }
 
        *COMMANDS* :=
        { **show** | **list** | **tree** | **attach** | **detach** | **help** }

diff --git a/tools/bpf/bpftool/Documentation/bpftool-gen.rst b/tools/bpf/bpftool/Documentation/bpftool-gen.rst
index 2ef2f2df0279963caf5bae842b38a142e639a666..2a137f8a4cea0c7451027c6e9eab5c3f23c0327b 100644 (file)
--- a/tools/bpf/bpftool/Documentation/bpftool-gen.rst
+++ b/tools/bpf/bpftool/Documentation/bpftool-gen.rst
@@ -13,7 +13,7 @@ SYNOPSIS
        **bpftool** [*OPTIONS*] **gen** *COMMAND*
 
        *OPTIONS* := { { **-j** | **--json** } [{ **-p** | **--pretty** }] | { **-d** | **--debug** } |
-               { **-L** | **--use-loader** } }
+       { **-L** | **--use-loader** } }
 
        *COMMAND* := { **object** | **skeleton** | **help** }
 

diff --git a/tools/bpf/bpftool/Documentation/bpftool-link.rst b/tools/bpf/bpftool/Documentation/bpftool-link.rst
index 0de90f086238c6cfc71b8a8fdeb9893639bfbcb8..9434349636a5eb600735e1fdc6f10f3319f06028 100644 (file)
--- a/tools/bpf/bpftool/Documentation/bpftool-link.rst
+++ b/tools/bpf/bpftool/Documentation/bpftool-link.rst
@@ -13,7 +13,7 @@ SYNOPSIS
        **bpftool** [*OPTIONS*] **link** *COMMAND*
 
        *OPTIONS* := { { **-j** | **--json** } [{ **-p** | **--pretty** }] | { **-d** | **--debug** } |
-               { **-f** | **--bpffs** } | { **-n** | **--nomount** } }
+       { **-f** | **--bpffs** } | { **-n** | **--nomount** } }
 
        *COMMANDS* := { **show** | **list** | **pin** | **help** }
 

diff --git a/tools/bpf/bpftool/Documentation/bpftool-map.rst b/tools/bpf/bpftool/Documentation/bpftool-map.rst
index d0c4abe08abab68e44c0d17492609179dc3fd62c..1445cadc15d4cba8646f457e176a1006d65e5286 100644 (file)
--- a/tools/bpf/bpftool/Documentation/bpftool-map.rst
+++ b/tools/bpf/bpftool/Documentation/bpftool-map.rst
@@ -13,11 +13,11 @@ SYNOPSIS
        **bpftool** [*OPTIONS*] **map** *COMMAND*
 
        *OPTIONS* := { { **-j** | **--json** } [{ **-p** | **--pretty** }] | { **-d** | **--debug** } |
-               { **-f** | **--bpffs** } | { **-n** | **--nomount** } }
+       { **-f** | **--bpffs** } | { **-n** | **--nomount** } }
 
        *COMMANDS* :=
-       { **show** | **list** | **create** | **dump** | **update** | **lookup** | **getnext**
-       | **delete** | **pin** | **help** }
+       { **show** | **list** | **create** | **dump** | **update** | **lookup** | **getnext** |
+       **delete** | **pin** | **help** }
 
 MAP COMMANDS
 =============

diff --git a/tools/bpf/bpftool/Documentation/bpftool-prog.rst b/tools/bpf/bpftool/Documentation/bpftool-prog.rst
index 91608cb7e44a027771c00e184e448f59558fb77d..f27265bd589b48d7bbb918c04f3626cbdfc50b2d 100644 (file)
--- a/tools/bpf/bpftool/Documentation/bpftool-prog.rst
+++ b/tools/bpf/bpftool/Documentation/bpftool-prog.rst
@@ -13,12 +13,12 @@ SYNOPSIS
        **bpftool** [*OPTIONS*] **prog** *COMMAND*
 
        *OPTIONS* := { { **-j** | **--json** } [{ **-p** | **--pretty** }] | { **-d** | **--debug** } |
-               { **-f** | **--bpffs** } | { **-m** | **--mapcompat** } | { **-n** | **--nomount** } |
-               { **-L** | **--use-loader** } }
+       { **-f** | **--bpffs** } | { **-m** | **--mapcompat** } | { **-n** | **--nomount** } |
+       { **-L** | **--use-loader** } }
 
        *COMMANDS* :=
-       { **show** | **list** | **dump xlated** | **dump jited** | **pin** | **load**
-       | **loadall** | **help** }
+       { **show** | **list** | **dump xlated** | **dump jited** | **pin** | **load** |
+       **loadall** | **help** }
 
 PROG COMMANDS
 =============

diff --git a/tools/bpf/bpftool/Documentation/bpftool.rst b/tools/bpf/bpftool/Documentation/bpftool.rst
index bb23f55bb05ad827d0a0664576a964f9969a4fd9..8ac86565c501eca0854c23679cdb5363deeff4f8 100644 (file)
--- 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** }