Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
From:   "NeilBrown" <neilb@suse.de>
To:     "Jeff Layton" <jlayton@kernel.org>,
        Jonathan Corbet <corbet@lwn.net>
Cc:     "Chuck Lever" <chuck.lever@oracle.com>,
        "Olga Kornievskaia" <kolga@netapp.com>,
        "Dai Ngo" <Dai.Ngo@oracle.com>, "Tom Talpey" <tom@talpey.com>,
        linux-nfs@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] nfsd: add a MODULE_DESCRIPTION
In-reply-to: <20230720133454.38695-1-jlayton@kernel.org>
References: <20230720133454.38695-1-jlayton@kernel.org>
Date:   Fri, 21 Jul 2023 08:07:16 +1000
Message-id: <168989083691.11078.1519785551812636491@noble.neil.brown.name>
Precedence: bulk

On Thu, 20 Jul 2023, Jeff Layton wrote:
> I got this today from modpost:
>=20
>     WARNING: modpost: missing MODULE_DESCRIPTION() in fs/nfsd/nfsd.o
>=20
> Add a module description.
>=20
> Signed-off-by: Jeff Layton <jlayton@kernel.org>
> ---
>  fs/nfsd/nfsctl.c | 1 +
>  1 file changed, 1 insertion(+)
>=20
> 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)
>  }
> =20
>  MODULE_AUTHOR("Olaf Kirch <okir@monad.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
:-)=20

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=20
  "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)
> --=20
> 2.41.0
>=20
>=20