[<prev] [next>] [<thread-prev] [day] [month] [year] [list]
Message-Id: <20240621133943.c16a37133cb0e8b419a8726b@kernel.org>
Date: Fri, 21 Jun 2024 13:39:43 +0900
From: Masami Hiramatsu (Google) <mhiramat@...nel.org>
To: Jeff Johnson <quic_jjohnson@...cinc.com>
Cc: Andrew Morton <akpm@...ux-foundation.org>, "Naveen N. Rao"
<naveen.n.rao@...ux.ibm.com>, Anil S Keshavamurthy
<anil.s.keshavamurthy@...el.com>, "David S. Miller" <davem@...emloft.net>,
Kees Cook <kees@...nel.org>, <linux-kernel@...r.kernel.org>,
<linux-trace-kernel@...r.kernel.org>, <kernel-janitors@...r.kernel.org>
Subject: Re: [PATCH v2] KUnit: add missing MODULE_DESCRIPTION() macros for
lib/test_*.ko
On Wed, 19 Jun 2024 13:59:15 -0700
Jeff Johnson <quic_jjohnson@...cinc.com> wrote:
> make allmodconfig && make W=1 C=1 reports for lib/test_*.ko:
> WARNING: modpost: missing MODULE_DESCRIPTION() in lib/test_hexdump.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in lib/test_dhry.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in lib/test_firmware.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in lib/test_sysctl.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in lib/test_hash.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in lib/test_ida.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in lib/test_list_sort.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in lib/test_min_heap.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in lib/test_module.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in lib/test_sort.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in lib/test_static_keys.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in lib/test_static_key_base.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in lib/test_memcat_p.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in lib/test_blackhole_dev.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in lib/test_meminit.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in lib/test_free_pages.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in lib/test_kprobes.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in lib/test_ref_tracker.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in lib/test_bits.o
>
> Add the missing invocations of the MODULE_DESCRIPTION() macro.
>
> Signed-off-by: Jeff Johnson <quic_jjohnson@...cinc.com>
> ---
> Changes in v2:
> - Updated the description of lib/test_kprobes.c per Masami
Confirmed. Thanks!
Reviewed-by: Masami Hiramatsu (Google) <mhiramat@...nel.org>
> - Removed references to lib/test_user_copy since that is being renamed in
> https://lore.kernel.org/all/20240612195921.2685842-2-kees@kernel.org/
> and the description added in
> https://lore.kernel.org/all/20240619202659.work.532-kees@kernel.org/
> - Link to v1: https://lore.kernel.org/r/20240601-md-lib-test-v1-1-a728620e37d8@quicinc.com
> ---
> lib/dhry_run.c | 1 +
> lib/test-kstrtox.c | 1 +
> lib/test_bits.c | 1 +
> lib/test_blackhole_dev.c | 1 +
> lib/test_firmware.c | 1 +
> lib/test_free_pages.c | 1 +
> lib/test_hash.c | 1 +
> lib/test_hexdump.c | 1 +
> lib/test_ida.c | 1 +
> lib/test_kprobes.c | 3 ++-
> lib/test_list_sort.c | 1 +
> lib/test_memcat_p.c | 1 +
> lib/test_meminit.c | 1 +
> lib/test_min_heap.c | 1 +
> lib/test_module.c | 1 +
> lib/test_ref_tracker.c | 3 ++-
> lib/test_sort.c | 1 +
> lib/test_static_key_base.c | 1 +
> lib/test_static_keys.c | 1 +
> lib/test_sysctl.c | 1 +
> 20 files changed, 22 insertions(+), 2 deletions(-)
>
> diff --git a/lib/dhry_run.c b/lib/dhry_run.c
> index e6a279dabf84..4a6d05ce4361 100644
> --- a/lib/dhry_run.c
> +++ b/lib/dhry_run.c
> @@ -83,4 +83,5 @@ static int __init dhry_init(void)
> module_init(dhry_init);
>
> MODULE_AUTHOR("Geert Uytterhoeven <geert+renesas@...der.be>");
> +MODULE_DESCRIPTION("Dhrystone benchmark test module");
> MODULE_LICENSE("GPL");
> diff --git a/lib/test-kstrtox.c b/lib/test-kstrtox.c
> index f355f67169b6..ee87fef66cb5 100644
> --- a/lib/test-kstrtox.c
> +++ b/lib/test-kstrtox.c
> @@ -732,4 +732,5 @@ static int __init test_kstrtox_init(void)
> return -EINVAL;
> }
> module_init(test_kstrtox_init);
> +MODULE_DESCRIPTION("Module test for kstrto*() APIs");
> MODULE_LICENSE("Dual BSD/GPL");
> diff --git a/lib/test_bits.c b/lib/test_bits.c
> index c9368a2314e7..01313980f175 100644
> --- a/lib/test_bits.c
> +++ b/lib/test_bits.c
> @@ -72,4 +72,5 @@ static struct kunit_suite bits_test_suite = {
> };
> kunit_test_suite(bits_test_suite);
>
> +MODULE_DESCRIPTION("Test cases for functions and macros in bits.h");
> MODULE_LICENSE("GPL");
> diff --git a/lib/test_blackhole_dev.c b/lib/test_blackhole_dev.c
> index f247089d63c0..ec290ac2a0d9 100644
> --- a/lib/test_blackhole_dev.c
> +++ b/lib/test_blackhole_dev.c
> @@ -96,4 +96,5 @@ module_init(test_blackholedev_init);
> module_exit(test_blackholedev_exit);
>
> MODULE_AUTHOR("Mahesh Bandewar <maheshb@...gle.com>");
> +MODULE_DESCRIPTION("module test of the blackhole_dev");
> MODULE_LICENSE("GPL");
> diff --git a/lib/test_firmware.c b/lib/test_firmware.c
> index 9cfdcd6d21db..bcb32cbff188 100644
> --- a/lib/test_firmware.c
> +++ b/lib/test_firmware.c
> @@ -1567,4 +1567,5 @@ static void __exit test_firmware_exit(void)
> module_exit(test_firmware_exit);
>
> MODULE_AUTHOR("Kees Cook <keescook@...omium.org>");
> +MODULE_DESCRIPTION("interface to trigger and test firmware loading");
> MODULE_LICENSE("GPL");
> diff --git a/lib/test_free_pages.c b/lib/test_free_pages.c
> index 9ebf6f5549f3..48952364c540 100644
> --- a/lib/test_free_pages.c
> +++ b/lib/test_free_pages.c
> @@ -44,4 +44,5 @@ static void m_ex(void)
> module_init(m_in);
> module_exit(m_ex);
> MODULE_AUTHOR("Matthew Wilcox <willy@...radead.org>");
> +MODULE_DESCRIPTION("Check that free_pages() doesn't leak memory");
> MODULE_LICENSE("GPL");
> diff --git a/lib/test_hash.c b/lib/test_hash.c
> index bb25fda34794..a7af39662a0a 100644
> --- a/lib/test_hash.c
> +++ b/lib/test_hash.c
> @@ -235,4 +235,5 @@ static struct kunit_suite hash_test_suite = {
>
> kunit_test_suite(hash_test_suite);
>
> +MODULE_DESCRIPTION("Test cases for <linux/hash.h> and <linux/stringhash.h>");
> MODULE_LICENSE("GPL");
> diff --git a/lib/test_hexdump.c b/lib/test_hexdump.c
> index fe2682bb21e6..751645645988 100644
> --- a/lib/test_hexdump.c
> +++ b/lib/test_hexdump.c
> @@ -253,4 +253,5 @@ static void __exit test_hexdump_exit(void)
> module_exit(test_hexdump_exit);
>
> MODULE_AUTHOR("Andy Shevchenko <andriy.shevchenko@...ux.intel.com>");
> +MODULE_DESCRIPTION("Test cases for lib/hexdump.c module");
> MODULE_LICENSE("Dual BSD/GPL");
> diff --git a/lib/test_ida.c b/lib/test_ida.c
> index 072a49897e71..c80155a1956d 100644
> --- a/lib/test_ida.c
> +++ b/lib/test_ida.c
> @@ -214,4 +214,5 @@ static void ida_exit(void)
> module_init(ida_checks);
> module_exit(ida_exit);
> MODULE_AUTHOR("Matthew Wilcox <willy@...radead.org>");
> +MODULE_DESCRIPTION("Test the IDA API");
> MODULE_LICENSE("GPL");
> diff --git a/lib/test_kprobes.c b/lib/test_kprobes.c
> index 0648f7154f5c..b7582010125c 100644
> --- a/lib/test_kprobes.c
> +++ b/lib/test_kprobes.c
> @@ -1,6 +1,6 @@
> // SPDX-License-Identifier: GPL-2.0-or-later
> /*
> - * test_kprobes.c - simple sanity test for *probes
> + * test_kprobes.c - simple sanity test for k*probes
> *
> * Copyright IBM Corp. 2008
> */
> @@ -400,4 +400,5 @@ static struct kunit_suite kprobes_test_suite = {
>
> kunit_test_suites(&kprobes_test_suite);
>
> +MODULE_DESCRIPTION("simple sanity test for k*probes");
> MODULE_LICENSE("GPL");
> diff --git a/lib/test_list_sort.c b/lib/test_list_sort.c
> index cc5f335f29b5..30879abc8a42 100644
> --- a/lib/test_list_sort.c
> +++ b/lib/test_list_sort.c
> @@ -119,4 +119,5 @@ static struct kunit_suite list_sort_suite = {
>
> kunit_test_suites(&list_sort_suite);
>
> +MODULE_DESCRIPTION("list_sort() KUnit test suite");
> MODULE_LICENSE("GPL");
> diff --git a/lib/test_memcat_p.c b/lib/test_memcat_p.c
> index 849c477d49d0..7e0797a6bebf 100644
> --- a/lib/test_memcat_p.c
> +++ b/lib/test_memcat_p.c
> @@ -112,4 +112,5 @@ static void __exit test_memcat_p_exit(void)
> module_init(test_memcat_p_init);
> module_exit(test_memcat_p_exit);
>
> +MODULE_DESCRIPTION("Test cases for memcat_p() in lib/memcat_p.c");
> MODULE_LICENSE("GPL");
> diff --git a/lib/test_meminit.c b/lib/test_meminit.c
> index 0dc173849a54..6298f66c964b 100644
> --- a/lib/test_meminit.c
> +++ b/lib/test_meminit.c
> @@ -436,4 +436,5 @@ static int __init test_meminit_init(void)
> }
> module_init(test_meminit_init);
>
> +MODULE_DESCRIPTION("Test cases for SL[AOU]B/page initialization at alloc/free time");
> MODULE_LICENSE("GPL");
> diff --git a/lib/test_min_heap.c b/lib/test_min_heap.c
> index 7b01b4387cfb..a2dd478997bb 100644
> --- a/lib/test_min_heap.c
> +++ b/lib/test_min_heap.c
> @@ -191,4 +191,5 @@ static void __exit test_min_heap_exit(void)
> }
> module_exit(test_min_heap_exit);
>
> +MODULE_DESCRIPTION("Test cases for the min max heap");
> MODULE_LICENSE("GPL");
> diff --git a/lib/test_module.c b/lib/test_module.c
> index debd19e35198..3d1b29b74807 100644
> --- a/lib/test_module.c
> +++ b/lib/test_module.c
> @@ -31,4 +31,5 @@ static void __exit test_module_exit(void)
> module_exit(test_module_exit);
>
> MODULE_AUTHOR("Kees Cook <keescook@...omium.org>");
> +MODULE_DESCRIPTION("module loading subsystem test module");
> MODULE_LICENSE("GPL");
> diff --git a/lib/test_ref_tracker.c b/lib/test_ref_tracker.c
> index 49970a7c96f3..b983ceb12afc 100644
> --- a/lib/test_ref_tracker.c
> +++ b/lib/test_ref_tracker.c
> @@ -1,6 +1,6 @@
> // SPDX-License-Identifier: GPL-2.0-only
> /*
> - * Referrence tracker self test.
> + * Reference tracker self test.
> *
> * Copyright (c) 2021 Eric Dumazet <edumazet@...gle.com>
> */
> @@ -112,4 +112,5 @@ static void __exit test_ref_tracker_exit(void)
> module_init(test_ref_tracker_init);
> module_exit(test_ref_tracker_exit);
>
> +MODULE_DESCRIPTION("Reference tracker self test");
> MODULE_LICENSE("GPL v2");
> diff --git a/lib/test_sort.c b/lib/test_sort.c
> index be02e3a098cf..81aef88b48b5 100644
> --- a/lib/test_sort.c
> +++ b/lib/test_sort.c
> @@ -45,4 +45,5 @@ static struct kunit_suite sort_test_suite = {
>
> kunit_test_suites(&sort_test_suite);
>
> +MODULE_DESCRIPTION("sort() KUnit test suite");
> MODULE_LICENSE("GPL");
> diff --git a/lib/test_static_key_base.c b/lib/test_static_key_base.c
> index 5089a2e2bdd8..9f507672afa5 100644
> --- a/lib/test_static_key_base.c
> +++ b/lib/test_static_key_base.c
> @@ -57,4 +57,5 @@ module_init(test_static_key_base_init);
> module_exit(test_static_key_base_exit);
>
> MODULE_AUTHOR("Jason Baron <jbaron@...mai.com>");
> +MODULE_DESCRIPTION("Kernel module to support testing static keys");
> MODULE_LICENSE("GPL");
> diff --git a/lib/test_static_keys.c b/lib/test_static_keys.c
> index 42daa74be029..00c715f30df9 100644
> --- a/lib/test_static_keys.c
> +++ b/lib/test_static_keys.c
> @@ -236,4 +236,5 @@ module_init(test_static_key_init);
> module_exit(test_static_key_exit);
>
> MODULE_AUTHOR("Jason Baron <jbaron@...mai.com>");
> +MODULE_DESCRIPTION("Kernel module for testing static keys");
> MODULE_LICENSE("GPL");
> diff --git a/lib/test_sysctl.c b/lib/test_sysctl.c
> index 9321d850931f..b6696fa1d426 100644
> --- a/lib/test_sysctl.c
> +++ b/lib/test_sysctl.c
> @@ -280,4 +280,5 @@ static void __exit test_sysctl_exit(void)
> module_exit(test_sysctl_exit);
>
> MODULE_AUTHOR("Luis R. Rodriguez <mcgrof@...nel.org>");
> +MODULE_DESCRIPTION("proc sysctl test driver");
> MODULE_LICENSE("GPL");
>
> ---
> base-commit: b050496579632f86ee1ef7e7501906db579f3457
> change-id: 20240601-md-lib-test-16083d9d77e2
>
--
Masami Hiramatsu (Google) <mhiramat@...nel.org>
Powered by blists - more mailing lists