Re: [PATCH] staging: r8188eu: Fix kernel-doc

[Bagas Sanjaya <bagasdotme@gmail.com>]

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 <abaci@linux.alibaba.com>
> 
> 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 <lkp@intel.com>. 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