2022-05-24 19:05:32

by Jiapeng Chong

[permalink] [raw]
Subject: [PATCH] staging: r8188eu: Fix kernel-doc

Fix the following W=1 kernel warnings:

drivers/staging/r8188eu/hal/rtl8188e_phycfg.c:291: warning: expecting
prototype for Function(). Prototype was for rtl8188e_PHY_SetRFReg()
instead.

drivers/staging/r8188eu/hal/rtl8188e_phycfg.c:257: warning: expecting
prototype for Function(). Prototype was for rtl8188e_PHY_QueryRFReg()
instead.

Reported-by: Abaci Robot <[email protected]>
Signed-off-by: Jiapeng Chong <[email protected]>
---
drivers/staging/r8188eu/hal/rtl8188e_phycfg.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/staging/r8188eu/hal/rtl8188e_phycfg.c b/drivers/staging/r8188eu/hal/rtl8188e_phycfg.c
index 4864dafd887b..6342befec5e0 100644
--- a/drivers/staging/r8188eu/hal/rtl8188e_phycfg.c
+++ b/drivers/staging/r8188eu/hal/rtl8188e_phycfg.c
@@ -239,7 +239,7 @@ phy_RFSerialWrite(
}

/**
-* Function: PHY_QueryRFReg
+* Function: rtl8188e_PHY_QueryRFReg()
*
* OverView: Query "Specific bits" to RF register (page 8~)
*
@@ -265,7 +265,7 @@ u32 rtl8188e_PHY_QueryRFReg(struct adapter *Adapter, u32 RegAddr, u32 BitMask)
}

/**
-* Function: PHY_SetRFReg
+* Function: rtl8188e_PHY_SetRFReg()
*
* OverView: Write "Specific bits" to RF register (page 8~)
*
--
2.20.1.7.g153144c



2022-06-06 06:40:06

by Greg Kroah-Hartman

[permalink] [raw]
Subject: Re: [PATCH] staging: r8188eu: Fix kernel-doc

On Tue, May 24, 2022 at 04:39:14PM +0800, Jiapeng Chong wrote:
> Fix the following W=1 kernel warnings:
>
> drivers/staging/r8188eu/hal/rtl8188e_phycfg.c:291: warning: expecting
> prototype for Function(). Prototype was for rtl8188e_PHY_SetRFReg()
> instead.
>
> drivers/staging/r8188eu/hal/rtl8188e_phycfg.c:257: warning: expecting
> prototype for Function(). Prototype was for rtl8188e_PHY_QueryRFReg()
> instead.

Please put build warning lines all on one line.

>
> Reported-by: Abaci Robot <[email protected]>

No, gcc reported this, not a robot, right?

You have read Documentation/process/researcher-guidelines.rst for how to
properly document patches that are created by research tools like this,
right? Please fix this commit up to follow those requirements please.

thanks,

greg k-h

2022-06-06 08:17:26

by Bagas Sanjaya

[permalink] [raw]
Subject: Re: [PATCH] staging: r8188eu: Fix kernel-doc

On Mon, Jun 06, 2022 at 07:53:02AM +0200, Greg KH wrote:
> On Tue, May 24, 2022 at 04:39:14PM +0800, Jiapeng Chong wrote:
> > Fix the following W=1 kernel warnings:
> >
> > drivers/staging/r8188eu/hal/rtl8188e_phycfg.c:291: warning: expecting
> > prototype for Function(). Prototype was for rtl8188e_PHY_SetRFReg()
> > instead.
> >
> > drivers/staging/r8188eu/hal/rtl8188e_phycfg.c:257: warning: expecting
> > prototype for Function(). Prototype was for rtl8188e_PHY_QueryRFReg()
> > instead.
>
> Please put build warning lines all on one line.
>
> >
> > Reported-by: Abaci Robot <[email protected]>
>
> No, gcc reported this, not a robot, right?
>
> You have read Documentation/process/researcher-guidelines.rst for how to
> properly document patches that are created by research tools like this,
> right? Please fix this commit up to follow those requirements please.
>

Hi Greg and Jiapeng,

First, IMO this is not research tool (in the sense of academic purposes),
but development bot used in corporate environment, kinda like kernel
test robot <[email protected]>. When the bot reports any build warnings,
these will be followed up by developers proposing fixes.

What I see in the patch message is just "Fix this warning..." without
saying why there is the warning.

Second, gcc DOESN'T, again DOESN'T, report "expecting prototype"
warnings. These are from scripts/kernel-doc, which enabled these
warnings on W=1 build.

So the underlying problem is mismatching function name in kernel-doc
comment and actual function.

Thanks.

--
An old man doll... just what I always wanted! - Clara

2022-06-07 17:37:22

by Greg Kroah-Hartman

[permalink] [raw]
Subject: Re: [PATCH] staging: r8188eu: Fix kernel-doc

On Mon, Jun 06, 2022 at 02:58:56PM +0700, Bagas Sanjaya wrote:
> On Mon, Jun 06, 2022 at 07:53:02AM +0200, Greg KH wrote:
> > On Tue, May 24, 2022 at 04:39:14PM +0800, Jiapeng Chong wrote:
> > > Fix the following W=1 kernel warnings:
> > >
> > > drivers/staging/r8188eu/hal/rtl8188e_phycfg.c:291: warning: expecting
> > > prototype for Function(). Prototype was for rtl8188e_PHY_SetRFReg()
> > > instead.
> > >
> > > drivers/staging/r8188eu/hal/rtl8188e_phycfg.c:257: warning: expecting
> > > prototype for Function(). Prototype was for rtl8188e_PHY_QueryRFReg()
> > > instead.
> >
> > Please put build warning lines all on one line.
> >
> > >
> > > Reported-by: Abaci Robot <[email protected]>
> >
> > No, gcc reported this, not a robot, right?
> >
> > You have read Documentation/process/researcher-guidelines.rst for how to
> > properly document patches that are created by research tools like this,
> > right? Please fix this commit up to follow those requirements please.
> >
>
> Hi Greg and Jiapeng,
>
> First, IMO this is not research tool (in the sense of academic purposes),
> but development bot used in corporate environment, kinda like kernel
> test robot <[email protected]>. When the bot reports any build warnings,
> these will be followed up by developers proposing fixes.

Ok, then please document it as such and point to where we can find out
more information about it.

> What I see in the patch message is just "Fix this warning..." without
> saying why there is the warning.

Which isn't ok.

> Second, gcc DOESN'T, again DOESN'T, report "expecting prototype"
> warnings. These are from scripts/kernel-doc, which enabled these
> warnings on W=1 build.

Yes, the kernel build reports this, not a random "robot".

> So the underlying problem is mismatching function name in kernel-doc
> comment and actual function.

Agreed, so the changelog should say as such.

thanks,

greg k-h