Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   "Fabio M. De Francesco" <fmdefrancesco@gmail.com>
To:     Kloudifold <cloudifold.3125@gmail.com>
Cc:     Sudip Mukherjee <sudipm.mukherjee@gmail.com>,
        Teddy Wang <teddy.wang@siliconmotion.com>,
        Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        linux-fbdev@vger.kernel.org, devel@driverdev.osuosl.org,
        linux-kernel@vger.kernel.org, outreachy@lists.linux.dev,
        linux-staging@lists.linux.dev, alison.schofield@intel.com
Subject: Re: [PATCH v6] staging: sm750: Rename sm750_hw_cursor_* functions to
 snake_case
Date:   Wed, 29 Mar 2023 16:30:54 +0200
Message-ID: <1854722.CQOukoFCf9@suse>
In-Reply-To: <ZCQeyWW3+d7+qT+b@CloudiRingWorld>
References: <ZCQeyWW3+d7+qT+b@CloudiRingWorld>
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Content-Type: text/plain; charset="iso-8859-1"
Precedence: bulk

On mercoled=EC 29 marzo 2023 13:27:04 CEST Kloudifold wrote:
> sm750 driver has sm750_hw_cursor_* functions, which are named in
> camelcase. Rename them to snake case to follow the function naming
> convention.
>=20
> - sm750_hw_cursor_setSize  =3D> sm750_hw_cursor_set_size
> - sm750_hw_cursor_setPos   =3D> sm750_hw_cursor_set_pos
> - sm750_hw_cursor_setColor =3D> sm750_hw_cursor_set_color
> - sm750_hw_cursor_setData  =3D> sm750_hw_cursor_set_data
> - sm750_hw_cursor_setData2 =3D> sm750_hw_cursor_set_data2
>=20
> Reported-by: kernel test robot <lkp@intel.com>
> Link:
> https://lore.kernel.org/oe-kbuild-all/202303110849.X24WnHnM-lkp@intel.com/

Delete the last two lines.

As Greg made you notice, it was not the Kernel Test Robot that had reported=
=20
you an issue for which you decided to make a patch to fix it.

The reason you made this patch is because you know that the Linux kernel st=
yle=20
guide wants developers to avoid camel-case symbols.

Before your "Signed-off-by" tag, you should only credit those tools and/or=
=20
services (checkpatch.pl, Coccinelle, Smatch, Syzkaller/Syzbot, GCC, Clang, =
and=20
so on) that had noticed that Linux has a problem that predates the first=20
version of your patch and that your first version has the purpose to fix th=
at=20
problem.

You made this patch because _checkpatch_ had reported issues with camel-cas=
e=20
improper use, so you decided to convert some names to snake-case. You are=20
invited to credit only _checkpatch_ for you patch ("Reported by=20
checkpatch.pl.").

That credit is part of the commit message so, when you credit that tool, pu=
t a=20
blank line after the credit and before the "Signed-off-by" tag.=20

> Signed-off-by: Kloudifold <cloudifold.3125@gmail.com>
>=20

Instead, you should delete this blank line after your sign.

> ---
> Changes in v6:
> - Include missed recipients in v5, no functional change to the code
>=20
> Changes in v5:
> - Include missed recipients in v4, no functional change to the code
>=20
> Changes in v4:
> - Update the commit msg (Deepak)
> - Use tabs replace 8 spaces
>=20
> This v4 patch was prompted by 2 errors, 2 warnings and 1 checks reported
> by the scripts/checkpatch.pl, which detected the style problem.
>=20
> Changes in v3:
> - Add this changelog (Philipp)
> - Move lkp tags and link to the correct location in commit log (Alison)
> - Update the commit msg (Philip)
> - Update the commit log (Bagas, Julia)
>=20
> Changes in v2:
> - Use new function names in call sites (LKP)

This is the place to credit the Kernel Test Robot for noticing that you mad=
e=20
mistakes with v1 and that v2 is for fixing them.

Therefore, give credit here to the Robot:

Reported-by: kernel test robot <lkp@intel.com>
> Link:
> https://lore.kernel.org/oe-kbuild-all/202303110849.X24WnHnM-lkp@intel.com/

Thanks,

=46abio

P.S.: Someone suggested to drop the "sm750_" prefix. I don't think you shou=
ld=20
do anything like this because I don't see "static" functions prefixed by=20
"sm750_" in your patch. However, later you may check if they can be "static=
"=20
and, if so, drop the prefix and make them "static" (in a follow up patch). =
=20