From: Dan Carpenter <error27@gmail.com>
To: Khadija Kamran <kamrankhadijadj@gmail.com>
Cc: outreachy@lists.linux.dev, gregkh@linuxfoundation.org,
linux-staging@lists.linux.dev, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2 3/3] staging: rtl8192u: reformat block comments
Date: Mon, 27 Mar 2023 08:03:14 +0300 [thread overview]
Message-ID: <32819686-cce9-40d2-8707-547bdb1a72f8@kili.mountain> (raw)
In-Reply-To: <d49d15e620aa9239f3d68df1a5f8b600de77b536.1679831899.git.kamrankhadijadj@gmail.com>
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
prev parent reply other threads:[~2023-03-27 5:03 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-03-26 12:18 [PATCH v2 0/3] staging: rtl8192u: clean up comments in r8192U_dm.c Khadija Kamran
2023-03-26 12:18 ` [PATCH v2 1/3] staging: rtl8192u: remove change history from comments Khadija Kamran
2023-03-26 12:18 ` [PATCH v2 2/3] staging: rtl8192u: remove commented out code Khadija Kamran
2023-03-26 12:18 ` [PATCH v2 3/3] staging: rtl8192u: reformat block comments Khadija Kamran
2023-03-27 5:03 ` Dan Carpenter [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=32819686-cce9-40d2-8707-547bdb1a72f8@kili.mountain \
--to=error27@gmail.com \
--cc=gregkh@linuxfoundation.org \
--cc=kamrankhadijadj@gmail.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-staging@lists.linux.dev \
--cc=outreachy@lists.linux.dev \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).