lkml.org 
[lkml]   [2023]   [Mar]   [27]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
Date
From
SubjectRe: [PATCH v2 3/3] staging: rtl8192u: reformat block comments
On Sun, Mar 26, 2023 at 05:18:27PM +0500, Khadija Kamran wrote:
> Linux kernel coding style for block comments uses a column of '*' on the
> left side and uses '*/' on a separate line.
>
> Fix block comments by adding '*' on subsequent lines and moving '*/' at
> the end of block comments on a separate line. These issues in block
> comments are reported by checkpatch.pl script.
>
> Signed-off-by: Khadija Kamran <kamrankhadijadj@gmail.com>
> ---
> drivers/staging/rtl8192u/r8192U_dm.c | 38 +++++++++++++++++-----------
> 1 file changed, 23 insertions(+), 15 deletions(-)
>
> diff --git a/drivers/staging/rtl8192u/r8192U_dm.c b/drivers/staging/rtl8192u/r8192U_dm.c
> index e5c0bece4bb4..99c38a4cf54c 100644
> --- a/drivers/staging/rtl8192u/r8192U_dm.c
> +++ b/drivers/staging/rtl8192u/r8192U_dm.c
> @@ -1,13 +1,14 @@
> // SPDX-License-Identifier: GPL-2.0
> /*++
> -Copyright-c Realtek Semiconductor Corp. All rights reserved.
> -
> -Module Name:
> - r8192U_dm.c
> -
> -Abstract:
> - HW dynamic mechanism.
> ---*/
> + *Copyright-c Realtek Semiconductor Corp. All rights reserved.

You need spaces after the '*' char.

/*
* Copyright-c Realtek Semiconductor Corp. All rights reserved.
*
* Module Name:

> + *
> + *Module Name:
> + * r8192U_dm.c
> + *
> + *Abstract:
> + * HW dynamic mechanism.
> + *--
> + */
> #include "r8192U.h"
> #include "r8192U_dm.h"
> #include "r8192U_hw.h"
> @@ -243,7 +244,8 @@ void init_rate_adaptive(struct net_device *dev)
> * Output: NONE
> *
> * Return: NONE
> - *---------------------------------------------------------------------------*/
> + *---------------------------------------------------------------------------
> + */
> static void dm_check_rate_adaptive(struct net_device *dev)

There is a proper kernel doc format for comment formats. The format is
described in Documentation/doc-guide/kernel-doc.rst

(Change the function comments as a separate patch from the top of the
file changes).

regards,
dan carpenter

\
 
 \ /
  Last update: 2023-03-27 07:04    [W:0.077 / U:0.732 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site