2019-05-24 10:25 UTC-0700 ~ Andrii Nakryiko <[email protected]>
> On Fri, May 24, 2019 at 2:14 AM Quentin Monnet
> <[email protected]> wrote:
>>
>> 2019-05-23 13:42 UTC-0700 ~ Andrii Nakryiko <[email protected]>
>>> Document optional **c** option for btf dump subcommand.
>>>
>>> Cc: Quentin Monnet <[email protected]>
>>> Signed-off-by: Andrii Nakryiko <[email protected]>
>>> ---
>>> 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.
I can relate :). On my (vim) setup, I can usually hit Ctrl+V then <Tab>
to insert tabulations in that case.
>
>>
>>> | *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).
Thanks!
>
>>
>>> **bpftool btf help**
>>> Print short help message.
>>>
>>>
>>
