Re: [PATCH v6 11/16] scripts: kernel-doc: validate kernel-doc markup with the actual names

From: kernel test robot
Date: Thu Jan 14 2021 - 05:17:58 EST


Hi Mauro,

I love your patch! Perhaps something to improve:

[auto build test WARNING on next-20210113]
[also build test WARNING on v5.11-rc3]
[cannot apply to lwn/docs-next kees/for-next/pstore mac80211-next/master mac80211/master pza/reset/next linus/master v5.11-rc3 v5.11-rc2 v5.11-rc1]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]

url: https://github.com/0day-ci/linux/commits/Mauro-Carvalho-Chehab/Fix-several-bad-kernel-doc-markups/20210114-161010
base: aa515cdce7a151dcc14b7600d33f1414c6fa32c9
config: mips-nlm_xlp_defconfig (attached as .config)
compiler: mips64-linux-gcc (GCC) 9.3.0
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
# https://github.com/0day-ci/linux/commit/1e9159b3640012fc5fab8508b1c5635ac13a55e9
git remote add linux-review https://github.com/0day-ci/linux
git fetch --no-tags linux-review Mauro-Carvalho-Chehab/Fix-several-bad-kernel-doc-markups/20210114-161010
git checkout 1e9159b3640012fc5fab8508b1c5635ac13a55e9
# save the attached .config to linux build tree
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-9.3.0 make.cross ARCH=mips

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

All warnings (new ones prefixed by >>):

arch/mips/kernel/module.c:289: warning: Function parameter or member 'reloc_handler' not described in 'int'
>> arch/mips/kernel/module.c:289: warning: expecting prototype for reloc_handler(). Prototype was for int() instead
--
arch/mips/kernel/kprobes.c:196: warning: Function parameter or member 'p' not described in 'evaluate_branch_instruction'
arch/mips/kernel/kprobes.c:196: warning: Function parameter or member 'regs' not described in 'evaluate_branch_instruction'
arch/mips/kernel/kprobes.c:196: warning: Function parameter or member 'kcb' not described in 'evaluate_branch_instruction'
>> arch/mips/kernel/kprobes.c:196: warning: expecting prototype for evaluate_branch_instrucion(). Prototype was for evaluate_branch_instruction() instead


vim +289 arch/mips/kernel/module.c

5d3c792583b60406 Paul Burton 2016-02-04 272
430d0b88943afffd Paul Burton 2017-03-30 273 /**
430d0b88943afffd Paul Burton 2017-03-30 274 * reloc_handler() - Apply a particular relocation to a module
430d0b88943afffd Paul Burton 2017-03-30 275 * @me: the module to apply the reloc to
430d0b88943afffd Paul Burton 2017-03-30 276 * @location: the address at which the reloc is to be applied
430d0b88943afffd Paul Burton 2017-03-30 277 * @base: the existing value at location for REL-style; 0 for RELA-style
430d0b88943afffd Paul Burton 2017-03-30 278 * @v: the value of the reloc, with addend for RELA-style
430d0b88943afffd Paul Burton 2017-03-30 279 *
430d0b88943afffd Paul Burton 2017-03-30 280 * Each implemented reloc_handler function applies a particular type of
430d0b88943afffd Paul Burton 2017-03-30 281 * relocation to the module @me. Relocs that may be found in either REL or RELA
430d0b88943afffd Paul Burton 2017-03-30 282 * variants can be handled by making use of the @base & @v parameters which are
430d0b88943afffd Paul Burton 2017-03-30 283 * set to values which abstract the difference away from the particular reloc
430d0b88943afffd Paul Burton 2017-03-30 284 * implementations.
430d0b88943afffd Paul Burton 2017-03-30 285 *
430d0b88943afffd Paul Burton 2017-03-30 286 * Return: 0 upon success, else -ERRNO
430d0b88943afffd Paul Burton 2017-03-30 287 */
430d0b88943afffd Paul Burton 2017-03-30 288 typedef int (*reloc_handler)(struct module *me, u32 *location,
430d0b88943afffd Paul Burton 2017-03-30 @289 u32 base, Elf_Addr v, bool rela);
430d0b88943afffd Paul Burton 2017-03-30 290

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

Attachment: .config.gz
Description: application/gzip