Skip to content

Commit 1572853

Browse files
rddunlapmcgrof
authored andcommitted
lib/test_kmod: fix kernel-doc warnings
Fix all kernel-doc warnings in test_kmod.c: - Mark some enum values as private so that kernel-doc is not needed for them - s/thread_mutex/thread_lock/ in a struct's kernel-doc comments - add kernel-doc info for @task_sync test_kmod.c:67: warning: Enum value '__TEST_KMOD_INVALID' not described in enum 'kmod_test_case' test_kmod.c:67: warning: Enum value '__TEST_KMOD_MAX' not described in enum 'kmod_test_case' test_kmod.c:100: warning: Function parameter or member 'task_sync' not described in 'kmod_test_device_info' test_kmod.c:134: warning: Function parameter or member 'thread_mutex' not described in 'kmod_test_device' Signed-off-by: Randy Dunlap <[email protected]> Cc: Luis Chamberlain <[email protected]> Cc: <[email protected]> Signed-off-by: Luis Chamberlain <[email protected]>
1 parent 79d9f96 commit 1572853

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

lib/test_kmod.c

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,14 @@ static int num_test_devs;
5858
* @need_mod_put for your tests case.
5959
*/
6060
enum kmod_test_case {
61+
/* private: */
6162
__TEST_KMOD_INVALID = 0,
63+
/* public: */
6264

6365
TEST_KMOD_DRIVER,
6466
TEST_KMOD_FS_TYPE,
6567

68+
/* private: */
6669
__TEST_KMOD_MAX,
6770
};
6871

@@ -82,6 +85,7 @@ struct kmod_test_device;
8285
* @ret_sync: return value if request_module() is used, sync request for
8386
* @TEST_KMOD_DRIVER
8487
* @fs_sync: return value of get_fs_type() for @TEST_KMOD_FS_TYPE
88+
* @task_sync: kthread's task_struct or %NULL if not running
8589
* @thread_idx: thread ID
8690
* @test_dev: test device test is being performed under
8791
* @need_mod_put: Some tests (get_fs_type() is one) requires putting the module
@@ -108,7 +112,7 @@ struct kmod_test_device_info {
108112
* @dev: pointer to misc_dev's own struct device
109113
* @config_mutex: protects configuration of test
110114
* @trigger_mutex: the test trigger can only be fired once at a time
111-
* @thread_lock: protects @done count, and the @info per each thread
115+
* @thread_mutex: protects @done count, and the @info per each thread
112116
* @done: number of threads which have completed or failed
113117
* @test_is_oom: when we run out of memory, use this to halt moving forward
114118
* @kthreads_done: completion used to signal when all work is done

0 commit comments

Comments
 (0)