linux-kernel - Re: [PATCH 0/3] iio: adc: ad799x: Fix warning generated by checkpatch

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: <ZizV3UWWJkyH5kmr@debian-BULLSEYE-live-builder-AMD64>
Date: Sat, 27 Apr 2024 07:39:25 -0300
From: Marcelo Schmitt <marcelo.schmitt1@...il.com>
To: Gustavo <ogustavo@....br>
Cc: lars@...afoo.de, Michael.Hennerich@...log.com, jic23@...nel.org,
	Gustavo <gustavenrique01@...il.com>, linux-iio@...r.kernel.org,
	linux-kernel@...r.kernel.org
Subject: Re: [PATCH 0/3] iio: adc: ad799x: Fix warning generated by checkpatch

Hi Gustavo, Bruna,

The patches look overall good but there are some improvements that can be made.
First, checkpatch points out email address mismatch. Gustavo address of sign-off
is different then the address used to send the patches. I think this can
be solved by adding --from parameter to git format-patch or git send-email.
Second, Gustavo's sign-off tag is incomplete. The tag must have either first and
last name or all developer's names.
For example:
Signed-off-by: first_name last_name <email_address>
or
Signed-off-by: first_name 1st_middle_name 2nd_middle_name ... last_name <email_address>
I'm pretty sure those actually must be sort out for a patch to be acceptable.
Some additional tips to improve patch set quality:
- Don't use file extensions in subjects
  iio: adc: ad799x.c: ... -> iio: adc: ad799x: ...
- Also wrap the cover letter text to 75 columns except when it makes text
  clearly less readable.
- It should be okay to say in commit message that a change is suggested by
  checkpatch or fixes some checkpatch warning as long as you also describe
  what the actual change is. You seem to already be describing the changes
  so maybe adding that they also cease checkpatch warnings / make code
  compliant to Linux code style.
- Maybe have a look at the submitting-patches documentation [1] and
  tips to write commit messages [2] to help producing patches.

[1]: https://www.kernel.org/doc/html/latest/process/submitting-patches.html
[2]: https://cbea.ms/git-commit/#why-not-how

Regards,
Marcelo

On 04/25, Gustavo wrote:
> Clean code of iio:adc:ad799x to avoid warning messages. These include proper variable declaration 'unsigned' to 'unsigned int', add blank line and use of octal permission instead of symbolic.
> 
> Gustavo (3):
>   iio: adc: ad799x: change 'unsigned' to 'unsigned int' declaration
>   iio: adc: ad799x.c: add blank line to avoid warning messages
>   iio: adc: ad799x: Prefer to use octal permission instead of symbolic
> 
>  drivers/iio/adc/ad799x.c | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
> 
> -- 
> 2.34.1
> 
>