Re: [PATCH] bpf, docs: document BPF_MAP_TYPE_HASH and variants

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

 



On 7/14/22 12:51, Daniel Müller wrote:
> On Thu, Jul 14, 2022 at 08:12:57AM +0700, Bagas Sanjaya wrote:
>> On 7/14/22 04:16, Donald Hunter wrote:
>>> This commit adds documentation for BPF_MAP_TYPE_HASH including kernel
>>> version introduced, usage and examples. It also documents
>>> BPF_MAP_TYPE_PERCPU_HASH, BPF_MAP_TYPE_LRU_HASH and
>>> BPF_MAP_TYPE_LRU_PERCPU_HASH which are similar.
>>>
>>
>> Please, please use imperative mood instead for patch description
>> (that is, better write like "document BPF_MAP_TYPE_* types").
> 
> Can you elaborate why you make that recommendation, please?
> 

>From Documentation/process/submitting-patches.rst:

> Describe your changes in imperative mood, e.g. "make xyzzy do frotz"
> instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy
> to do frotz", as if you are giving orders to the codebase to change
> its behaviour.

The recommendation above is from commit 74a475acea4945
("SubmittingPatches: add style recommendation to use imperative descriptions")

Thanks.

-- 
An old man doll... just what I always wanted! - Clara



[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