linux-kernel - Re: [PATCH v3 1/3] staging: vt6655: replace camel case b_short_slot

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]

Date:   Sat, 25 Sep 2021 11:13:17 +0200
From:   "Fabio M. De Francesco" <fmdefrancesco@...il.com>
To:     Tommaso Merciai <tomm.merciai@...il.com>
Cc:     tomm.merciai@...il.com, Forest Bond <forest@...ttletooquiet.net>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Yujia Qiao <rapiz@...mail.com>,
        Lucas Henneman <lucas.henneman@...aro.org>,
        Madhumitha Prabakaran <madhumithabiw@...il.com>,
        Marcos Antonio de Jesus Filho <mdejesusfilho@...il.com>,
        Aldas Taraškevičius <aldas60@...il.com>,
        "Gustavo A. R. Silva" <gustavoars@...nel.org>,
        Deepak R Varma <mh12gx2825@...il.com>,
        linux-staging@...ts.linux.dev, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v3 1/3] staging: vt6655: replace camel case b_short_slot_time instead of bShortSlotTime.

On Saturday, September 25, 2021 9:45:22 AM CEST Tommaso Merciai wrote:
> Signed-off-by: Tommaso Merciai <tomm.merciai@...il.com>
> ---
> Changes since v2:
>  - Add changelog.
> 
> Changes since v1:
>  - Make the commit message more clearer.
> ---
>  drivers/staging/vt6655/baseband.c    | 4 ++--
>  drivers/staging/vt6655/card.c        | 2 +-
>  drivers/staging/vt6655/device.h      | 2 +-
>  drivers/staging/vt6655/device_main.c | 4 ++--
>  4 files changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/drivers/staging/vt6655/baseband.c b/drivers/staging/vt6655/
baseband.c
> index f73f3fad3e05..170c4056946f 100644
> --- a/drivers/staging/vt6655/baseband.c
> +++ b/drivers/staging/vt6655/baseband.c
> @@ -2200,7 +2200,7 @@ bb_set_short_slot_time(struct vnt_private *priv)
>  
>  	bb_read_embedded(priv, 0x0A, &by_bb_rx_conf); /* CR10 */

Well, it's pretty clear that you didn't read the document whose link you've 
been provided by Gustavo A.R. Silva and Greg Kroah-Hartman. Furthermore you 
also ignored Gustavo's suggestions about how a patch should be made. :(

If you had read that document you should have noticed that your patches 
doesn't comply with the Linux kernel development rules.

In section "Revising your patches/Versioning one patch revision" there's a 
sample patch ("fix the number of endpoint parameter"). If you look at that 
patch you see what your patches are missing.

Patches have at least three logical entities, but in your case they must be 
four because you are sending new versions of the initial one.

1) A "Subject". Along with information about the version and the position in 
a series, you must always write the subsystem prefix and the driver name. 

The text in the "Subject" should  summarize with _few_ _words_ the "Commit 
message" or "Changelog". Few words means that you don't need "replace camel 
case b_short_slot_time instead of bShortSlotTime." because it is too long. 

No full stop at the end of the line. 

Just something like "Fix camelcase in bShortSlotTime" is enough (you may also 
add "[] variable", if you want to.

2) A "Commit message" (or "Changelog"). You must explain "what" you did and 
"why". You didn't provide it and Greg Kroah-Hartman complained.

He won't ever accept patches without it. If you had read "Start creating your 
first patch / Git post-commit hooks", you would have known of the "post-
commit" hook and so, you had not submitted patches without messages because 
that hook would have warned you.

3) A "Versions list" (or a "List of changes between versions"). Where in the 
list of 3/3 you recorded that you changed "port_off_set" to "post_offset"?

4) A "diff" of the changes that shows the changes you have made, one line a a 
time. This is the only part that is not up to you because Git adds it 
automatically.

Again, please read the documentation.

Thanks,

Fabio