linux-kernel - Re: [PATCH v6] staging: sm750: Rename sm750_hw_cursor_* functions to snake

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: <1854722.CQOukoFCf9@suse>
Date:   Wed, 29 Mar 2023 16:30:54 +0200
From:   "Fabio M. De Francesco" <fmdefrancesco@...il.com>
To:     Kloudifold <cloudifold.3125@...il.com>
Cc:     Sudip Mukherjee <sudipm.mukherjee@...il.com>,
        Teddy Wang <teddy.wang@...iconmotion.com>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        linux-fbdev@...r.kernel.org, devel@...verdev.osuosl.org,
        linux-kernel@...r.kernel.org, outreachy@...ts.linux.dev,
        linux-staging@...ts.linux.dev, alison.schofield@...el.com
Subject: Re: [PATCH v6] staging: sm750: Rename sm750_hw_cursor_* functions to
 snake_case

On mercoledì 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.
> 
> - sm750_hw_cursor_setSize  => sm750_hw_cursor_set_size
> - sm750_hw_cursor_setPos   => sm750_hw_cursor_set_pos
> - sm750_hw_cursor_setColor => sm750_hw_cursor_set_color
> - sm750_hw_cursor_setData  => sm750_hw_cursor_set_data
> - sm750_hw_cursor_setData2 => sm750_hw_cursor_set_data2
> 
> Reported-by: kernel test robot <lkp@...el.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 
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 style 
guide wants developers to avoid camel-case symbols.

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

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

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

> Signed-off-by: Kloudifold <cloudifold.3125@...il.com>
> 

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

> ---
> Changes in v6:
> - Include missed recipients in v5, no functional change to the code
> 
> Changes in v5:
> - Include missed recipients in v4, no functional change to the code
> 
> Changes in v4:
> - Update the commit msg (Deepak)
> - Use tabs replace 8 spaces
> 
> This v4 patch was prompted by 2 errors, 2 warnings and 1 checks reported
> by the scripts/checkpatch.pl, which detected the style problem.
> 
> 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)
> 
> 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 made 
mistakes with v1 and that v2 is for fixing them.

Therefore, give credit here to the Robot:

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

Thanks,

Fabio

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