Re: drivers/usb/gadget/function/f_uac1_legacy.c:1: warning: no structured comments found

[Yujie Liu]

Hi Randy,

On Mon, Dec 04, 2023 at 02:46:41PM -0800, Randy Dunlap wrote:
> Hi ktr,
> 
> On 11/20/23 18:31, kernel test robot wrote:
> > Hi Ruslan,
> > 
> > FYI, the error/warning was bisected to this commit, please ignore it if it's irrelevant.
> > 
> > tree:   https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
> > head:   98b1cc82c4affc16f5598d4fa14b1858671b2263
> > commit: d355339eecd986648420e05f8c958fbc78dbb382 usb: gadget: function: make current f_uac1 implementation legacy
> > date:   6 years ago
> > config: i386-randconfig-002-20231120 (https://download.01.org/0day-ci/archive/20231121/202311211052.RsFuk4Gr-lkp@xxxxxxxxx/config)
> > compiler: gcc-7 (Ubuntu 7.5.0-6ubuntu2) 7.5.0
> > reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20231121/202311211052.RsFuk4Gr-lkp@xxxxxxxxx/reproduce)
> > 
> > If you fix the issue in a separate patch/commit (i.e. not just a new version of
> > the same patch/commit), kindly add following tags
> > | Reported-by: kernel test robot <lkp@xxxxxxxxx>
> > | Closes: https://lore.kernel.org/oe-kbuild-all/202311211052.RsFuk4Gr-lkp@xxxxxxxxx/
> > 
> > All warnings (new ones prefixed by >>):
> > 
> 
> I can't reproduce any of these warnings.
> 
> I think that you should reevaluate something here.

These warnings are produced by kernel-doc tool:

$ git checkout d355339eecd986648420e05f8c958fbc78dbb382
HEAD is now at d355339eecd9 usb: gadget: function: make current f_uac1 implementation legacy

$ scripts/kernel-doc drivers/usb/gadget/function/u_uac1_legacy.c 1>/dev/null
drivers/usb/gadget/function/u_uac1_legacy.c:33: warning: No description found for parameter 'i'
drivers/usb/gadget/function/u_uac1_legacy.c:33: warning: No description found for parameter 'val'
drivers/usb/gadget/function/u_uac1_legacy.c:96: warning: No description found for parameter 'snd'
drivers/usb/gadget/function/u_uac1_legacy.c:156: warning: No description found for parameter 'card'
drivers/usb/gadget/function/u_uac1_legacy.c:156: warning: No description found for parameter 'buf'
drivers/usb/gadget/function/u_uac1_legacy.c:156: warning: No description found for parameter 'count'
drivers/usb/gadget/function/u_uac1_legacy.c:205: warning: No description found for parameter 'card'
drivers/usb/gadget/function/u_uac1_legacy.c:265: warning: No description found for parameter 'gau'
drivers/usb/gadget/function/u_uac1_legacy.c:294: warning: No description found for parameter 'card'
drivers/usb/gadget/function/u_uac1_legacy.c:311: warning: No description found for parameter 'the_card'

Since this is a "move files around" commit that renames u_uac1.c to
u_uac1_legacy.c, and the warnings already exist before this commit, so
this is a false report. Sorry for this.

We introduced a new feature into the bot recently to bisect old
document warnings, but it is not working very smoothly and produces some
false reports. The "steps to reproduce" was not updated in time,
either. We are investigating these issues and will fix them soon.
Apologies again for any noise reports.

Best Regards,
Yujie

> 
> 
> >>> drivers/usb/gadget/function/f_uac1_legacy.c:1: warning: no structured comments found
> > --
> >>> drivers/usb/gadget/function/u_uac1_legacy.c:33: warning: No description found for parameter 'i'
> >>> drivers/usb/gadget/function/u_uac1_legacy.c:33: warning: No description found for parameter 'val'
> >>> drivers/usb/gadget/function/u_uac1_legacy.c:96: warning: No description found for parameter 'snd'
> >>> drivers/usb/gadget/function/u_uac1_legacy.c:156: warning: No description found for parameter 'card'
> >>> drivers/usb/gadget/function/u_uac1_legacy.c:156: warning: No description found for parameter 'buf'
> >>> drivers/usb/gadget/function/u_uac1_legacy.c:156: warning: No description found for parameter 'count'
> >    drivers/usb/gadget/function/u_uac1_legacy.c:205: warning: No description found for parameter 'card'
> >>> drivers/usb/gadget/function/u_uac1_legacy.c:265: warning: No description found for parameter 'gau'
> >    drivers/usb/gadget/function/u_uac1_legacy.c:294: warning: No description found for parameter 'card'
> >>> drivers/usb/gadget/function/u_uac1_legacy.c:311: warning: No description found for parameter 'the_card'
> > 
> > 
> > vim +1 drivers/usb/gadget/function/f_uac1_legacy.c
> > 
> > c6994e6f067cf0 drivers/usb/gadget/f_audio.c Bryan Wu 2009-06-03  @1  /*
> > c6994e6f067cf0 drivers/usb/gadget/f_audio.c Bryan Wu 2009-06-03   2   * f_audio.c -- USB Audio class function driver
> > c6994e6f067cf0 drivers/usb/gadget/f_audio.c Bryan Wu 2009-06-03   3    *
> > c6994e6f067cf0 drivers/usb/gadget/f_audio.c Bryan Wu 2009-06-03   4   * Copyright (C) 2008 Bryan Wu <cooloney@xxxxxxxxxx>
> > c6994e6f067cf0 drivers/usb/gadget/f_audio.c Bryan Wu 2009-06-03   5   * Copyright (C) 2008 Analog Devices, Inc
> > c6994e6f067cf0 drivers/usb/gadget/f_audio.c Bryan Wu 2009-06-03   6   *
> > c6994e6f067cf0 drivers/usb/gadget/f_audio.c Bryan Wu 2009-06-03   7   * Enter bugs at http://blackfin.uclinux.org/
> > c6994e6f067cf0 drivers/usb/gadget/f_audio.c Bryan Wu 2009-06-03   8   *
> > c6994e6f067cf0 drivers/usb/gadget/f_audio.c Bryan Wu 2009-06-03   9   * Licensed under the GPL-2 or later.
> > c6994e6f067cf0 drivers/usb/gadget/f_audio.c Bryan Wu 2009-06-03  10   */
> > c6994e6f067cf0 drivers/usb/gadget/f_audio.c Bryan Wu 2009-06-03  11  
> > 
> > :::::: The code at line 1 was first introduced by commit
> > :::::: c6994e6f067cf0fc4c6cca3d164018b1150916f8 USB: gadget: add USB Audio Gadget driver
> > 
> > :::::: TO: Bryan Wu <cooloney@xxxxxxxxxx>
> > :::::: CC: Greg Kroah-Hartman <gregkh@xxxxxxx>
> > 
> 
> -- 
> ~Randy
>