linux-kernel - Re: [PATCH net-next v04 1/1] hinic3: module initialization and tx/rx logic

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: <b001ae7f-d250-4f3b-8d2b-29b6c5adb642@intel.com>
Date: Thu, 23 Jan 2025 10:32:56 +0100
From: Przemek Kitszel <przemyslaw.kitszel@...el.com>
To: Gur Stavi <gur.stavi@...wei.com>
CC: <andrew+netdev@...n.ch>, <cai.huoqing@...ux.dev>, <corbet@....net>,
	<davem@...emloft.net>, <edumazet@...gle.com>, <gongfan1@...wei.com>,
	<guoxin09@...wei.com>, <helgaas@...nel.org>, <horms@...nel.org>,
	<kuba@...nel.org>, <linux-doc@...r.kernel.org>,
	<linux-kernel@...r.kernel.org>, <luosifu@...wei.com>,
	<meny.yossefi@...wei.com>, <netdev@...r.kernel.org>, <pabeni@...hat.com>,
	<shenchenyang1@...ilicon.com>, <shijing34@...wei.com>, <sumang@...vell.com>,
	<wulike1@...wei.com>, <zhoushuai28@...wei.com>
Subject: Re: [PATCH net-next v04 1/1] hinic3: module initialization and tx/rx
 logic

On 1/23/25 09:20, Gur Stavi wrote:
>>>>> Auxiliary driver registration.
>>>>> Net device_ops registration but open/stop are empty stubs.
>>>>> tx/rx logic.
>>>>
>>>> Take care for spelling: Tx/Rx; HW (just below).
>>>
>>> Please elaborate. Spelling of what?
>>
>> In all code comments and commit messages the acronyms and abbreviations
>> have their proper spelling, like "Tx", "Rx", "HW', "SW", "ID".
>>
>> of course lowercase names are still allowed for variables/fields
>>
> 
> Grepped drivers/net/ethernet (whole word only):
> 
> hw 34681   HW 3708   Hw  170
> sw  1198   SW  675   Sw    3
> rx  5913   RX 4042   Rx 4042
> tx  5424   TX 4095   Tx 4907
> id  5545   ID 1967   Id   56
> 
> I don't know a quick way to separate variables from comments but I
> believe that there are very few hw and sw variables and most tx, rx
> related variables will have some prefix or suffix so lots of the
> whole-word-only come from comments.
> Can we agree that while Hw, Sw and Id are improper, the remaining
> forms are acceptable?

"tx", "rx", "hw" are very common variable/field names, "sw" could be
also a shortcut for "switch"

If you want to argue, the stats should be only for the comments, and
excluding things like "@hw" from the kdoc.
But then, anyway, "current code misspells a lot" is not a reason to
continue the practice.

> 
>>>
>>>>
>>>>>
>>>>> All major data structures of the driver are fully introduced with the
>>>>> code that uses them but without their initialization code that requires
>>>>> management interface with the hw.