From: Dan Carpenter <dan.carpenter@linaro.org>
To: Gary Rookard <garyrookard@fastmail.org>
Cc: gregkh@linuxfoundation.org, philipp.g.hortmann@gmail.com,
linux-staging@lists.linux.dev, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2 1/3] staging: rtl8192e: renamed variable nMcsRate
Date: Tue, 28 Nov 2023 17:30:36 +0300 [thread overview]
Message-ID: <acc04154-6604-4cd1-a6cf-58d89d6798e0@suswa.mountain> (raw)
In-Reply-To: <20231128142027.15617-2-garyrookard@fastmail.org>
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@fastmail.org>
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
next prev parent reply other threads:[~2023-11-28 14:30 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-11-28 14:20 [PATCH v2 0/3] staging: rtl8192e: patch series renames (3) different variables Gary Rookard
2023-11-28 14:20 ` [PATCH v2 1/3] staging: rtl8192e: renamed variable nMcsRate Gary Rookard
2023-11-28 14:30 ` Dan Carpenter [this message]
2023-11-28 14:38 ` Dan Carpenter
2023-11-28 14:20 ` [PATCH v2 2/3] staging: rtl8192e: renamed variable bCurBW40MHz Gary Rookard
2023-11-28 14:20 ` [PATCH v2 3/3] staging: rtl8192e: renamed variable nDataRate Gary Rookard
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=acc04154-6604-4cd1-a6cf-58d89d6798e0@suswa.mountain \
--to=dan.carpenter@linaro.org \
--cc=garyrookard@fastmail.org \
--cc=gregkh@linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-staging@lists.linux.dev \
--cc=philipp.g.hortmann@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®