[PATCH] add MODULE_DESCRIPTION to nfs module, update NFS references in MAINTAINERS

[PATCH] add MODULE_DESCRIPTION to nfs module, update NFS references in MAINTAINERS

[Bruce Allan]

To direct people to the appropriate resources when experiencing problems
with the NFS client here is a simple patch to 1) add module description
(with link to NFS documentation) to the nfs module, and 2) update the
NFS mailing list and web resources to the MAINTAINERS file.

Patch created against 2.6.11-rc2.

Signed-off-by: Bruce Allan <bwa@us.ibm.com>

diff -urp linux-2.6.11-rc2-vanilla/fs/nfs/inode.c linux-2.6.11-rc2/fs/nfs/inode.c
--- linux-2.6.11-rc2-vanilla/fs/nfs/inode.c	2005-01-24 09:17:59.000000000 -0800
+++ linux-2.6.11-rc2/fs/nfs/inode.c	2005-01-25 14:19:58.000000000 -0800
@@ -1974,6 +1974,7 @@ static void __exit exit_nfs_fs(void)
 /* Not quite true; I just maintain it */
 MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
 MODULE_LICENSE("GPL");
+MODULE_DESCRIPTION("NFS client module (http://nfs.sourceforge.net)");
 
 module_init(init_nfs_fs)
 module_exit(exit_nfs_fs)
diff -urp linux-2.6.11-rc2-vanilla/MAINTAINERS linux-2.6.11-rc2/MAINTAINERS
--- linux-2.6.11-rc2-vanilla/MAINTAINERS	2005-01-24 09:17:40.000000000 -0800
+++ linux-2.6.11-rc2/MAINTAINERS	2005-01-25 11:29:51.000000000 -0800
@@ -1612,7 +1612,9 @@ S:	Maintained
 NFS CLIENT
 P:	Trond Myklebust
 M:	trond.myklebust@fys.uio.no
-L:	linux-kernel@vger.kernel.org
+L:	nfs@lists.sourceforge.net
+W:	http://nfs.sourceforge.net
+W:	http://linux-nfs.org
 S:	Maintained
 
 NI5010 NETWORK DRIVER


Regards,
---
Bruce Allan
Software Engineer, Linux Technology Center
IBM Corporation, Beaverton OR USA



-------------------------------------------------------
This SF.Net email is sponsored by: IntelliVIEW -- Interactive Reporting
Tool for open source databases. Create drag-&-drop reports. Save time
by over 75%! Publish reports on the web. Export to DOC, XLS, RTF, etc.
Download a FREE copy at http://www.intelliview.com/go/osdn_nl
_______________________________________________
NFS maillist  -  NFS@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/nfs

Re: [PATCH] add MODULE_DESCRIPTION to nfs module, update NFS references in MAINTAINERS

[Christoph Hellwig]

> +MODULE_DESCRIPTION("NFS client module (http://nfs.sourceforge.net)");

I've not seen a single other module with an url in MODULE_DESCRIPTION()
yet, and it doesn't look like the right thing either.



-------------------------------------------------------
This SF.Net email is sponsored by: IntelliVIEW -- Interactive Reporting
Tool for open source databases. Create drag-&-drop reports. Save time
by over 75%! Publish reports on the web. Export to DOC, XLS, RTF, etc.
Download a FREE copy at http://www.intelliview.com/go/osdn_nl
_______________________________________________
NFS maillist  -  NFS@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/nfs

Re: [PATCH] add MODULE_DESCRIPTION to nfs module, update NFS references in MAINTAINERS

[Bruce Allan]

On Tue, 2005-01-25 at 15:08, Christoph Hellwig wrote:
> > +MODULE_DESCRIPTION("NFS client module (http://nfs.sourceforge.net)");
> 
> I've not seen a single other module with an url in MODULE_DESCRIPTION()
> yet, and it doesn't look like the right thing either.
> 
> 
I'm curious, why not?  The MODULE_DESCRIPTION is meant to provide a
description of what the module does; the url referenced is to the
SourceForge project site for NFS which has the NFS Overview, FAQ, HOWTO,
and other assorted links which more thoroughly document just that.

Besides the NFS configuration comments in ./fs/Kconfig and the
MAINTAINERS file (which might not be present on a system), can you
suggest an alternative location to provide this pointer?

The idea is to provide a means for the user with a problem to be able to
quickly and easily find the proper assistance without wasting
inappropriate bandwidth, or better yet, resolve the problem on their
own.  And, yes, I realize this won't work if nfs/nfsd is statically
built into the kernel.

Regards,
---
Bruce Allan
Software Engineer, Linux Technology Center
IBM Corporation, Beaverton OR USA



-------------------------------------------------------
This SF.Net email is sponsored by: IntelliVIEW -- Interactive Reporting
Tool for open source databases. Create drag-&-drop reports. Save time
by over 75%! Publish reports on the web. Export to DOC, XLS, RTF, etc.
Download a FREE copy at http://www.intelliview.com/go/osdn_nl
_______________________________________________
NFS maillist  -  NFS@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/nfs

Re: [PATCH] add MODULE_DESCRIPTION to nfs module, update NFS references in MAINTAINERS

[Christoph Hellwig]

On Tue, Jan 25, 2005 at 04:19:50PM -0800, Bruce Allan wrote:
> Besides the NFS configuration comments in ./fs/Kconfig and the
> MAINTAINERS file (which might not be present on a system), can you
> suggest an alternative location to provide this pointer?

MAINTAINERS is exactly the right place.



-------------------------------------------------------
This SF.Net email is sponsored by: IntelliVIEW -- Interactive Reporting
Tool for open source databases. Create drag-&-drop reports. Save time
by over 75%! Publish reports on the web. Export to DOC, XLS, RTF, etc.
Download a FREE copy at http://www.intelliview.com/go/osdn_nl
_______________________________________________
NFS maillist  -  NFS@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/nfs

Re: [PATCH] add MODULE_DESCRIPTION to nfs module, update NFS references in MAINTAINERS

[Neil Brown]

On Tuesday January 25, bwa@us.ibm.com wrote:
> To direct people to the appropriate resources when experiencing problems
> with the NFS client here is a simple patch to 1) add module description
> (with link to NFS documentation) to the nfs module, and 2) update the
> NFS mailing list and web resources to the MAINTAINERS file.
> 
> Patch created against 2.6.11-rc2.
> 
> Signed-off-by: Bruce Allan <bwa@us.ibm.com>
> 
...
> diff -urp linux-2.6.11-rc2-vanilla/MAINTAINERS linux-2.6.11-rc2/MAINTAINERS
> --- linux-2.6.11-rc2-vanilla/MAINTAINERS	2005-01-24 09:17:40.000000000 -0800
> +++ linux-2.6.11-rc2/MAINTAINERS	2005-01-25 11:29:51.000000000 -0800
> @@ -1612,7 +1612,9 @@ S:	Maintained
>  NFS CLIENT
>  P:	Trond Myklebust
>  M:	trond.myklebust@fys.uio.no
> -L:	linux-kernel@vger.kernel.org
> +L:	nfs@lists.sourceforge.net

Trouble with this is that the last I heard, nfs@lists.sourceforge.net
was subscriber-only, and there are those who don't like non-open lists 
in MAINTAINERS.  I realise that the same list is given for "KERNEL
NFSD", but that was put there when it was still open.....

NeilBrown

> +W:	http://nfs.sourceforge.net
> +W:	http://linux-nfs.org
>  S:	Maintained
>  
>  NI5010 NETWORK DRIVER
> 
> 
> Regards,
> ---
> Bruce Allan
> Software Engineer, Linux Technology Center
> IBM Corporation, Beaverton OR USA


-------------------------------------------------------
This SF.Net email is sponsored by: IntelliVIEW -- Interactive Reporting
Tool for open source databases. Create drag-&-drop reports. Save time
by over 75%! Publish reports on the web. Export to DOC, XLS, RTF, etc.
Download a FREE copy at http://www.intelliview.com/go/osdn_nl
_______________________________________________
NFS maillist  -  NFS@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/nfs

Re: [PATCH] add MODULE_DESCRIPTION to nfs module, update NFS references in MAINTAINERS

[Bruce Allan]

On Wed, 2005-01-26 at 00:05, Christoph Hellwig wrote:
> On Tue, Jan 25, 2005 at 04:19:50PM -0800, Bruce Allan wrote:
> > Besides the NFS configuration comments in ./fs/Kconfig and the
> > MAINTAINERS file (which might not be present on a system), can you
> > suggest an alternative location to provide this pointer?
> 
> MAINTAINERS is exactly the right place.
> 
> 
Yes, MAINTAINERS is the best place for that info, but there are many
Linux production systems out there that do not have the kernel source
installed.  Where on these machines is one supposed to get that kind of
information?

Regards,
---
Bruce Allan
Software Engineer, Linux Technology Center
IBM Corporation, Beaverton OR USA



-------------------------------------------------------
This SF.Net email is sponsored by: IntelliVIEW -- Interactive Reporting
Tool for open source databases. Create drag-&-drop reports. Save time
by over 75%! Publish reports on the web. Export to DOC, XLS, RTF, etc.
Download a FREE copy at http://www.intelliview.com/go/osdn_nl
_______________________________________________
NFS maillist  -  NFS@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/nfs

Re: [PATCH] add MODULE_DESCRIPTION to nfs module, update NFS references in MAINTAINERS

[Christoph Hellwig]

On Wed, Jan 26, 2005 at 08:56:20AM -0800, Bruce Allan wrote:
> Yes, MAINTAINERS is the best place for that info, but there are many
> Linux production systems out there that do not have the kernel source
> installed.  Where on these machines is one supposed to get that kind of
> information?

prod your favourite distribution vendor to put MAINTAINERS into /usr/share/doc



-------------------------------------------------------
This SF.Net email is sponsored by: IntelliVIEW -- Interactive Reporting
Tool for open source databases. Create drag-&-drop reports. Save time
by over 75%! Publish reports on the web. Export to DOC, XLS, RTF, etc.
Download a FREE copy at http://www.intelliview.com/go/osdn_nl
_______________________________________________
NFS maillist  -  NFS@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/nfs