lib/test_kmod.c:100: warning: Function parameter or member 'task_sync' not described in 'kmod_test_device_info'

From: kernel test robot
Date: Fri Nov 03 2023 - 10:30:14 EST


tree: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
head: 8f6f76a6a29f36d2f3e4510d0bde5046672f6924
commit: c093a74dac1c008daee92d6d613e9e3fe20b6585 test_kmod: stop kernel-doc warnings
date: 9 months ago
config: s390-allmodconfig (https://download.01.org/0day-ci/archive/20231103/202311032240.w1q3ydGG-lkp@xxxxxxxxx/config)
compiler: s390-linux-gcc (GCC) 13.2.0
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20231103/202311032240.w1q3ydGG-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/202311032240.w1q3ydGG-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'


vim +100 lib/test_kmod.c

d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 78
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 79 /**
c093a74dac1c00 Randy Dunlap 2023-01-02 80 * struct kmod_test_device_info - thread info
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 81 *
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 82 * @ret_sync: return value if request_module() is used, sync request for
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 83 * @TEST_KMOD_DRIVER
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 84 * @fs_sync: return value of get_fs_type() for @TEST_KMOD_FS_TYPE
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 85 * @thread_idx: thread ID
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 86 * @test_dev: test device test is being performed under
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 87 * @need_mod_put: Some tests (get_fs_type() is one) requires putting the module
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 88 * (module_put(fs_sync->owner)) when done, otherwise you will not be able
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 89 * to unload the respective modules and re-test. We use this to keep
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 90 * accounting of when we need this and to help out in case we need to
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 91 * error out and deal with module_put() on error.
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 92 */
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 93 struct kmod_test_device_info {
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 94 int ret_sync;
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 95 struct file_system_type *fs_sync;
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 96 struct task_struct *task_sync;
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 97 unsigned int thread_idx;
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 98 struct kmod_test_device *test_dev;
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 99 bool need_mod_put;
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 @100 };
d9c6a72d6fa29d Luis R. Rodriguez 2017-07-14 101

:::::: The code at line 100 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