Message ID | 20230720133454.38695-1-jlayton@kernel.org |
---|---|
State | New |
Headers |
Return-Path: <linux-kernel-owner@vger.kernel.org> Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:c923:0:b0:3e4:2afc:c1 with SMTP id j3csp3138226vqt; Thu, 20 Jul 2023 07:01:09 -0700 (PDT) X-Google-Smtp-Source: APBJJlHyT5TJ0c3xzNe4hd8ORCtOJUw3Z8uz2vt7Nn1GjSAGthda/aveQ+n8qYa9UqcGEZRgwg3W X-Received: by 2002:a17:906:2813:b0:99b:415f:2e4f with SMTP id r19-20020a170906281300b0099b415f2e4fmr2567176ejc.57.1689861669036; Thu, 20 Jul 2023 07:01:09 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1689861669; cv=none; d=google.com; s=arc-20160816; b=wUA/cEbsrYqXBysb2NJt0tCKVHP787S6tvzIks1AKCxbwkFUXXZCuqh1E8I05vAZvJ ydAfFTI4uXfX26dppnNzNs19JfEUgt2OOfY9s3ds1lIvXR9QJr/OIFnx1O0DxyD7BAnL c8QDMYScBRSnoCdmwkSUA6qs4rzSbpgF6Fcl+Uv7xqldFvNSTGSqUj4Rm/3gdjKQUVa0 0PDn9jWbxIwGCiCsibG3L8Ng6nb7gF94FcDYwYbdbFUTGwQ+3tjuofG79PzFqXvXry4W 8PuUVukCUQC9MMaTzex/qSgOhXHXTz1f2fZcER9nnYoze+6JEiju1mdwhvdWlAv0WUeV 4+9g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from:dkim-signature; bh=ObEZ9pkDAsQeDpcLv4s1yEABj6I5tnBRWljFvQZkGPw=; fh=W/b+y8U4fhsZkwglSBKFbnrbkJHF2pCSIzgZQ42htTY=; b=qChwcGZezeSBeid18qv6riJDxngunmCzkFY793bhXGrqz0bLZSfretj92aOtImV2z+ XNwdKMO3AOP08Rcj89qiXmxTy1M8ROL42oDkaWJ/5jkoDNt4Wcc5dEVuZSB4fxSE/eMm jFXUAR/W64aWzVb9nhxcblaNnDAF+QmmVSOsYgXhcA9q9DJWrxZ2aY2Z8XzpESOHshVQ fXXAhqtlX8d1Vo37L3w2eRwidgpZgh3UOdCCKPjRsYScumwmSBtfsTU9u5wVUPaFCJ8+ +0fU2u+/yYdJTaGYCOMuFiMKjFjUGggmsE8TMzJ8K4yQoLxdZOyrAGmwa2Ybystu3SeD Amcg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=o909l8Ez; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id l14-20020a1709066b8e00b00982a267a399si674114ejr.561.2023.07.20.07.00.42; Thu, 20 Jul 2023 07:01:09 -0700 (PDT) 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; Authentication-Results: mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=o909l8Ez; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230235AbjGTNfj (ORCPT <rfc822;assdfgzxcv4@gmail.com> + 99 others); Thu, 20 Jul 2023 09:35:39 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54060 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231573AbjGTNfb (ORCPT <rfc822;linux-kernel@vger.kernel.org>); Thu, 20 Jul 2023 09:35:31 -0400 Received: from dfw.source.kernel.org (dfw.source.kernel.org [IPv6:2604:1380:4641:c500::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id E0C7430CD; Thu, 20 Jul 2023 06:35:06 -0700 (PDT) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by dfw.source.kernel.org (Postfix) with ESMTPS id 8667761A7C; Thu, 20 Jul 2023 13:34:57 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 16F2DC433C7; Thu, 20 Jul 2023 13:34:55 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1689860096; bh=QTkYoAapURqmzcdL8QyMLIliJ+XrKOTiuGvzEQ20CoM=; h=From:To:Cc:Subject:Date:From; b=o909l8EzFZ/iHhjEaS53GhD08wNWfMWdWwsK9wjzt0Wtz2OrZYYA03CpHQsSTOnBt WqKA+W0OKE/YYYn9vsQTTRF3Mna8K3kfRsEi/KiFLtjDbfVtRNFwOzbn6xKBYXehLD bMeqjLWhN5DirRkC6nb72GuGr7ZMRyeolOYMME3ALkUiqxQkKwL5c/1gcuWc2kZIVa 4AKQAkRSCs5LZMnH7OTG6re5oEJBLBhNHu+T+Mw53an3shJ0F1N91t+2JTiAkAurSI 1DQCiZjXxEUn4izZKrpGc5V4nDZr63KS/50ciaNG0EdPALisev0SI/vu0G9RI7cOYm LpAc6ygAx5oGA== From: Jeff Layton <jlayton@kernel.org> To: Chuck Lever <chuck.lever@oracle.com>, Neil Brown <neilb@suse.de>, Olga Kornievskaia <kolga@netapp.com>, Dai Ngo <Dai.Ngo@oracle.com>, Tom Talpey <tom@talpey.com> Cc: linux-nfs@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH] nfsd: add a MODULE_DESCRIPTION Date: Thu, 20 Jul 2023 09:34:53 -0400 Message-ID: <20230720133454.38695-1-jlayton@kernel.org> X-Mailer: git-send-email 2.41.0 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-4.4 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_MED, SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: <linux-kernel.vger.kernel.org> X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1771948389613940640 X-GMAIL-MSGID: 1771948389613940640 |
Series |
nfsd: add a MODULE_DESCRIPTION
|
|
Commit Message
Jeff Layton
July 20, 2023, 1:34 p.m. UTC
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@kernel.org>
---
fs/nfsd/nfsctl.c | 1 +
1 file changed, 1 insertion(+)
Comments
> On Jul 20, 2023, at 9:34 AM, Jeff Layton <jlayton@kernel.org> 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@kernel.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@monad.swb.de>"); > +MODULE_DESCRIPTION("The Linux kernel NFS server"); > MODULE_LICENSE("GPL"); > module_init(init_nfsd) > module_exit(exit_nfsd) > -- > 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
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@kernel.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@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 :-) 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 > >
On Fri, Jul 21, 2023 at 08:07:16AM +1000, NeilBrown wrote: > 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@kernel.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@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 > :-) The Ohio State University has set a bad precedent. I think we can drop "The". > 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. > 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. > 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. "Network File System server" works for me. > 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. ;-) > NeilBrown > > > > MODULE_LICENSE("GPL"); > > module_init(init_nfsd) > > module_exit(exit_nfsd) > > -- > > 2.41.0 > > > > >
Personally I like Jeff's text. There's zero need to overthink this. Jul 20, 2023 7:30:34 PM Chuck Lever <cel@kernel.org>: > On Fri, Jul 21, 2023 at 08:07:16AM +1000, NeilBrown wrote: >> 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@kernel.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@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 >> :-) > > The Ohio State University has set a bad precedent. > > I think we can drop "The". > > >> 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. > > >> 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. > > >> 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. > > "Network File System server" works for me. > > >> 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. ;-) > > >> NeilBrown >> >> >>> MODULE_LICENSE("GPL"); >>> module_init(init_nfsd) >>> module_exit(exit_nfsd) >>> -- >>> 2.41.0 >>> >>> >>
On Thu, 2023-07-20 at 20:00 -0400, Tom Talpey wrote: > 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. > Jul 20, 2023 7:30:34 PM Chuck Lever <cel@kernel.org>: > > > On Fri, Jul 21, 2023 at 08:07:16AM +1000, NeilBrown wrote: > > > 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@kernel.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@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 > > > :-) > > > > The Ohio State University has set a bad precedent. > > > > I think we can drop "The". > > > > > > > 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. > > > > > > > 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. > > > > > > > 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. > > > > "Network File System server" works for me. > > > > > > > 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. ;-) > > > > > > > NeilBrown > > > > > > > > > > MODULE_LICENSE("GPL"); > > > > module_init(init_nfsd) > > > > module_exit(exit_nfsd) > > > > -- > > > > 2.41.0 > > > > > > > > > > >
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@monad.swb.de>"); +MODULE_DESCRIPTION("The Linux kernel NFS server"); MODULE_LICENSE("GPL"); module_init(init_nfsd) module_exit(exit_nfsd)