Re: [PATCH] staging: vt6655: Fix block comment alignment

[Philipp Hortmann <philipp.g.hortmann@gmail.com>]

On 8/28/24 17:00, Dominik Karol Piątkowski wrote:
> This patch fixes the "Block comments should align the * on each line"
> warning detected by checkpatch.pl.
> 
> Signed-off-by: Dominik Karol Piątkowski <dominik.karol.piatkowski@protonmail.com>
> ---
>   drivers/staging/vt6655/device.h | 8 ++++----
>   1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/staging/vt6655/device.h b/drivers/staging/vt6655/device.h
> index 0212240ba23f..32d9cbd55222 100644
> --- a/drivers/staging/vt6655/device.h
> +++ b/drivers/staging/vt6655/device.h
> @@ -189,10 +189,10 @@ struct vnt_private {
>   
>   	u8		byBBType; /* 0:11A, 1:11B, 2:11G */
>   	u8		packet_type; /*
> -				       * 0:11a,1:11b,2:11gb (only CCK
> -				       * in BasicRate), 3:11ga (OFDM in
> -				       * Basic Rate)
> -				       */
> +				      * 0:11a,1:11b,2:11gb (only CCK
> +				      * in BasicRate), 3:11ga (OFDM in
> +				      * Basic Rate)
> +				      */
>   	unsigned short wBasicRate;
>   	unsigned char byACKRate;
>   	unsigned char byTopOFDMBasicRate;

Hi Dominik,

please make your "Subject" line more unique. Consider that we may end up 
with having dozen of commits like yours, all of them referring to 
different removals and all without the necessary information to tell 
what they differ in (except the driver/subsystem). So it would help if 
you add the changed file or function to make it more unique.

The description can be improved. Please always consider that checkpatch 
can be wrong. So checkpatch is not a justification.

I propose:
Align the * on each line of the block comment to improve readability.

Important is to describe the why this patch makes the code better.
You can mention the tool which gave you the hint but you do not have to.

If you send in a second version of this patch please use a change 
history. Description from Dan under:
https://staticthinking.wordpress.com/2022/07/27/how-to-send-a-v2-patch/

Thanks for your support.

Bye Philipp