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

[Przemek Kitszel <przemyslaw.kitszel@intel.com>]

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.