[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-id: <168989083691.11078.1519785551812636491@noble.neil.brown.name>
Date: Fri, 21 Jul 2023 08:07:16 +1000
From: "NeilBrown" <neilb@...e.de>
To: "Jeff Layton" <jlayton@...nel.org>,
Jonathan Corbet <corbet@....net>
Cc: "Chuck Lever" <chuck.lever@...cle.com>,
"Olga Kornievskaia" <kolga@...app.com>,
"Dai Ngo" <Dai.Ngo@...cle.com>, "Tom Talpey" <tom@...pey.com>,
linux-nfs@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] nfsd: add a MODULE_DESCRIPTION
On Thu, 20 Jul 2023, Jeff Layton wrote:
> I got this today from modpost:
>
> WARNING: modpost: missing MODULE_DESCRIPTION() in fs/nfsd/nfsd.o
>
> Add a module description.
>
> Signed-off-by: Jeff Layton <jlayton@...nel.org>
> ---
> fs/nfsd/nfsctl.c | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/fs/nfsd/nfsctl.c b/fs/nfsd/nfsctl.c
> index 1b8b1aab9a15..7070969a38b5 100644
> --- a/fs/nfsd/nfsctl.c
> +++ b/fs/nfsd/nfsctl.c
> @@ -1626,6 +1626,7 @@ static void __exit exit_nfsd(void)
> }
>
> MODULE_AUTHOR("Olaf Kirch <okir@...ad.swb.de>");
> +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
> MODULE_LICENSE("GPL");
> module_init(init_nfsd)
> module_exit(exit_nfsd)
> --
> 2.41.0
>
>
Powered by blists - more mailing lists