Commit ea379b3c authored by Rameez Rehman's avatar Rameez Rehman Committed by Daniel Borkmann
Browse files

bpftool: Remove useless emphasis on command description in man pages 



As it turns out, the terms in definition lists in the rST file are
already rendered with bold-ish formatting when generating the man pages;
all double-star sequences we have in the commands for the command
description are unnecessary, and can be removed to make the
documentation easier to read.

The rST files were automatically processed with:

    sed -i '/DESCRIPTION/,/OPTIONS/ { /^\*/ s/\*\*//g }' b*.rst

Signed-off-by: default avatarRameez Rehman <rameezrehman408@hotmail.com>
Signed-off-by: default avatarQuentin Monnet <qmo@kernel.org>
Signed-off-by: default avatarDaniel Borkmann <daniel@iogearbox.net>
Link: https://lore.kernel.org/bpf/20240331200346.29118-3-qmo@kernel.org
parent f7b68543

tools/bpf/bpftool/Documentation/bpftool-btf.rst

+3 −3
Original line number Diff line number Diff line
@@ -34,7 +34,7 @@ BTF COMMANDS 


DESCRIPTION

===========

**bpftool btf { show | list }** [**id** *BTF_ID*]

bpftool btf { show | list } [id *BTF_ID*]

    Show information about loaded BTF objects. If a BTF ID is specified, show

    information only about given BTF object, otherwise list all BTF objects

    currently loaded on the system.
@@ -43,7 +43,7 @@ DESCRIPTION 
    that hold open file descriptors (FDs) against BTF objects. On such kernels

    bpftool will automatically emit this information as well.



**bpftool btf dump** *BTF_SRC*

bpftool btf dump *BTF_SRC*

    Dump BTF entries from a given *BTF_SRC*.



    When **id** is specified, BTF object with that ID will be loaded and all
@@ -65,7 +65,7 @@ DESCRIPTION 
    **format** option can be used to override default (raw) output format. Raw

    (**raw**) or C-syntax (**c**) output formats are supported.



**bpftool btf help**

bpftool btf help

    Print short help message.



OPTIONS

tools/bpf/bpftool/Documentation/bpftool-cgroup.rst

+5 −5
Original line number Diff line number Diff line
@@ -49,7 +49,7 @@ CGROUP COMMANDS 


DESCRIPTION

===========

**bpftool cgroup { show | list }** *CGROUP* [**effective**]

bpftool cgroup { show | list } *CGROUP* [effective]

    List all programs attached to the cgroup *CGROUP*.



    Output will start with program ID followed by attach type, attach flags and
@@ -59,7 +59,7 @@ DESCRIPTION 
    for events within a cgroup. This includes inherited along with attached

    ones.



**bpftool cgroup tree** [*CGROUP_ROOT*] [**effective**]

bpftool cgroup tree [*CGROUP_ROOT*] [effective]

    Iterate over all cgroups in *CGROUP_ROOT* and list all attached programs.

    If *CGROUP_ROOT* is not specified, bpftool uses cgroup v2 mountpoint.
@@ -71,7 +71,7 @@ DESCRIPTION 
    for events within a cgroup. This includes inherited along with attached

    ones.



**bpftool cgroup attach** *CGROUP* *ATTACH_TYPE* *PROG* [*ATTACH_FLAGS*]

bpftool cgroup attach *CGROUP* *ATTACH_TYPE* *PROG* [*ATTACH_FLAGS*]

    Attach program *PROG* to the cgroup *CGROUP* with attach type *ATTACH_TYPE*

    and optional *ATTACH_FLAGS*.
@@ -126,10 +126,10 @@ DESCRIPTION 
    **getsockname_unix** call to getsockname(2) for a unix socket (since 6.7);

    **sock_release** closing an userspace inet socket (since 5.9).



**bpftool cgroup detach** *CGROUP* *ATTACH_TYPE* *PROG*

bpftool cgroup detach *CGROUP* *ATTACH_TYPE* *PROG*

    Detach *PROG* from the cgroup *CGROUP* and attach type *ATTACH_TYPE*.



**bpftool prog help**

bpftool prog help

    Print short help message.



OPTIONS

tools/bpf/bpftool/Documentation/bpftool-feature.rst

+4 −4
Original line number Diff line number Diff line
@@ -32,7 +32,7 @@ FEATURE COMMANDS 


DESCRIPTION

===========

**bpftool feature probe** [**kernel**] [**full**] [**macros** [**prefix** *PREFIX*]]

bpftool feature probe [kernel] [full] [macros [prefix *PREFIX*]]

    Probe the running kernel and dump a number of eBPF-related parameters, such

    as availability of the **bpf**\ () system call, JIT status, eBPF program

    types availability, eBPF helper functions availability, and more.
@@ -59,14 +59,14 @@ DESCRIPTION 
    bpftool is inadvertently run as non-root, for example. This keyword is

    unavailable if bpftool was compiled without libcap.



**bpftool feature probe dev** *NAME* [**full**] [**macros** [**prefix** *PREFIX*]]

bpftool feature probe dev *NAME* [full] [macros [prefix *PREFIX*]]

    Probe network device for supported eBPF features and dump results to the

    console.



    The keywords **full**, **macros** and **prefix** have the same role as when

    probing the kernel.



**bpftool feature list_builtins** *GROUP*

bpftool feature list_builtins *GROUP*

    List items known to bpftool. These can be BPF program types

    (**prog_types**), BPF map types (**map_types**), attach types

    (**attach_types**), link types (**link_types**), or BPF helper functions
@@ -75,7 +75,7 @@ DESCRIPTION 
    (for all object types) or from the BPF UAPI header (list of helpers). This

    can be used in scripts to iterate over BPF types or helpers.



**bpftool feature help**

bpftool feature help

    Print short help message.



OPTIONS

tools/bpf/bpftool/Documentation/bpftool-gen.rst

+5 −5
Original line number Diff line number Diff line
@@ -31,7 +31,7 @@ GEN COMMANDS 


DESCRIPTION

===========

**bpftool gen object** *OUTPUT_FILE* *INPUT_FILE* [*INPUT_FILE*...]

bpftool gen object *OUTPUT_FILE* *INPUT_FILE* [*INPUT_FILE*...]

    Statically link (combine) together one or more *INPUT_FILE*'s into a single

    resulting *OUTPUT_FILE*. All the files involved are BPF ELF object files.
@@ -48,7 +48,7 @@ DESCRIPTION 
    command) or passed directly into **libbpf** (using **bpf_object__open()**

    family of APIs).



**bpftool gen skeleton** *FILE*

bpftool gen skeleton *FILE*

    Generate BPF skeleton C header file for a given *FILE*.



    BPF skeleton is an alternative interface to existing libbpf APIs for
@@ -132,7 +132,7 @@ DESCRIPTION 
    used to fetch and update (non-read-only) data from userspace, with same

    simplicity as for BPF side.



**bpftool gen subskeleton** *FILE*

bpftool gen subskeleton *FILE*

    Generate BPF subskeleton C header file for a given *FILE*.



    Subskeletons are similar to skeletons, except they do not own the
@@ -154,7 +154,7 @@ DESCRIPTION 
      Frees the storage for the subskeleton but *does not* unload any BPF

      programs or maps.



**bpftool** **gen min_core_btf** *INPUT* *OUTPUT* *OBJECT* [*OBJECT*...]

bpftool gen min_core_btf *INPUT* *OUTPUT* *OBJECT* [*OBJECT*...]

    Generate a minimum BTF file as *OUTPUT*, derived from a given *INPUT* BTF

    file, containing all needed BTF types so one, or more, given eBPF objects

    CO-RE relocations may be satisfied.
@@ -174,7 +174,7 @@ DESCRIPTION 


    Check examples bellow for more information how to use it.



**bpftool gen help**

bpftool gen help

    Print short help message.



OPTIONS

tools/bpf/bpftool/Documentation/bpftool-iter.rst

+2 −2
Original line number Diff line number Diff line
@@ -31,7 +31,7 @@ ITER COMMANDS 


DESCRIPTION

===========

**bpftool iter pin** *OBJ* *PATH* [**map** *MAP*]

bpftool iter pin *OBJ* *PATH* [map *MAP*]

    A bpf iterator combines a kernel iterating of particular kernel data (e.g.,

    tasks, bpf_maps, etc.) and a bpf program called for each kernel data object

    (e.g., one task, one bpf_map, etc.). User space can *read* kernel iterator
@@ -48,7 +48,7 @@ DESCRIPTION 


    User can then *cat PATH* to see the bpf iterator output.



**bpftool iter help**

bpftool iter help

    Print short help message.



OPTIONS