Re: [PATCH bpf-next 2/3] tools: bpftool: include common options from separate file

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Fri, Sep 4, 2020 at 1:57 PM Quentin Monnet <quentin@xxxxxxxxxxxxx> wrote:
>
> 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@xxxxxxxxxxxxx>
> ---

Acked-by: Andrii Nakryiko <andriin@xxxxxx>

>  tools/bpf/bpftool/Documentation/Makefile      |  2 +-
>  .../bpf/bpftool/Documentation/bpftool-btf.rst | 17 +------------
>  .../bpftool/Documentation/bpftool-cgroup.rst  | 17 +------------
>  .../bpftool/Documentation/bpftool-feature.rst | 17 +------------
>  .../bpf/bpftool/Documentation/bpftool-gen.rst | 17 +------------
>  .../bpftool/Documentation/bpftool-iter.rst    | 11 +--------
>  .../bpftool/Documentation/bpftool-link.rst    | 17 +------------
>  .../bpf/bpftool/Documentation/bpftool-map.rst | 17 +------------
>  .../bpf/bpftool/Documentation/bpftool-net.rst | 17 +------------
>  .../bpftool/Documentation/bpftool-perf.rst    | 17 +------------
>  .../bpftool/Documentation/bpftool-prog.rst    | 18 +-------------
>  .../Documentation/bpftool-struct_ops.rst      | 18 +-------------
>  tools/bpf/bpftool/Documentation/bpftool.rst   | 24 +------------------
>  .../bpftool/Documentation/common_options.rst  | 22 +++++++++++++++++
>  14 files changed, 35 insertions(+), 196 deletions(-)
>  create mode 100644 tools/bpf/bpftool/Documentation/common_options.rst
>

[...]



[Index of Archives]     [Linux Samsung SoC]     [Linux Rockchip SoC]     [Linux Actions SoC]     [Linux for Synopsys ARC Processors]     [Linux NFS]     [Linux NILFS]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]


  Powered by Linux