netdev - Re: [PATCH bpf-next 2/4] tools: bpftool: minor fixes for documentation

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] [day] [month] [year] [list]

Message-ID: <6671c199-713d-fb5f-b6d1-11187301e6e4@isovalent.com>
Date:   Mon, 11 May 2020 17:05:46 +0100
From:   Quentin Monnet <quentin@...valent.com>
To:     Daniel Borkmann <daniel@...earbox.net>,
        Alexei Starovoitov <ast@...nel.org>
Cc:     bpf@...r.kernel.org, netdev@...r.kernel.org
Subject: Re: [PATCH bpf-next 2/4] tools: bpftool: minor fixes for
 documentation

2020-05-11 17:25 UTC+0200 ~ Daniel Borkmann <daniel@...earbox.net>
> On 5/11/20 3:38 PM, Quentin Monnet wrote:
>> Bring minor improvements to bpftool documentation. Fix or harmonise
>> formatting, update map types (including in interactive help), improve
>> description for "map create", fix a build warning due to a missing line
>> after the double-colon for the "bpftool prog profile" example,
>> complete/harmonise/sort the list of related bpftool man pages in
>> footers.
>>
>> Signed-off-by: Quentin Monnet <quentin@...valent.com>
> [...]
>> @@ -116,24 +123,24 @@ DESCRIPTION
>>             receiving events if it installed its rings earlier.
>>         **bpftool map peek**  *MAP*
>> -          Peek next **value** in the queue or stack.
>> +          Peek next value in the queue or stack.
> 
> Looks great overall. Was about to push, but noticed above inconsistency.
> Should this
> be `*VALUE*` as well?

Hm I don't think so, there is no "VALUE" passed on the command line in
that case.

But then I should probably have removed mark-up on "value" for "bpftool
map pop|dequeue", instead of changing it, as those commands do not use
any value on the command line either. Thanks for the review, I'll send a
v2 with that change.

> 
>>       **bpftool map push**  *MAP* **value** *VALUE*
>> -          Push **value** onto the stack.
>> +          Push *VALUE* onto the stack.
>>         **bpftool map pop**  *MAP*
>> -          Pop and print **value** from the stack.
>> +          Pop and print *VALUE* from the stack.
>>         **bpftool map enqueue**  *MAP* **value** *VALUE*
>> -          Enqueue **value** into the queue.
>> +          Enqueue *VALUE* into the queue.
>>         **bpftool map dequeue**  *MAP*
>> -          Dequeue and print **value** from the queue.
>> +          Dequeue and print *VALUE* from the queue.