Re: [dpdk-dev] [EXT] Re: [PATCH v3] devtools: add acronyms in dictionary for commit checks

[Ferruh Yigit <ferruh.yigit@intel.com>]

On 9/17/2021 5:15 PM, Thomas Monjalon wrote:
> 17/09/2021 16:53, Ashwin Sekhar Thalakalath Kottilveetil:
>> From: Thomas Monjalon <thomas@monjalon.net>
>>> 17/09/2021 15:54, Ashwin Sekhar Thalakalath Kottilveetil:
>>>> From: Thomas Monjalon <thomas@monjalon.net>
>>>>> 17/09/2021 12:58, Ashwin Sekhar T K:
>>>>>> Update word list with Marvell specific acronyms.
> [...]
>>> Please add details in the commit log so we understand they are Marvell
>>> acronyms.
>> Commit log already mentions these are Marvell specific acronyms. I did not
>> add explanation for each of them as this would make the message too long.
> 
> Oh yes, I missed it, sorry.
> 
>>> One more question: why is useful to add? Some people forget uppercases?
>>
>> Upper case is desired but not really mandatory. This was a suggestion put
>> forth to me In one of the reviews.
>> https://patches.dpdk.org/project/dpdk/patch/20210830135231.2610152-1-asekhar@marvell.com/
>>
>> I can abandon this change if you feel it is not appropriate to put many
>> device specific acronyms in the top level word list.
> 
> No strong opinion, but I think the patch is OK.
> David, Ferruh, opinions?
> 

Yes this is suggested to be sure acronyms are uppercase in the patch title.

But if an issue can be described in generic concepts, I am for using them to
instead of using device specific acronyms, to make commit logs less cryptic.
Like 'NIC' should be used instead of 'NIX'.

Similarly we can try to use long version of CQ/SQ/RQ, although we may need to
use them because of limited title length time to time.

Rest seems device specific abbreviations we may not escape to use them, so they
are OK to me.