Re: [PATCH v2 1/3] staging: rtl8192e: renamed variable nMcsRate

[Dan Carpenter]

On Tue, Nov 28, 2023 at 09:20:25AM -0500, Gary Rookard wrote:
> v2: Renamed from CamelCase to Snake case the variable nMcsRate, and
  ^^^^

> additionally removed the Hungarian notation of (n) that [v1] did not.
                                                           ^^^
Delete this stuff.  We are not going to merge v1 so we don't want to
mention it in the permanent git log.

> nMcsRate -> mcs_rate
> 
> Linux kernel coding style (cleanup), checkpatch Avoid CamelCase.
> Driver/module rtl8192e compiles.
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This is taken as a given.  Don't put this in the commit message.

> 
> Signed-off-by: Gary Rookard <garyrookard@xxxxxxxxxxxx>

This commit message is kind of bad.  A better commit message would be:

"Checkpatch complains about the "nMcsRate" variable because it is
CamelCase.  Rename it to "mcs_rate"".

There are a bunch of ways you could write the commit message but my
proposal is acceptable.  If you want to mention Hungarian notation you
can.  "Plus it's Hungarian notation and Hungarian notation is rubbish."
but that's not necessary.  If you're going to rename the variable then
we just consider that you're going to look at the context and the
surrounding code and pick a good consistent variable.

regards,
dan carpenter