Re: [PATCH] staging: rtl8723bs: fix block comments alignment

karthek
2021-02-10T07:38:31Z

On Wed, Feb 10, 2021 at 10:27:17AM +0300, Dan Carpenter wrote:
> On Wed, Feb 10, 2021 at 12:23:17AM +0530, karthik alapati wrote:
> > fix checkpatch.pl warning for "block comments should align the * on each line"
> >
> > Signed-off-by: karthik alapati <mail@karthek.com>
> > ---
> > .../staging/rtl8723bs/hal/rtl8723b_phycfg.c | 204 +++++++++---------
> > 1 file changed, 102 insertions(+), 102 deletions(-)
> >
> > diff --git a/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c b/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
> > index cf23414d7..003f954c2 100644
> > --- a/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
> > +++ b/drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
> > @@ -20,16 +20,16 @@
> > #define MAX_DOZE_WAITING_TIMES_9x 64
> >
> > /**
> > -* Function: phy_CalculateBitShift
> > -*
> > -* OverView: Get shifted position of the BitMask
> > -*
> > -* Input:
> > -* u32 BitMask,
> > -*
> > -* Output: none
> > -* Return: u32 Return the shift bit bit position of the mask
> > -*/
> > + * Function: phy_CalculateBitShift
> > + *
> > + * OverView: Get shifted position of the BitMask
> > + *
> > + * Input:
> > + * u32 BitMask,
>
> Why is this on a different line??
>
> > + *
> > + * Output: none
> > + * Return: u32 Return the shift bit bit position of the mask
>
> The "u32" is indented more than the "none". "bit bit" is probably a
> typo?
>
> > + */
> > static u32 phy_CalculateBitShift(u32 BitMask)
> > {
> > u32 i;
>
> There is a proper kernel-doc style that function comments are supposed
> to use. https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html
>
> ./scripts/kernel-doc -v -none drivers/staging/rtl8723bs/hal/rtl8723b_phycfg.c
>
> regards,
> dan carpenter
>

thats my old patch
the new one is already sent to greg,lkml