[PATCH] TIPC: add Kconfig help text

[PATCH] TIPC: add Kconfig help text

[Jesper Juhl]

A new option such as TIPC should have a clear help text (as should any 
option for that matter) so users have a chance of determining if they 
want the option enabled or not without having to do extensive online 
searches.
Since this is likely to puzzle a lot of people doing "make oldconfig" 
with 2.6.16 using their old 2.6.15 .config I think the patch below (or 
a similar one) should go in before 2.6.16 is released.

Please consider merging.


Signed-off-by: Jesper Juhl <jesper.juhl@gmail.com>
---

 net/tipc/Kconfig |    9 ++++++---
 1 files changed, 6 insertions(+), 3 deletions(-)

--- linux-2.6.16-rc1-orig/net/tipc/Kconfig	2006-01-17 19:14:24.000000000 +0100
+++ linux-2.6.16-rc1/net/tipc/Kconfig	2006-01-17 19:30:13.000000000 +0100
@@ -8,7 +8,10 @@
 config TIPC
 	tristate "The TIPC Protocol (EXPERIMENTAL)"
 	---help---
-	  TBD.
+	  The Transparent Inter Process Communication (TIPC) protocol is a
+	  protocol for intra cluster communication.
+	  Unless you are building a cluster using TIPC you probably have no
+	  use for this.
 
 	  This protocol support is also available as a module ( = code which
 	  can be inserted in and removed from the running kernel whenever you
@@ -23,8 +26,8 @@
 	default n
 	help
 	  Saying Y here will open some advanced configuration
-          for TIPC. Most users do not need to bother, so if
-          unsure, just say N.
+          for TIPC. Most users do not need to bother, so if unsure,
+	  just say N.
 
 config TIPC_ZONES
 	int "Maximum number of zones in network"

Re: [PATCH] TIPC: add Kconfig help text

[Per Liden]

I've already committed a patch similar to this in our GIT repo 
(http://tipc.cslab.ericsson.net), just haven't asked for it to be pulled 
yet since we have another fix for some namespace pullution in the 
pipeline. Thanks though!

/Per

On Tue, 17 Jan 2006, Jesper Juhl wrote:

> 
> A new option such as TIPC should have a clear help text (as should any 
> option for that matter) so users have a chance of determining if they 
> want the option enabled or not without having to do extensive online 
> searches.
> Since this is likely to puzzle a lot of people doing "make oldconfig" 
> with 2.6.16 using their old 2.6.15 .config I think the patch below (or 
> a similar one) should go in before 2.6.16 is released.
> 
> Please consider merging.
> 
> 
> Signed-off-by: Jesper Juhl <jesper.juhl@gmail.com>
> ---
> 
>  net/tipc/Kconfig |    9 ++++++---
>  1 files changed, 6 insertions(+), 3 deletions(-)
> 
> --- linux-2.6.16-rc1-orig/net/tipc/Kconfig	2006-01-17 19:14:24.000000000 +0100
> +++ linux-2.6.16-rc1/net/tipc/Kconfig	2006-01-17 19:30:13.000000000 +0100
> @@ -8,7 +8,10 @@
>  config TIPC
>  	tristate "The TIPC Protocol (EXPERIMENTAL)"
>  	---help---
> -	  TBD.
> +	  The Transparent Inter Process Communication (TIPC) protocol is a
> +	  protocol for intra cluster communication.
> +	  Unless you are building a cluster using TIPC you probably have no
> +	  use for this.
>  
>  	  This protocol support is also available as a module ( = code which
>  	  can be inserted in and removed from the running kernel whenever you
> @@ -23,8 +26,8 @@
>  	default n
>  	help
>  	  Saying Y here will open some advanced configuration
> -          for TIPC. Most users do not need to bother, so if
> -          unsure, just say N.
> +          for TIPC. Most users do not need to bother, so if unsure,
> +	  just say N.
>  
>  config TIPC_ZONES
>  	int "Maximum number of zones in network"
> 
> 
> 

Re: [PATCH] TIPC: add Kconfig help text

[Jesper Juhl]

On 1/17/06, Per Liden <per.liden@ericsson.com> wrote:
> I've already committed a patch similar to this in our GIT repo
> (http://tipc.cslab.ericsson.net), just haven't asked for it to be pulled
> yet since we have another fix for some namespace pullution in the
> pipeline. Thanks though!
>

Good enough for me :-)

--
Jesper Juhl <jesper.juhl@gmail.com>
Don't top-post  http://www.catb.org/~esr/jargon/html/T/top-post.html
Plain text mails only, please      http://www.expita.com/nomime.html

Re: [PATCH] TIPC: add Kconfig help text

[Jesper Juhl]

On 1/17/06, Jesper Juhl <jesper.juhl@gmail.com> wrote:
> On 1/17/06, Per Liden <per.liden@ericsson.com> wrote:
> > I've already committed a patch similar to this in our GIT repo
> > (http://tipc.cslab.ericsson.net), just haven't asked for it to be pulled
> > yet since we have another fix for some namespace pullution in the
> > pipeline. Thanks though!
> >
>
> Good enough for me :-)
>

Let me just pick another little nit here.

Your entries in the MAINTAINERS file for TIPC;
Would it be too much to ask that you list the *correct* email
addresses for people in there instead of the @nospam.ericsson.com
obfuscated ones?

As I see it, listing the obfuscated addresses buys you nothing, since
you are using the real address to post to a public (and widely
archived) mailing list anyway, and has a few real drawbacks:

- some users (especially users who are not native english speakers)
may not realize that the "nospam." bit should be taken out and thus
you may miss emails.

- it adds extra work (small, but still) on everyone who looks up the
maintainer for TIPC to send you guys emails to parse the addr and
realize the addr needs to be edited and then actually edit it instead
of just cut'n'paste.

- it's somewhat annoying.


I even opted to send the patch to both the @nospam.ericsson.com and
@ericsson.com addresses since I didn't know if "nospam." was to be
taken out or if it was just some subdomain you used specifically for
communication on public lists that you then did extra SPAM filtering
on - there's no way to know.
If you are worried about getting extra SPAM by being listed in
MAINTAINERS, why don't you just create an extra email alias that you
list in MAINTAINERS and use for LKML stuff - that alias you can then
do extra filtering on, dump in a seperate mailbox/folder/whatever... I
don't think you actually gain anything by your current scheeme.

I'll stop ranting now ;)

--
Jesper Juhl <jesper.juhl@gmail.com>
Don't top-post  http://www.catb.org/~esr/jargon/html/T/top-post.html
Plain text mails only, please      http://www.expita.com/nomime.html

Re: [PATCH] TIPC: add Kconfig help text

[Jon Maloy]

That has also been fixed, but not pulled in yet. Same reason as above.
///jon

Jesper Juhl wrote:

>On 1/17/06, Jesper Juhl <jesper.juhl@gmail.com> wrote:
>  
>
>>On 1/17/06, Per Liden <per.liden@ericsson.com> wrote:
>>    
>>
>>>I've already committed a patch similar to this in our GIT repo
>>>(http://tipc.cslab.ericsson.net), just haven't asked for it to be pulled
>>>yet since we have another fix for some namespace pullution in the
>>>pipeline. Thanks though!
>>>
>>>      
>>>
>>Good enough for me :-)
>>
>>    
>>
>
>Let me just pick another little nit here.
>
>Your entries in the MAINTAINERS file for TIPC;
>Would it be too much to ask that you list the *correct* email
>addresses for people in there instead of the @nospam.ericsson.com
>obfuscated ones?
>
>As I see it, listing the obfuscated addresses buys you nothing, since
>you are using the real address to post to a public (and widely
>archived) mailing list anyway, and has a few real drawbacks:
>
>- some users (especially users who are not native english speakers)
>may not realize that the "nospam." bit should be taken out and thus
>you may miss emails.
>
>- it adds extra work (small, but still) on everyone who looks up the
>maintainer for TIPC to send you guys emails to parse the addr and
>realize the addr needs to be edited and then actually edit it instead
>of just cut'n'paste.
>
>- it's somewhat annoying.
>
>
>I even opted to send the patch to both the @nospam.ericsson.com and
>@ericsson.com addresses since I didn't know if "nospam." was to be
>taken out or if it was just some subdomain you used specifically for
>communication on public lists that you then did extra SPAM filtering
>on - there's no way to know.
>If you are worried about getting extra SPAM by being listed in
>MAINTAINERS, why don't you just create an extra email alias that you
>list in MAINTAINERS and use for LKML stuff - that alias you can then
>do extra filtering on, dump in a seperate mailbox/folder/whatever... I
>don't think you actually gain anything by your current scheeme.
>
>I'll stop ranting now ;)
>
>--
>Jesper Juhl <jesper.juhl@gmail.com>
>Don't top-post  http://www.catb.org/~esr/jargon/html/T/top-post.html
>Plain text mails only, please      http://www.expita.com/nomime.html
>  
>

Re: [PATCH] TIPC: add Kconfig help text

[Jesper Juhl]

On 1/17/06, Jon Maloy <jon.maloy@ericsson.com> wrote:
> That has also been fixed, but not pulled in yet. Same reason as above.

Excellent - thanks - guess I should have checked that git repo before ranting.
Now we just need to teach you guys not to top-post and everything will
be peachy ;-)

--
Jesper Juhl <jesper.juhl@gmail.com>
Don't top-post  http://www.catb.org/~esr/jargon/html/T/top-post.html
Plain text mails only, please      http://www.expita.com/nomime.html

Re: [PATCH] TIPC: add Kconfig help text

[Per Liden]

On Tue, 17 Jan 2006, Jesper Juhl wrote:

[...]
> Your entries in the MAINTAINERS file for TIPC;
> Would it be too much to ask that you list the *correct* email
> addresses for people in there instead of the @nospam.ericsson.com
> obfuscated ones?

I agree and a patch for this is also in our GIT repo, just haven't been 
pulled yet (committed 3 days ago ;)

/Per