lib/test_kmod.c:134: warning: Excess struct member 'thread_lock' description in 'kmod_test_device'
From: kernel test robot
Date: Thu Dec 14 2023 - 14:02:31 EST
tree: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
head: 5bd7ef53ffe5ca580e93e74eb8c81ed191ddc4bd
commit: c093a74dac1c008daee92d6d613e9e3fe20b6585 test_kmod: stop kernel-doc warnings
date: 11 months ago
config: sh-allyesconfig (https://download.01.org/0day-ci/archive/20231215/202312150205.NY5AKrJM-lkp@xxxxxxxxx/config)
compiler: sh4-linux-gcc (GCC) 13.2.0
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20231215/202312150205.NY5AKrJM-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/202312150205.NY5AKrJM-lkp@xxxxxxxxx/
All warnings (new ones prefixed by >>):
lib/test_kmod.c:67: warning: Enum value '__TEST_KMOD_INVALID' not described in enum 'kmod_test_case'
lib/test_kmod.c:67: warning: Enum value '__TEST_KMOD_MAX' not described in enum 'kmod_test_case'
lib/test_kmod.c:100: warning: Function parameter or member 'task_sync' not described in 'kmod_test_device_info'
lib/test_kmod.c:134: warning: Function parameter or member 'thread_mutex' not described in 'kmod_test_device'
>> lib/test_kmod.c:134: warning: Excess struct member 'thread_lock' description in 'kmod_test_device'
vim +134 lib/test_kmod.c
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 101
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 102 /**
c093a74dac1c00 Randy Dunlap 2023-01-02 103 * struct kmod_test_device - test device to help test kmod
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 104 *
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 105 * @dev_idx: unique ID for test device
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 106 * @config: configuration for the test
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 107 * @misc_dev: we use a misc device under the hood
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 108 * @dev: pointer to misc_dev's own struct device
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 109 * @config_mutex: protects configuration of test
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 110 * @trigger_mutex: the test trigger can only be fired once at a time
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 111 * @thread_lock: protects @done count, and the @info per each thread
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 112 * @done: number of threads which have completed or failed
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 113 * @test_is_oom: when we run out of memory, use this to halt moving forward
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 114 * @kthreads_done: completion used to signal when all work is done
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 115 * @list: needed to be part of the reg_test_devs
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 116 * @info: array of info for each thread
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 117 */
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 118 struct kmod_test_device {
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 119 int dev_idx;
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 120 struct test_config config;
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 121 struct miscdevice misc_dev;
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 122 struct device *dev;
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 123 struct mutex config_mutex;
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 124 struct mutex trigger_mutex;
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 125 struct mutex thread_mutex;
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 126
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 127 unsigned int done;
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 128
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 129 bool test_is_oom;
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 130 struct completion kthreads_done;
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 131 struct list_head list;
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 132
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 133 struct kmod_test_device_info *info;
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 @134 };
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 135
:::::: The code at line 134 was first introduced by commit
:::::: d9c6a72d6fa29d3a7999dda726577e5d1fccafa5 kmod: add test driver to stress test the module loader
:::::: TO: Luis R. Rodriguez <mcgrof@xxxxxxxxxx>
:::::: CC: Linus Torvalds <torvalds@xxxxxxxxxxxxxxxxxxxx>
--
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki