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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



2020-05-11 17:25 UTC+0200 ~ Daniel Borkmann <daniel@xxxxxxxxxxxxx>
> 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@xxxxxxxxxxxxx>
> [...]
>> @@ -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.



[Index of Archives]     [Linux Samsung SoC]     [Linux Rockchip SoC]     [Linux Actions SoC]     [Linux for Synopsys ARC Processors]     [Linux NFS]     [Linux NILFS]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]


  Powered by Linux