linux-kernel - Re: [PATCH] lib/test_kmod: fix kernel-doc warnings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <ac67aa4a-cba9-4daa-93f6-0bbdc0d4ec86@infradead.org>
Date: Wed, 31 Jan 2024 21:16:27 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: linux-kernel@...r.kernel.org
Cc: Luis Chamberlain <mcgrof@...nel.org>, linux-modules@...r.kernel.org
Subject: Re: [PATCH] lib/test_kmod: fix kernel-doc warnings

Hi,

Any comments on this patch?
Thanks.


On 11/3/23 21:20, Randy Dunlap wrote:
> 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 <rdunlap@...radead.org>
> Cc: Luis Chamberlain <mcgrof@...nel.org>
> Cc: linux-modules@...r.kernel.org
> ---
>  lib/test_kmod.c |    6 +++++-
>  1 file changed, 5 insertions(+), 1 deletion(-)
> 
> diff -- a/lib/test_kmod.c b/lib/test_kmod.c
> --- a/lib/test_kmod.c
> +++ b/lib/test_kmod.c
> @@ -58,11 +58,14 @@ static int num_test_devs;
>   * @need_mod_put for your tests case.
>   */
>  enum kmod_test_case {
> +	/* private: */
>  	__TEST_KMOD_INVALID = 0,
> +	/* public: */
>  
>  	TEST_KMOD_DRIVER,
>  	TEST_KMOD_FS_TYPE,
>  
> +	/* private: */
>  	__TEST_KMOD_MAX,
>  };
>  
> @@ -82,6 +85,7 @@ struct kmod_test_device;
>   * @ret_sync: return value if request_module() is used, sync request for
>   * 	@TEST_KMOD_DRIVER
>   * @fs_sync: return value of get_fs_type() for @TEST_KMOD_FS_TYPE
> + * @task_sync: kthread's task_struct or %NULL if not running
>   * @thread_idx: thread ID
>   * @test_dev: test device test is being performed under
>   * @need_mod_put: Some tests (get_fs_type() is one) requires putting the module
> @@ -108,7 +112,7 @@ struct kmod_test_device_info {
>   * @dev: pointer to misc_dev's own struct device
>   * @config_mutex: protects configuration of test
>   * @trigger_mutex: the test trigger can only be fired once at a time
> - * @thread_lock: protects @done count, and the @info per each thread
> + * @thread_mutex: protects @done count, and the @info per each thread
>   * @done: number of threads which have completed or failed
>   * @test_is_oom: when we run out of memory, use this to halt moving forward
>   * @kthreads_done: completion used to signal when all work is done

-- 
#Randy