linux-kernel - Re: [PATCH v3 3/4] staging: rtl8723bs: include: Further clean up function declarations

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: <1177f80aa848a294f65e305729304b76d1e5ee98.camel@perches.com>
Date:   Sun, 26 Jul 2020 10:15:32 -0700
From:   Joe Perches <joe@...ches.com>
To:     Greg KH <gregkh@...uxfoundation.org>,
        Aditya Jain <aditya.jainadityajain.jain@...il.com>
Cc:     devel@...verdev.osuosl.org, hdegoede@...hat.com,
        linux-kernel@...r.kernel.org, Larry.Finger@...inger.net
Subject: Re: [PATCH v3 3/4] staging: rtl8723bs: include: Further clean up
 function declarations

On Sun, 2020-07-26 at 17:02 +0200, Greg KH wrote:
> On Sun, Jul 26, 2020 at 07:50:12PM +0530, Aditya Jain wrote:
> > Cleaning up messy multiline function declarations in hal_phy_cfg.h
[]
> > diff --git a/drivers/staging/rtl8723bs/include/hal_phy_cfg.h b/drivers/staging/rtl8723bs/include/hal_phy_cfg.h
[]
> > -void
> > -PHY_SetSwChnlBWMode8723B(
> > -struct adapter *Adapter,
> > -u8 			channel,
> > -enum CHANNEL_WIDTH		Bandwidth,
> > -u8 			Offset40,
> > -u8 			Offset80
> > +void PHY_SetBWMode8723B(struct adapter *Adapter,
> > +			enum CHANNEL_WIDTH Bandwidth,	/*  20M or 40M */
> > +			unsigned char Offset	/*  Upper, Lower, or Don't care */
> 
> Those comments should go at the top of the function declaration, in
> kernel doc format.

Not every external function needs kernel-doc.

This is a realtek staging driver that likely it will never be
moved out of staging.