linux-kernel - Re: [PATCH v3 4/4] staging: rtl8192u: add '*/' on separate line in block comments

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <ZCJ2_PuvCUBvlwaL@kroah.com>
Date:   Tue, 28 Mar 2023 07:11:24 +0200
From:   Greg KH <gregkh@...uxfoundation.org>
To:     Bagas Sanjaya <bagasdotme@...il.com>
Cc:     Khadija Kamran <kamrankhadijadj@...il.com>,
        outreachy@...ts.linux.dev, linux-staging@...ts.linux.dev,
        linux-kernel@...r.kernel.org,
        Jerry Chuang <jerry-chuang@...ltek.com>
Subject: Re: [PATCH v3 4/4] staging: rtl8192u: add '*/' on separate line in
 block comments

On Tue, Mar 28, 2023 at 10:27:32AM +0700, Bagas Sanjaya wrote:
> On Tue, Mar 28, 2023 at 12:49:09AM +0500, Khadija Kamran wrote:
> > Linux kernel coding style uses '*/' on a separate line at the end of
> > multi line comments.
> > 
> > Fix block comments by moving '*/' at the end of block comments on a
> > separate line as reported by checkpatch.pl script.
> > 
> > Signed-off-by: Khadija Kamran <kamrankhadijadj@...il.com>
> > ---
> >  drivers/staging/rtl8192u/r8192U_dm.c | 21 ++++++++++++++-------
> >  1 file changed, 14 insertions(+), 7 deletions(-)
> > 
> > diff --git a/drivers/staging/rtl8192u/r8192U_dm.c b/drivers/staging/rtl8192u/r8192U_dm.c
> > index dd9903719c20..cbae852478ea 100644
> > --- a/drivers/staging/rtl8192u/r8192U_dm.c
> > +++ b/drivers/staging/rtl8192u/r8192U_dm.c
> > @@ -244,7 +244,8 @@ void init_rate_adaptive(struct net_device *dev)
> >   * Output:		NONE
> >   *
> >   * Return:		NONE
> > - *---------------------------------------------------------------------------*/
> > + *---------------------------------------------------------------------------
> > + */
> > <snipped>...
> >  void dm_rf_pathcheck_workitemcallback(struct work_struct *work)
> >  {
> >  	struct delayed_work *dwork = to_delayed_work(work);
> > @@ -2407,7 +2413,8 @@ static void dm_rxpath_sel_byrssi(struct net_device *dev)
> >   * Output:		NONE
> >   *
> >   * Return:		NONE
> > - *---------------------------------------------------------------------------*/
> > + *---------------------------------------------------------------------------
> > + */
> 
> While at above can you please turn these comments above into kernel-doc
> comments (see Documentation/doc-guide/kernel-doc.rst for how to write
> one)? This requires a placeholder doc where you can write e.g. overview
> of the driver and how it is used. The doc should be in
> Documentation/driver-api/staging/ (since this is staging driver).

No, these are static functions, or just normal internal-to-the-driver
functions, they do not need kerneldoc or any Documentation/* entries,
sorry.

greg k-h