Skip to contentSkip to conversation

exportfs: add module description

PATCH Applied Arnd Bergmann 9 participants 18 messages Mar 24, 2025 – Apr 25, 2025

Subsystems (14)

v1 of 2 Applied 8/10 Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/10 exportfs: add module description

From: Arnd Bergmann <[email protected]>

Every loadable module should have a description, to avoid a warning such as:

WARNING: modpost: missing MODULE_DESCRIPTION() in fs/exportfs/exportfs.o

---
 fs/exportfs/expfs.c | 1 +
 1 file changed, 1 insertion(+)
fs/exportfs/expfs.c +1 -0
index b5845c4846b8..8a5f42c620af 100644
@@ -608,4 +608,5 @@ struct dentry *exportfs_decode_fh(struct vfsmount *mnt, struct fid *fid,
 }
 EXPORT_SYMBOL_GPL(exportfs_decode_fh);
 
+MODULE_DESCRIPTION("Code mapping from inodes to NFS file handles");
 MODULE_LICENSE("GPL");
Signature · 1 line
2.39.5
#1 lore raw

PATCH 2/10 ASN.1: add module description

From: Arnd Bergmann <[email protected]>

This is needed to avoid a build warning:

WARNING: modpost: missing MODULE_DESCRIPTION() in lib/asn1_decoder.o

---
 lib/asn1_decoder.c | 1 +
 1 file changed, 1 insertion(+)
lib/asn1_decoder.c +1 -0
index 13da529e2e72..5738ae286b41 100644
@@ -518,4 +518,5 @@ int asn1_ber_decoder(const struct asn1_decoder *decoder,
 }
 EXPORT_SYMBOL_GPL(asn1_ber_decoder);
 
+MODULE_DESCRIPTION("Decoder for ASN.1 BER/DER/CER encoded bytestream");
 MODULE_LICENSE("GPL");
Signature · 1 line
2.39.5
Tested-by on v1 2/10
#2 lore raw

Re: [PATCH 02/10] ASN.1: add module description

Hi Arnd,

Quoted 7 lines · Arnd Bergmann

From: Arnd Bergmann <[email protected]>

This is needed to avoid a build warning:

WARNING: modpost: missing MODULE_DESCRIPTION() in lib/asn1_decoder.o

Thank, this fixes build issues in the m68k defconfigs

lib/asn1_decoder.c int asn1_ber_decoder(const struct asn1_decoder *decoder, · line 522

Quoted 8 lines
lib/asn1_decoder.c +1 -0
@@ -518,4 +518,5 @@ int asn1_ber_decoder(const struct asn1_decoder *decoder,
 }
 EXPORT_SYMBOL_GPL(asn1_ber_decoder);
 
+MODULE_DESCRIPTION("Decoder for ASN.1 BER/DER/CER encoded bytestream");
 MODULE_LICENSE("GPL");

Gr{oetje,eeting}s,

Geert

--
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- [email protected]

In personal conversations with technical people, I call myself a hacker. But when I'm talking to journalists I just say "programmer" or something like that.
-- Linus Torvalds

#3 lore raw

PATCH 3/10 samples/livepatch: add module descriptions

In reply to Arnd Bergmann

From: Arnd Bergmann <[email protected]>

Every module should have a description, so add one for each of these modules.

---
 samples/livepatch/livepatch-callbacks-busymod.c | 1 +
 samples/livepatch/livepatch-callbacks-demo.c    | 1 +
 samples/livepatch/livepatch-callbacks-mod.c     | 1 +
 samples/livepatch/livepatch-sample.c            | 1 +
 samples/livepatch/livepatch-shadow-fix1.c       | 1 +
 samples/livepatch/livepatch-shadow-fix2.c       | 1 +
 6 files changed, 6 insertions(+)
samples/livepatch/livepatch-callbacks-busymod.c +1 -0
index 69105596e72e..4d6030739fcb 100644
@@ -56,4 +56,5 @@ static void livepatch_callbacks_mod_exit(void)
 
 module_init(livepatch_callbacks_mod_init);
 module_exit(livepatch_callbacks_mod_exit);
+MODULE_DESCRIPTION("Live patching demo for (un)patching callbacks");
 MODULE_LICENSE("GPL");
samples/livepatch/livepatch-callbacks-demo.c +1 -0
index 11c3f4357812..9e69d9caed25 100644
@@ -192,5 +192,6 @@ static void livepatch_callbacks_demo_exit(void)
 
 module_init(livepatch_callbacks_demo_init);
 module_exit(livepatch_callbacks_demo_exit);
+MODULE_DESCRIPTION("Live patching demo for (un)patching callbacks");
 MODULE_LICENSE("GPL");
 MODULE_INFO(livepatch, "Y");
samples/livepatch/livepatch-callbacks-mod.c +1 -0
index 2a074f422a51..d1851b471ad9 100644
@@ -38,4 +38,5 @@ static void livepatch_callbacks_mod_exit(void)
 
 module_init(livepatch_callbacks_mod_init);
 module_exit(livepatch_callbacks_mod_exit);
+MODULE_DESCRIPTION("Live patching demo for (un)patching callbacks, support module");
 MODULE_LICENSE("GPL");
samples/livepatch/livepatch-sample.c +1 -0
index cd76d7ebe598..5263a2f31c48 100644
@@ -66,5 +66,6 @@ static void livepatch_exit(void)
 
 module_init(livepatch_init);
 module_exit(livepatch_exit);
+MODULE_DESCRIPTION("Kernel Live Patching Sample Module");
 MODULE_LICENSE("GPL");
 MODULE_INFO(livepatch, "Y");
samples/livepatch/livepatch-shadow-fix1.c +1 -0
index f3f153895d6c..cbf68ca40097 100644
@@ -168,5 +168,6 @@ static void livepatch_shadow_fix1_exit(void)
 
 module_init(livepatch_shadow_fix1_init);
 module_exit(livepatch_shadow_fix1_exit);
+MODULE_DESCRIPTION("Live patching demo for shadow variables");
 MODULE_LICENSE("GPL");
 MODULE_INFO(livepatch, "Y");
samples/livepatch/livepatch-shadow-fix2.c +1 -0
index 361046a4f10c..b99122cb221f 100644
@@ -128,5 +128,6 @@ static void livepatch_shadow_fix2_exit(void)
 
 module_init(livepatch_shadow_fix2_init);
 module_exit(livepatch_shadow_fix2_exit);
+MODULE_DESCRIPTION("Live patching demo for shadow variables");
 MODULE_LICENSE("GPL");
 MODULE_INFO(livepatch, "Y");
Signature · 1 line
2.39.5
maintainer Reviewed-by on v1 3/10
#4 lore raw

Re: [PATCH 03/10] samples/livepatch: add module descriptions

samples/livepatch/livepatch-callbacks-busymod.c static void livepatch_callbacks_mod_exit(void) · line 59

Quoted 11 lines · Arnd Bergmann

From: Arnd Bergmann <[email protected]>

Every module should have a description, so add one for each of these modules.

samples/livepatch/livepatch-callbacks-busymod.c +1 -0
@@ -56,4 +56,5 @@ static void livepatch_callbacks_mod_exit(void)
 
 module_init(livepatch_callbacks_mod_init);
 module_exit(livepatch_callbacks_mod_exit);
+MODULE_DESCRIPTION("Live patching demo for (un)patching callbacks");

This is another support module similar to livepatch-callbacks-mod.c. I would use the same description, here:

MODULE_DESCRIPTION("Live patching demo for (un)patching callbacks, support module");

Quoted 17 lines
samples/livepatch/livepatch-callbacks-busymod.c +0 -0
 MODULE_LICENSE("GPL");
samples/livepatch/livepatch-callbacks-demo.c +1 -0
index 11c3f4357812..9e69d9caed25 100644
@@ -192,5 +192,6 @@ static void livepatch_callbacks_demo_exit(void)
 
 module_init(livepatch_callbacks_demo_init);
 module_exit(livepatch_callbacks_demo_exit);
+MODULE_DESCRIPTION("Live patching demo for (un)patching callbacks");
 MODULE_LICENSE("GPL");
 MODULE_INFO(livepatch, "Y");
samples/livepatch/livepatch-callbacks-mod.c +0 -0
index 2a074f422a51..d1851b471ad9 100644

samples/livepatch/livepatch-callbacks-mod.c static void livepatch_callbacks_mod_exit(void) · line 42

Quoted 5 lines
samples/livepatch/livepatch-callbacks-mod.c +1 -0
@@ -38,4 +38,5 @@ static void livepatch_callbacks_mod_exit(void)
 
 module_init(livepatch_callbacks_mod_init);
 module_exit(livepatch_callbacks_mod_exit);
+MODULE_DESCRIPTION("Live patching demo for (un)patching callbacks, support module");
 MODULE_LICENSE("GPL");

The rest looks good. With the above change:

Thanks a lot for fixing this.

Arnd, should I push this via the livepatch tree or would you prefer to push the entire patchset together? Both ways work for me.

Best Regards,
Petr

#5 lore raw

Re: [PATCH 03/10] samples/livepatch: add module descriptions

Quoted 2 lines · Petr Mladek

Arnd, should I push this via the livepatch tree or would you prefer to push the entire patchset together? Both ways work for me.

My past experience was to let individual maintainers take the ones that apply to their trees, and then Andrew can pick up the stragglers.

/jeff

#6 lore raw

PATCH 4/10 fpga: tests: add module descriptions

In reply to Arnd Bergmann

From: Arnd Bergmann <[email protected]>

Modules without a description now cause a warning:

WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/fpga/tests/fpga-bridge-test.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/fpga/tests/fpga-mgr-test.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/fpga/tests/fpga-region-test.o

---
 drivers/fpga/tests/fpga-bridge-test.c | 1 +
 drivers/fpga/tests/fpga-mgr-test.c    | 1 +
 drivers/fpga/tests/fpga-region-test.c | 1 +
 3 files changed, 3 insertions(+)
drivers/fpga/tests/fpga-bridge-test.c +1 -0
index b9ab29809e96..124ba40e32b1 100644
@@ -170,4 +170,5 @@ static struct kunit_suite fpga_bridge_suite = {
 
 kunit_test_suite(fpga_bridge_suite);
 
+MODULE_DESCRIPTION("KUnit test for the FPGA Bridge");
 MODULE_LICENSE("GPL");
drivers/fpga/tests/fpga-mgr-test.c +1 -0
index 9cb37aefbac4..8748babb0504 100644
@@ -330,4 +330,5 @@ static struct kunit_suite fpga_mgr_suite = {
 
 kunit_test_suite(fpga_mgr_suite);
 
+MODULE_DESCRIPTION("KUnit test for the FPGA Manager");
 MODULE_LICENSE("GPL");
drivers/fpga/tests/fpga-region-test.c +1 -0
index 6a108cafded8..020ceac48509 100644
@@ -214,4 +214,5 @@ static struct kunit_suite fpga_region_suite = {
 
 kunit_test_suite(fpga_region_suite);
 
+MODULE_DESCRIPTION("KUnit test for the FPGA Region");
 MODULE_LICENSE("GPL");
Signature · 1 line
2.39.5
Reviewed-by on v1 4/10
#7 lore raw

Re: [PATCH 04/10] fpga: tests: add module descriptions

Quoted 9 lines · Arnd Bergmann

From: Arnd Bergmann <[email protected]>

Modules without a description now cause a warning:

WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/fpga/tests/fpga-bridge-test.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/fpga/tests/fpga-mgr-test.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/fpga/tests/fpga-region-test.o

Quoted 36 lines
---
 drivers/fpga/tests/fpga-bridge-test.c | 1 +
 drivers/fpga/tests/fpga-mgr-test.c    | 1 +
 drivers/fpga/tests/fpga-region-test.c | 1 +
 3 files changed, 3 insertions(+)
drivers/fpga/tests/fpga-bridge-test.c +1 -0
index b9ab29809e96..124ba40e32b1 100644
@@ -170,4 +170,5 @@ static struct kunit_suite fpga_bridge_suite = {
 
 kunit_test_suite(fpga_bridge_suite);
 
+MODULE_DESCRIPTION("KUnit test for the FPGA Bridge");
 MODULE_LICENSE("GPL");
drivers/fpga/tests/fpga-mgr-test.c +1 -0
index 9cb37aefbac4..8748babb0504 100644
@@ -330,4 +330,5 @@ static struct kunit_suite fpga_mgr_suite = {
 
 kunit_test_suite(fpga_mgr_suite);
 
+MODULE_DESCRIPTION("KUnit test for the FPGA Manager");
 MODULE_LICENSE("GPL");
drivers/fpga/tests/fpga-region-test.c +1 -0
index 6a108cafded8..020ceac48509 100644
@@ -214,4 +214,5 @@ static struct kunit_suite fpga_region_suite = {
 
 kunit_test_suite(fpga_region_suite);
 
+MODULE_DESCRIPTION("KUnit test for the FPGA Region");
 MODULE_LICENSE("GPL");
Acked-by Applied
#8 lore raw

Re: [PATCH 04/10] fpga: tests: add module descriptions

Quoted 6 lines · Marco Pagani
Quoted 4 lines · Arnd Bergmann

From: Arnd Bergmann <[email protected]>

Modules without a description now cause a warning:

Quoted 7 lines
Quoted 5 lines

WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/fpga/tests/fpga-bridge-test.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/fpga/tests/fpga-mgr-test.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/fpga/tests/fpga-region-test.o

Applied to for-next.

#9 lore raw

PATCH 5/10 xenbus: add module description

In reply to Arnd Bergmann

From: Arnd Bergmann <[email protected]>

Modules without a description now cause a warning:

WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/xen/xenbus/xenbus_probe_frontend.o

---
 drivers/xen/xenbus/xenbus_probe_frontend.c | 1 +
 1 file changed, 1 insertion(+)
drivers/xen/xenbus/xenbus_probe_frontend.c +1 -0
index fcb335bb7b18..8b75f8234baf 100644
@@ -513,4 +513,5 @@ static int __init boot_wait_for_devices(void)
 late_initcall(boot_wait_for_devices);
 #endif
 
+MODULE_DESCRIPTION("Frontend for Xen bus probe");
 MODULE_LICENSE("GPL");
Signature · 1 line
2.39.5
maintainer
#10 lore raw

Re: [PATCH 05/10] xenbus: add module description

Quoted 16 lines · Arnd Bergmann

From: Arnd Bergmann <[email protected]>

Modules without a description now cause a warning:

WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/xen/xenbus/xenbus_probe_frontend.o

---
  drivers/xen/xenbus/xenbus_probe_frontend.c | 1 +
  1 file changed, 1 insertion(+)
drivers/xen/xenbus/xenbus_probe_frontend.c +0 -0
index fcb335bb7b18..8b75f8234baf 100644

drivers/xen/xenbus/xenbus_probe_frontend.c static int __init boot_wait_for_devices(void) · line 516

Quoted 4 lines
drivers/xen/xenbus/xenbus_probe_frontend.c +1 -0
@@ -513,4 +513,5 @@ static int __init boot_wait_for_devices(void)
  late_initcall(boot_wait_for_devices);
  #endif
 
+MODULE_DESCRIPTION("Frontend for Xen bus probe");

May I suggest "Xen PV-device frontend support" instead?

Juergen

#11 lore raw

PATCH 6/10 zlib: add module description

In reply to Arnd Bergmann

From: Arnd Bergmann <[email protected]>

Modules without a description now cause a warning:

WARNING: modpost: missing MODULE_DESCRIPTION() in lib/zlib_inflate/zlib_inflate.o

---
 lib/zlib_inflate/inflate_syms.c | 1 +
 1 file changed, 1 insertion(+)
lib/zlib_inflate/inflate_syms.c +1 -0
index 9720114c0672..b8996d90e8bc 100644
@@ -18,4 +18,5 @@ EXPORT_SYMBOL(zlib_inflateEnd);
 EXPORT_SYMBOL(zlib_inflateReset);
 EXPORT_SYMBOL(zlib_inflateIncomp); 
 EXPORT_SYMBOL(zlib_inflate_blob);
+MODULE_DESCRIPTION("Data decompression using the deflation algorithm");
 MODULE_LICENSE("GPL");
Signature · 1 line
2.39.5
#12 lore raw

PATCH 7/10 ucs2_string: add module description

In reply to Arnd Bergmann

From: Arnd Bergmann <[email protected]>

Modules without a description now cause a warning:

WARNING: modpost: missing MODULE_DESCRIPTION() in lib/ucs2_string.o

---
 lib/ucs2_string.c | 1 +
 1 file changed, 1 insertion(+)
lib/ucs2_string.c +1 -0
index 9308bcfb2ad5..dfb4f2358cab 100644
@@ -165,4 +165,5 @@ ucs2_as_utf8(u8 *dest, const ucs2_char_t *src, unsigned long maxlength)
 }
 EXPORT_SYMBOL(ucs2_as_utf8);
 
+MODULE_DESCRIPTION("UCS2 string handling");
 MODULE_LICENSE("GPL v2");
Signature · 1 line
2.39.5
#13 lore raw

PATCH 8/10 kunit: add module description for backtrace suppression test

In reply to Arnd Bergmann

From: Arnd Bergmann <[email protected]>

The module was added but has no description:

WARNING: modpost: missing MODULE_DESCRIPTION() in lib/kunit/backtrace-suppression-test.o

Fixes ebf1c420422a ("kunit: add test cases for backtrace warning suppression")
---
 lib/kunit/backtrace-suppression-test.c | 1 +
 1 file changed, 1 insertion(+)
lib/kunit/backtrace-suppression-test.c +1 -0
index 8b4125af2481..1ceb30c736d7 100644
@@ -102,3 +102,4 @@ static struct kunit_suite backtrace_suppression_test_suite = {
 kunit_test_suites(&backtrace_suppression_test_suite);
 
 MODULE_LICENSE("GPL");
+MODULE_DESCRIPTION("KUnit test for suppressing warning tracebacks");
Signature · 1 line
2.39.5
#14 lore raw

PATCH 9/10 mm/kasan: add module decription

In reply to Arnd Bergmann

From: Arnd Bergmann <[email protected]>

Modules without a description now cause a warning:

WARNING: modpost: missing MODULE_DESCRIPTION() in mm/kasan/kasan_test.o

---
 mm/kasan/kasan_test_c.c | 1 +
 1 file changed, 1 insertion(+)
mm/kasan/kasan_test_c.c +1 -0
index 59d673400085..710684ffe302 100644
@@ -2130,4 +2130,5 @@ static struct kunit_suite kasan_kunit_test_suite = {
 
 kunit_test_suite(kasan_kunit_test_suite);
 
+MODULE_DESCRIPTION("kunit test case for kasan");
 MODULE_LICENSE("GPL");
Signature · 1 line
2.39.5
reviewer Reviewed-by on v1 9/10
#15 lore raw

Re: [PATCH 09/10] mm/kasan: add module decription

Quoted 23 lines · Arnd Bergmann' via kasan-dev

From: Arnd Bergmann <[email protected]>

Modules without a description now cause a warning:

WARNING: modpost: missing MODULE_DESCRIPTION() in mm/kasan/kasan_test.o

---
 mm/kasan/kasan_test_c.c | 1 +
 1 file changed, 1 insertion(+)
mm/kasan/kasan_test_c.c +1 -1
index 59d673400085..710684ffe302 100644
@@ -2130,4 +2130,5 @@ static struct kunit_suite kasan_kunit_test_suite = {
 
 kunit_test_suite(kasan_kunit_test_suite);
 
+MODULE_DESCRIPTION("kunit test case for kasan");
 MODULE_LICENSE("GPL");
--
Quoted 1 line

2.39.5

But just in case you end up sending a v2, let's change the text to "KUnit tests for checking KASAN bug-detection capabilities".

Thank you!

#16 lore raw

PATCH 10/10 kunit: slub: add module description

In reply to Arnd Bergmann

From: Arnd Bergmann <[email protected]>

Modules without a description now cause a warning:

WARNING: modpost: missing MODULE_DESCRIPTION() in lib/tests/slub_kunit.o

---
 lib/tests/slub_kunit.c | 1 +
 1 file changed, 1 insertion(+)
lib/tests/slub_kunit.c +1 -0
index d47c472b0520..848b682a2d70 100644
@@ -325,4 +325,5 @@ static struct kunit_suite test_suite = {
 };
 kunit_test_suite(test_suite);
 
+MODULE_DESCRIPTION("Kunit tests for slub allocator");
 MODULE_LICENSE("GPL");
Signature · 1 line
2.39.5
maintainer Applied
#17 lore raw

Re: (subset) [PATCH 01/10] exportfs: add module description

In reply to Arnd Bergmann
Quoted 5 lines · Arnd Bergmann

Every loadable module should have a description, to avoid a warning such as:

WARNING: modpost: missing MODULE_DESCRIPTION() in fs/exportfs/exportfs.o

I've removed mentioning of NFS from the module description because exportfs is now used for a lot more.

---

Applied to the vfs.fixes branch of the vfs/vfs.git tree. Patches in the vfs.fixes branch should appear in linux-next soon.

Please report any outstanding bugs that were missed during review in a new review to the original patch series allowing us to drop it.

It's encouraged to provide Acked-bys and Reviewed-bys even though the patch has now been applied. If possible patch trailers will be updated.

Note that commit hashes shown below are subject to change due to rebase, trailer updates or similar. If in doubt, please check the listed branch.

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/vfs/vfs.git
branch: vfs.fixes

[01/10] exportfs: add module description

        https://git.kernel.org/vfs/vfs/c/e3206c4aa06f