Skip to contentSkip to conversation

nfsd: add a MODULE_DESCRIPTION

PATCH Applied Jeff Layton 5 participants 6 messages Jul 20, 2023 – Jul 21, 2023

Subsystems (2)
lore
Share & tools
lore

Jeff Layton

author maintainer
#0 lore raw

PATCH 1/1 nfsd: add a MODULE_DESCRIPTION

I got this today from modpost:

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

Add a module description.

---
 fs/nfsd/nfsctl.c | 1 +
 1 file changed, 1 insertion(+)
fs/nfsd/nfsctl.c +1 -0
index 1b8b1aab9a15..7070969a38b5 100644
@@ -1626,6 +1626,7 @@ static void __exit exit_nfsd(void)
 }
 
 MODULE_AUTHOR("Olaf Kirch <[email protected]>");
+MODULE_DESCRIPTION("The Linux kernel NFS server");
 MODULE_LICENSE("GPL");
 module_init(init_nfsd)
 module_exit(exit_nfsd)
Signature · 1 line
2.41.0
#1 lore raw
Quoted 30 lines · Jeff Layton

I got this today from modpost:

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

Add a module description.

---
fs/nfsd/nfsctl.c | 1 +

1 file changed, 1 insertion(+)
fs/nfsd/nfsctl.c +1 -0
index 1b8b1aab9a15..7070969a38b5 100644
@@ -1626,6 +1626,7 @@ static void __exit exit_nfsd(void)
 }
 
 MODULE_AUTHOR("Olaf Kirch <[email protected]>");
+MODULE_DESCRIPTION("The Linux kernel NFS server");
 MODULE_LICENSE("GPL");
 module_init(init_nfsd)
 module_exit(exit_nfsd)
Signature · 1 line
2.41.0

Applied to nfsd-next. If you have a lore.kernel.org link, please pass it along and I will add it.

--
Chuck Lever

#2 lore raw
In reply to Jeff Layton
Quoted 16 lines · Jeff Layton

I got this today from modpost:

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

Add a module description.

---
 fs/nfsd/nfsctl.c | 1 +
 1 file changed, 1 insertion(+)
fs/nfsd/nfsctl.c +0 -0
index 1b8b1aab9a15..7070969a38b5 100644

fs/nfsd/nfsctl.c static void __exit exit_nfsd(void) · line 1629

Quoted 4 lines
fs/nfsd/nfsctl.c +1 -0
@@ -1626,6 +1626,7 @@ static void __exit exit_nfsd(void)
 }
 
 MODULE_AUTHOR("Olaf Kirch <[email protected]>");
+MODULE_DESCRIPTION("The Linux kernel NFS server");

Of 9176 MODULE_DESCRIPTIONs in Linux, 21 start with "The ". Does having that word add anything useful?
Amusingly 129 end with a period. I wonder what Jon Corbet would prefer :-)

A few tell us what the module does.
"Measures" "Provides"....
Do we want "Implements" ??

232 start "Driver " and 214 are "Driver for"....
Should we have "Server for" ??

26 start "Linux" ... which seems a bit redundant
12 contain "for Linux". 67 mention linux in some way.
28 contain the word "kernel" - also redundant. Only three (others) mention "Linux kernel"

drivers/pcmcia/cs.c:MODULE_DESCRIPTION("Linux Kernel Card Services"); fs/ksmbd/server.c:MODULE_DESCRIPTION("Linux kernel CIFS/SMB SERVER"); fs/orangefs/orangefs-mod.c:MODULE_DESCRIPTION("The Linux Kernel VFS interface to ORANGEFS");

hmmm.. 192 contain the word "module". Fortunately none say
"Linux kernel module for ..."
I would have found that to be a step too far.

I'd like to suggest

"Implements Server for NFS - v2, 3, v4.{0,1,2}"

But that would require excessive #ifdef magic to get right.

A small part of me wants to suggest:

"nfsd"

but maybe I'm just in a whimsical mood today.

NeilBrown

Quoted 7 lines
fs/nfsd/nfsctl.c +0 -0
 MODULE_LICENSE("GPL");
 module_init(init_nfsd)
 module_exit(exit_nfsd)
Signature · 1 line
2.41.0
maintainer
#3 lore raw
Quoted 19 lines · NeilBrown
Quoted 18 lines · Jeff Layton

I got this today from modpost:

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

Add a module description.

---
 fs/nfsd/nfsctl.c | 1 +
 1 file changed, 1 insertion(+)
fs/nfsd/nfsctl.c +0 -0
index 1b8b1aab9a15..7070969a38b5 100644
@@ -1626,6 +1626,7 @@ static void __exit exit_nfsd(void)
 }
 
Quoted 7 lines

fs/nfsd/nfsctl.c static void __exit exit_nfsd(void) · line 1629

Quoted 2 lines
fs/nfsd/nfsctl.c +1 -0
 MODULE_AUTHOR("Olaf Kirch <[email protected]>");
+MODULE_DESCRIPTION("The Linux kernel NFS server");

Of 9176 MODULE_DESCRIPTIONs in Linux, 21 start with "The ". Does having that word add anything useful?
Amusingly 129 end with a period. I wonder what Jon Corbet would prefer :-)

The Ohio State University has set a bad precedent.

I think we can drop "The".

Quoted 3 lines

A few tell us what the module does.
"Measures" "Provides"....
Do we want "Implements" ??

I don't find "Implements" to be either conventional or illuminating.

Quoted 7 lines

232 start "Driver " and 214 are "Driver for"....
Should we have "Server for" ??

26 start "Linux" ... which seems a bit redundant
12 contain "for Linux". 67 mention linux in some way.
28 contain the word "kernel" - also redundant. Only three (others) mention "Linux kernel"

One of which is the new in-kernel SMB server, interestingly.

I don't think "Linux kernel" or even "in-kernel" is needed here. Both should be obvious from the context.

Quoted 8 lines

drivers/pcmcia/cs.c:MODULE_DESCRIPTION("Linux Kernel Card Services"); fs/ksmbd/server.c:MODULE_DESCRIPTION("Linux kernel CIFS/SMB SERVER"); fs/orangefs/orangefs-mod.c:MODULE_DESCRIPTION("The Linux Kernel VFS interface to ORANGEFS");

hmmm.. 192 contain the word "module". Fortunately none say
"Linux kernel module for ..."
I would have found that to be a step too far.

Quoted 5 lines

I'd like to suggest

"Implements Server for NFS - v2, 3, v4.{0,1,2}"

But that would require excessive #ifdef magic to get right.

"Network File System server" works for me.

Quoted 5 lines

A small part of me wants to suggest:

   "nfsd"

but maybe I'm just in a whimsical mood today.

I'm resisting the urge to add "RFCs 1813, 7530, 8881, et al." Whimsy, indeed. ;-)

Quoted 11 lines

NeilBrown

Quoted 7 lines
fs/nfsd/nfsctl.c +0 -0
 MODULE_LICENSE("GPL");
 module_init(init_nfsd)
 module_exit(exit_nfsd)
Signature · 1 line
2.41.0
reviewer
#4 lore raw

Personally I like Jeff's text. There's zero need to overthink this.

Jul 20, 2023 7:30:34 PM Chuck Lever <[email protected]>:

Quoted 92 lines · NeilBrown
Quoted 19 lines · Jeff Layton
Quoted 18 lines

I got this today from modpost:

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

Add a module description.

---
fs/nfsd/nfsctl.c | 1 +

1 file changed, 1 insertion(+)
fs/nfsd/nfsctl.c +0 -0
index 1b8b1aab9a15..7070969a38b5 100644
@@ -1626,6 +1626,7 @@ static void __exit exit_nfsd(void)
 }
 
Quoted 7 lines

fs/nfsd/nfsctl.c static void __exit exit_nfsd(void) · line 1629

Quoted 2 lines
fs/nfsd/nfsctl.c +1 -0
 MODULE_AUTHOR("Olaf Kirch <[email protected]>");
+MODULE_DESCRIPTION("The Linux kernel NFS server");

Of 9176 MODULE_DESCRIPTIONs in Linux, 21 start with "The ". Does having that word add anything useful?
Amusingly 129 end with a period.  I wonder what Jon Corbet would prefer :-)

The Ohio State University has set a bad precedent.

I think we can drop "The".

Quoted 3 lines

A few tell us what the module does.
"Measures" "Provides"....
Do we want "Implements" ??

I don't find "Implements" to be either conventional or illuminating.

Quoted 7 lines

232 start "Driver " and 214 are "Driver for"....
Should we have "Server for" ??

26 start "Linux" ... which seems a bit redundant 12 contain "for Linux".  67 mention linux in some way. 28 contain the word "kernel" - also redundant. Only three (others) mention "Linux kernel"

One of which is the new in-kernel SMB server, interestingly.

I don't think "Linux kernel" or even "in-kernel" is needed here. Both should be obvious from the context.

Quoted 8 lines

drivers/pcmcia/cs.c:MODULE_DESCRIPTION("Linux Kernel Card Services"); fs/ksmbd/server.c:MODULE_DESCRIPTION("Linux kernel CIFS/SMB SERVER"); fs/orangefs/orangefs-mod.c:MODULE_DESCRIPTION("The Linux Kernel VFS interface to ORANGEFS");

hmmm..  192 contain the word "module".  Fortunately none say "Linux kernel module for ..."
I would have found that to be a step too far.

Quoted 5 lines

I'd like to suggest

  "Implements Server for NFS - v2, 3, v4.{0,1,2}"

But that would require excessive #ifdef magic to get right.

"Network File System server" works for me.

Quoted 5 lines

A small part of me wants to suggest:

   "nfsd"

but maybe I'm just in a whimsical mood today.

I'm resisting the urge to add "RFCs 1813, 7530, 8881, et al." Whimsy, indeed. ;-)

Quoted 11 lines

NeilBrown

Quoted 7 lines
fs/nfsd/nfsctl.c +0 -0
 MODULE_LICENSE("GPL");
 module_init(init_nfsd)
 module_exit(exit_nfsd)
Signature · 1 line
2.41.0
author maintainer
#5 lore raw
Quoted 2 lines · Tom Talpey

Personally I like Jeff's text. There's zero need to overthink this.

It's like this patch was tailor-made for bikeshedding. ;)

Personally, I'm fine with any reasonable string here. My main concern was just to silence the warning.

Quoted 94 lines

Jul 20, 2023 7:30:34 PM Chuck Lever <[email protected]>:

Quoted 92 lines · NeilBrown
Quoted 19 lines · Jeff Layton
Quoted 18 lines

I got this today from modpost:

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

Add a module description.

---
fs/nfsd/nfsctl.c | 1 +

1 file changed, 1 insertion(+)
fs/nfsd/nfsctl.c +0 -0
index 1b8b1aab9a15..7070969a38b5 100644
@@ -1626,6 +1626,7 @@ static void __exit exit_nfsd(void)
 }
 
Quoted 7 lines

fs/nfsd/nfsctl.c static void __exit exit_nfsd(void) · line 1629

Quoted 2 lines
fs/nfsd/nfsctl.c +1 -0
 MODULE_AUTHOR("Olaf Kirch <[email protected]>");
+MODULE_DESCRIPTION("The Linux kernel NFS server");

Of 9176 MODULE_DESCRIPTIONs in Linux, 21 start with "The ". Does having that word add anything useful?
Amusingly 129 end with a period.  I wonder what Jon Corbet would prefer :-)

The Ohio State University has set a bad precedent.

I think we can drop "The".

Quoted 3 lines

A few tell us what the module does.
"Measures" "Provides"....
Do we want "Implements" ??

I don't find "Implements" to be either conventional or illuminating.

Quoted 7 lines

232 start "Driver " and 214 are "Driver for"....
Should we have "Server for" ??

26 start "Linux" ... which seems a bit redundant 12 contain "for Linux".  67 mention linux in some way. 28 contain the word "kernel" - also redundant. Only three (others) mention "Linux kernel"

One of which is the new in-kernel SMB server, interestingly.

I don't think "Linux kernel" or even "in-kernel" is needed here. Both should be obvious from the context.

Quoted 8 lines

drivers/pcmcia/cs.c:MODULE_DESCRIPTION("Linux Kernel Card Services"); fs/ksmbd/server.c:MODULE_DESCRIPTION("Linux kernel CIFS/SMB SERVER"); fs/orangefs/orangefs-mod.c:MODULE_DESCRIPTION("The Linux Kernel VFS interface to ORANGEFS");

hmmm..  192 contain the word "module".  Fortunately none say "Linux kernel module for ..."
I would have found that to be a step too far.

Quoted 5 lines

I'd like to suggest

  "Implements Server for NFS - v2, 3, v4.{0,1,2}"

But that would require excessive #ifdef magic to get right.

"Network File System server" works for me.

Quoted 5 lines

A small part of me wants to suggest:

   "nfsd"

but maybe I'm just in a whimsical mood today.

I'm resisting the urge to add "RFCs 1813, 7530, 8881, et al." Whimsy, indeed. ;-)

Quoted 11 lines

NeilBrown

Quoted 7 lines
fs/nfsd/nfsctl.c +0 -0
 MODULE_LICENSE("GPL");
 module_init(init_nfsd)
 module_exit(exit_nfsd)
Signature · 1 line
2.41.0
Signature · 1 line
Jeff Layton <[email protected]>