[lwn:docs-next 80/97] drivers/clocksource/timer-cadence-ttc.c:188: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

* [lwn:docs-next 80/97] drivers/clocksource/timer-cadence-ttc.c:188: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
@ 2021-04-05 21:13 ` kernel test robot
  0 siblings, 0 replies; 2+ messages in thread
From: kernel test robot @ 2021-04-05 21:13 UTC (permalink / raw)
  To: Aditya Srivastava
  Cc: kbuild-all, clang-built-linux, linux-doc, Jonathan Corbet

[-- Attachment #1: Type: text/plain, Size: 8571 bytes --]

tree:   git://git.lwn.net/linux-2.6 docs-next
head:   a4f413348f268c4313f58ca383173ee5986d968a
commit: 3e58e839150db0857dfcb3a0bb3d4af4c6ac1abf [80/97] scripts: kernel-doc: add warning for comment not following kernel-doc syntax
config: x86_64-randconfig-a001-20210405 (attached as .config)
compiler: clang version 13.0.0 (https://github.com/llvm/llvm-project 2760a808b9916a2839513b7fd7314a464f52481e)
reproduce (this is a W=1 build):
        wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross
        chmod +x ~/bin/make.cross
        # install x86_64 cross compiling tool for clang build
        # apt-get install binutils-x86-64-linux-gnu
        git remote add lwn git://git.lwn.net/linux-2.6
        git fetch --no-tags lwn docs-next
        git checkout 3e58e839150db0857dfcb3a0bb3d4af4c6ac1abf
        # save the attached .config to linux build tree
        COMPILER_INSTALL_PATH=$HOME/0day COMPILER=clang make.cross ARCH=x86_64 

If you fix the issue, kindly add following tag as appropriate
Reported-by: kernel test robot <lkp@intel.com>

All warnings (new ones prefixed by >>):

   drivers/clocksource/timer-cadence-ttc.c:78: warning: Function parameter or member 'clk_rate_change_nb' not described in 'ttc_timer'
   drivers/clocksource/timer-cadence-ttc.c:157: warning: Function parameter or member 'cs' not described in '__ttc_clocksource_read'
>> drivers/clocksource/timer-cadence-ttc.c:188: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * ttc_set_{shutdown|oneshot|periodic} - Sets the state of timer
--
>> drivers/of/of_net.c:82: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Search the device tree for the best MAC address to use.  'mac-address' is
--
>> drivers/thermal/rockchip_thermal.c:64: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * The max sensors is two in rockchip SoCs.
   drivers/thermal/rockchip_thermal.c:179: warning: expecting prototype for TSADC Sensor Register description(). Prototype was for TSADCV2_USER_CON() instead
   drivers/thermal/rockchip_thermal.c:1221: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Reset TSADC Controller, reset all tsadc registers.
--
>> drivers/watchdog/mei_wdt.c:124: warning: wrong kernel-doc identifier on line:
    * struct mei_wdt_start_request watchdog start/ping
   drivers/watchdog/mei_wdt.c:137: warning: wrong kernel-doc identifier on line:
    * struct mei_wdt_start_response watchdog start/ping response
--
   drivers/iio/adc/stm32-adc.c:461: warning: expecting prototype for STM32 ADC registers access routines(). Prototype was for stm32_adc_readl() instead
>> drivers/iio/adc/stm32-adc.c:855: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Fixed timeout value for ADC calibration.
--
>> drivers/staging/gasket/gasket_core.c:1556: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Lookup a name by number in a num_name table.
   drivers/staging/gasket/gasket_core.c:1655: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Asynchronously waits on device.
--
>> drivers/staging/comedi/drivers/ni_routes.c:250: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * List of NI global signal names that, as destinations, are only routeable
   drivers/staging/comedi/drivers/ni_routes.c:399: warning: Function parameter or member 'routes' not described in 'ni_route_set_has_source'
   drivers/staging/comedi/drivers/ni_routes.c:399: warning: Function parameter or member 'source' not described in 'ni_route_set_has_source'
   drivers/staging/comedi/drivers/ni_routes.c:525: warning: Function parameter or member 'src_sel_reg_value' not described in 'ni_find_route_source'
   drivers/staging/comedi/drivers/ni_routes.c:525: warning: Function parameter or member 'dest' not described in 'ni_find_route_source'
   drivers/staging/comedi/drivers/ni_routes.c:525: warning: Function parameter or member 'tables' not described in 'ni_find_route_source'
--
   drivers/staging/comedi/drivers/ni_tio.c:1515: warning: Function parameter or member 'counter_dev' not described in 'ni_tio_get_routing'
   drivers/staging/comedi/drivers/ni_tio.c:1515: warning: Function parameter or member 'dest' not described in 'ni_tio_get_routing'
   drivers/staging/comedi/drivers/ni_tio.c:1515: warning: expecting prototype for Retrieves the register value of the current source of the output selector for(). Prototype was for ni_tio_get_routing() instead
>> drivers/staging/comedi/drivers/ni_tio.c:1544: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Sets the register value of the selector MUX for the given destination.
   drivers/staging/comedi/drivers/ni_tio.c:1584: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Sets the given destination MUX to its default value or disable it.
--
>> sound/soc/codecs/nau8825.c:298: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Ramp up the headphone volume change gradually to target level.
   sound/soc/codecs/nau8825.c:350: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Computes log10 of a value; the result is round off to 3 decimal. This func-
   sound/soc/codecs/nau8825.c:411: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * computes cross talk suppression sidetone gain.

vim +188 drivers/clocksource/timer-cadence-ttc.c

b85a3ef4ac6516 arch/arm/mach-zynq/timer.c              John Linn    2011-06-20  186  
b85a3ef4ac6516 arch/arm/mach-zynq/timer.c              John Linn    2011-06-20  187  /**
5c0a4bbefc0571 drivers/clocksource/cadence_ttc_timer.c Viresh Kumar 2015-06-18 @188   * ttc_set_{shutdown|oneshot|periodic} - Sets the state of timer
b85a3ef4ac6516 arch/arm/mach-zynq/timer.c              John Linn    2011-06-20  189   *
b85a3ef4ac6516 arch/arm/mach-zynq/timer.c              John Linn    2011-06-20  190   * @evt:	Address of clock event instance
b85a3ef4ac6516 arch/arm/mach-zynq/timer.c              John Linn    2011-06-20  191   **/
5c0a4bbefc0571 drivers/clocksource/cadence_ttc_timer.c Viresh Kumar 2015-06-18  192  static int ttc_shutdown(struct clock_event_device *evt)
b85a3ef4ac6516 arch/arm/mach-zynq/timer.c              John Linn    2011-06-20  193  {
9e09dc5f7fdc1e arch/arm/mach-zynq/timer.c              Michal Simek 2013-03-27  194  	struct ttc_timer_clockevent *ttce = to_ttc_timer_clkevent(evt);
9e09dc5f7fdc1e arch/arm/mach-zynq/timer.c              Michal Simek 2013-03-27  195  	struct ttc_timer *timer = &ttce->ttc;
b85a3ef4ac6516 arch/arm/mach-zynq/timer.c              John Linn    2011-06-20  196  	u32 ctrl_reg;
b85a3ef4ac6516 arch/arm/mach-zynq/timer.c              John Linn    2011-06-20  197  
5c0a4bbefc0571 drivers/clocksource/cadence_ttc_timer.c Viresh Kumar 2015-06-18  198  	ctrl_reg = readl_relaxed(timer->base_addr + TTC_CNT_CNTRL_OFFSET);
9e09dc5f7fdc1e arch/arm/mach-zynq/timer.c              Michal Simek 2013-03-27  199  	ctrl_reg |= TTC_CNT_CNTRL_DISABLE_MASK;
5c0a4bbefc0571 drivers/clocksource/cadence_ttc_timer.c Viresh Kumar 2015-06-18  200  	writel_relaxed(ctrl_reg, timer->base_addr + TTC_CNT_CNTRL_OFFSET);
5c0a4bbefc0571 drivers/clocksource/cadence_ttc_timer.c Viresh Kumar 2015-06-18  201  	return 0;
b85a3ef4ac6516 arch/arm/mach-zynq/timer.c              John Linn    2011-06-20  202  }
5c0a4bbefc0571 drivers/clocksource/cadence_ttc_timer.c Viresh Kumar 2015-06-18  203  

:::::: The code at line 188 was first introduced by commit
:::::: 5c0a4bbefc0571ba3addb39da0eb53368c018b64 clockevents/drivers/cadence_ttc: Migrate to new 'set-state' interface

:::::: TO: Viresh Kumar <viresh.kumar@linaro.org>
:::::: CC: Daniel Lezcano <daniel.lezcano@linaro.org>

---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all@lists.01.org

[-- Attachment #2: .config.gz --]
[-- Type: application/gzip, Size: 45331 bytes --]

^ permalink raw reply	[flat|nested] 2+ messages in thread