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]

Message-ID: <062aa21a-f14a-faf7-adf1-cd2e5023fc90@netronome.com>
Date:   Fri, 24 May 2019 10:14:12 +0100
From:   Quentin Monnet <quentin.monnet@...ronome.com>
To:     Andrii Nakryiko <andriin@...com>, andrii.nakryiko@...il.com,
        netdev@...r.kernel.org, bpf@...r.kernel.org, ast@...com,
        daniel@...earbox.net, kernel-team@...com
Subject: Re: [PATCH v2 bpf-next 11/12] bpftool/docs: add description of btf
 dump C option

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!).

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

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