netdev - Re: [PATCH v2 bpf-next 11/12] bpftool/docs: add description of btf dump C option

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Fri, 24 May 2019 10:25:05 -0700
From:   Andrii Nakryiko <andrii.nakryiko@...il.com>
To:     Quentin Monnet <quentin.monnet@...ronome.com>
Cc:     Andrii Nakryiko <andriin@...com>,
        Networking <netdev@...r.kernel.org>, bpf@...r.kernel.org,
        Alexei Starovoitov <ast@...com>,
        Daniel Borkmann <daniel@...earbox.net>,
        Kernel Team <kernel-team@...com>
Subject: Re: [PATCH v2 bpf-next 11/12] bpftool/docs: add description of btf
 dump C option

On Fri, May 24, 2019 at 2:14 AM Quentin Monnet
<quentin.monnet@...ronome.com> wrote:
>
> 2019-05-23 13:42 UTC-0700 ~ Andrii Nakryiko <andriin@...com>
> > Document optional **c** option for btf dump subcommand.
> >
> > Cc: Quentin Monnet <quentin.monnet@...ronome.com>
> > Signed-off-by: Andrii Nakryiko <andriin@...com>
> > ---
> >  tools/bpf/bpftool/Documentation/bpftool-btf.rst | 7 ++++++-
> >  1 file changed, 6 insertions(+), 1 deletion(-)
> >
> > diff --git a/tools/bpf/bpftool/Documentation/bpftool-btf.rst b/tools/bpf/bpftool/Documentation/bpftool-btf.rst
> > index 2dbc1413fabd..1aec7dc039e9 100644
> > --- a/tools/bpf/bpftool/Documentation/bpftool-btf.rst
> > +++ b/tools/bpf/bpftool/Documentation/bpftool-btf.rst
> > @@ -19,10 +19,11 @@ SYNOPSIS
> >  BTF COMMANDS
> >  =============
> >
> > -|    **bpftool** **btf dump** *BTF_SRC*
> > +|    **bpftool** **btf dump** *BTF_SRC* [**format** *FORMAT*]
> >  |    **bpftool** **btf help**
> >  |
> >  |    *BTF_SRC* := { **id** *BTF_ID* | **prog** *PROG* | **map** *MAP* [{**key** | **value** | **kv** | **all**}] | **file** *FILE* }
> > +|       *FORMAT* := { **raw** | **c** }
>
> Nit: This line should use a tab for indent (Do not respin just for that,
> though!).

Oh, I didn't notice that. My vim setup very aggressively refuses to
insert tabs, so I had to literaly copy/paste pieces of tabulations :)
Fixed it.

>
> >  |    *MAP* := { **id** *MAP_ID* | **pinned** *FILE* }
> >  |    *PROG* := { **id** *PROG_ID* | **pinned** *FILE* | **tag** *PROG_TAG* }
> >
> > @@ -49,6 +50,10 @@ DESCRIPTION
> >                    .BTF section with well-defined BTF binary format data,
> >                    typically produced by clang or pahole.
> >
> > +                  **format** option can be used to override default (raw)
> > +                  output format. Raw (**raw**) or C-syntax (**c**) output
> > +                  formats are supported.
> > +
>
> Other files use tabs here as well, but most of the description here
> already uses spaces, so ok.

Yeah, thanks for pointing out, fixed everything to tabs + 2 spaces, as
in other files (unclear why we have extra 2 spaces, but not going to
change that).

>
> >       **bpftool btf help**
> >                 Print short help message.
> >
> >
>