lkml.org 
[lkml]   [2022]   [Jan]   [24]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH 5.15 764/846] bpftool: Fix indent in option lists in the documentation
    Date
    From: Quentin Monnet <quentin@isovalent.com>

    commit 986dec18bbf41f50edc2e0aa4ac5ef8e0f64f328 upstream.

    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
    Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
    ---
    tools/bpf/bpftool/Documentation/bpftool-btf.rst | 2 +-
    tools/bpf/bpftool/Documentation/bpftool-cgroup.rst | 2 +-
    tools/bpf/bpftool/Documentation/bpftool-gen.rst | 2 +-
    tools/bpf/bpftool/Documentation/bpftool-link.rst | 2 +-
    tools/bpf/bpftool/Documentation/bpftool-map.rst | 6 +++---
    tools/bpf/bpftool/Documentation/bpftool-prog.rst | 8 ++++----
    tools/bpf/bpftool/Documentation/bpftool.rst | 6 +++---
    7 files changed, 14 insertions(+), 14 deletions(-)

    --- 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** }

    --- 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** }
    --- 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** }

    --- 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** }

    --- 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
    =============
    --- 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
    =============
    --- 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** }


    \
     
     \ /
      Last update: 2022-01-25 00:46    [W:5.113 / U:0.020 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site