From dan@xeon.unixathome.org  Wed Aug 15 15:22:56 2001
Return-Path: <dan@xeon.unixathome.org>
Received: from xeon.unixathome.org (cr1046889-a.slnt1.on.wave.home.com [24.102.95.54])
	by hub.freebsd.org (Postfix) with ESMTP id 610B437B405
	for <FreeBSD-gnats-submit@freebsd.org>; Wed, 15 Aug 2001 15:22:55 -0700 (PDT)
	(envelope-from dan@xeon.unixathome.org)
Received: (from dan@localhost)
	by xeon.unixathome.org (8.11.3/8.11.3) id f7FL8Jk00861;
	Wed, 15 Aug 2001 17:08:19 -0400 (EDT)
	(envelope-from dan)
Message-Id: <200108152108.f7FL8Jk00861@xeon.unixathome.org>
Date: Wed, 15 Aug 2001 17:08:19 -0400 (EDT)
From: dan@freebsddiary.org
Reply-To: dan@freebsddiary.org
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: remove ambiguous statements from /etc/rc.conf
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         29736
>Category:       bin
>Synopsis:       make sure the user knows to modify /etc/rc.conf not /etc/defaults/rc.conf.
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    ru
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          change-request
>Submitter-Id:   current-users
>Arrival-Date:   Wed Aug 15 15:30:01 PDT 2001
>Closed-Date:    Fri Aug 17 09:05:52 PDT 2001
>Last-Modified:  Fri Aug 17 09:08:14 PDT 2001
>Originator:     Dan Langille
>Release:        FreeBSD 4.3-STABLE i386
>Organization:
The FreeBSD Diary
>Environment:
System: FreeBSD xeon.unixathome.org 4.3-STABLE FreeBSD 4.3-STABLE #0: Mon Aug 6 23:07:49 EDT 2001 root@xeon.unixathome.org:/usr/src/sys/compile/XEON i386


>Description:

At present, users see this:

$ more /etc/rc.conf
# This file now contains just the overrides from /etc/defaults/rc.conf
# please make all changes to this file.

That is misleading some of them.

I suggest is should say:

$ more /etc/rc.conf
# This file (/etc/rc.conf) now contains just the overrides from /etc/defaults/rc.conf
# please make all changes to /etc/rc.conf.


>How-To-Repeat:

>Fix:

--- config.c.org	Wed Aug 15 13:10:49 2001
+++ config.c	Wed Aug 15 16:34:58 2001
@@ -390,8 +390,8 @@
     if (!rcSite)
 	return;
     if (write_header) {
-	fprintf(rcSite, "# This file now contains just the overrides from /etc/defaults/rc.conf\n");
-	fprintf(rcSite, "# please make all changes to this file.\n\n");
+	fprintf(rcSite, "# This file (/etc/rc.conf) now contains just the overrides from /etc/defaults/rc.conf\n");
+	fprintf(rcSite, "# please make all changes to this /etc/rc.conf.\n\n");
 	fprintf(rcSite, "# Enable network daemons for user convenience.\n");
 	if ((t_loc = time(NULL)) != -1 && (cp = ctime(&t_loc)))
 	    fprintf(rcSite, "# Created: %s", cp);
>Release-Note:
>Audit-Trail:
Responsible-Changed-From-To: freebsd-bugs->eric 
Responsible-Changed-By: chris 
Responsible-Changed-When: Wed Aug 15 15:32:12 PDT 2001 
Responsible-Changed-Why:  
Over to eric, the latest person to take on sysinstall. 

http://www.FreeBSD.org/cgi/query-pr.cgi?pr=29736 

From: Ruslan Ermilov <ru@FreeBSD.ORG>
To: dan@freebsddiary.org
Cc: FreeBSD-gnats-submit@FreeBSD.ORG
Subject: Re: bin/29736: remove ambiguous statements from /etc/rc.conf
Date: Thu, 16 Aug 2001 11:14:26 +0300

 On Wed, Aug 15, 2001 at 05:08:19PM -0400, dan@freebsddiary.org wrote:
 > 
 > >Description:
 > 
 > At present, users see this:
 > 
 > $ more /etc/rc.conf
 > # This file now contains just the overrides from /etc/defaults/rc.conf
 > # please make all changes to this file.
 > 
 > That is misleading some of them.
 > 
 > I suggest is should say:
 > 
 > $ more /etc/rc.conf
 > # This file (/etc/rc.conf) now contains just the overrides from /etc/defaults/rc.conf
 > # please make all changes to /etc/rc.conf.
 > 
 Umm, doesn't "This file" implies /etc/rc.conf?
 
 
 Cheers,
 -- 
 Ruslan Ermilov		Oracle Developer/DBA,
 ru@sunbay.com		Sunbay Software AG,
 ru@FreeBSD.org		FreeBSD committer,
 +380.652.512.251	Simferopol, Ukraine
 
 http://www.FreeBSD.org	The Power To Serve
 http://www.oracle.com	Enabling The Information Age

From: "Dan Langille" <dan@langille.org>
To: Ruslan Ermilov <ru@FreeBSD.ORG>
Cc: FreeBSD-gnats-submit@FreeBSD.ORG
Subject: Re: bin/29736: remove ambiguous statements from /etc/rc.conf
Date: Thu, 16 Aug 2001 09:37:49 -0400

 On 16 Aug 2001, at 11:14, Ruslan Ermilov wrote:
 
 > On Wed, Aug 15, 2001 at 05:08:19PM -0400, dan@freebsddiary.org wrote:
 > > 
 > > >Description:
 > > 
 > > At present, users see this:
 > > 
 > > $ more /etc/rc.conf
 > > # This file now contains just the overrides from /etc/defaults/rc.conf
 > > # please make all changes to this file.
 > > 
 > > That is misleading some of them.
 > > 
 > > I suggest is should say:
 > > 
 > > $ more /etc/rc.conf
 > > # This file (/etc/rc.conf) now contains just the overrides from
 > > # /etc/defaults/rc.conf please make all changes to /etc/rc.conf.
 > > 
 > Umm, doesn't "This file" implies /etc/rc.conf?
 
 To most people yes. To some, no.  There is room for abiguity in the 
 existing code.  This patch removes it.
 
 -- 
 Dan Langille
 pgpkey - finger dan@unixathome.org | http://unixathome.org/finger.php

From: "Dan Langille" <dan@langille.org>
To: Ruslan Ermilov <ru@FreeBSD.ORG>
Cc: FreeBSD-gnats-submit@FreeBSD.ORG
Subject: Re: bin/29736: remove ambiguous statements from /etc/rc.conf
Date: Thu, 16 Aug 2001 09:43:46 -0400

 On 16 Aug 2001, at 11:14, Ruslan Ermilov wrote:
 
 > On Wed, Aug 15, 2001 at 05:08:19PM -0400, dan@freebsddiary.org wrote:
 > > 
 > > >Description:
 > > 
 > > At present, users see this:
 > > 
 > > $ more /etc/rc.conf
 > > # This file now contains just the overrides from /etc/defaults/rc.conf
 > > # please make all changes to this file.
 > > 
 > > That is misleading some of them.
 > > 
 > > I suggest is should say:
 > > 
 > > $ more /etc/rc.conf
 > > # This file (/etc/rc.conf) now contains just the overrides from
 > > # /etc/defaults/rc.conf please make all changes to /etc/rc.conf.
 > > 
 > Umm, doesn't "This file" implies /etc/rc.conf?
 
 If you want to see the incident which prompted my PR, please read 
 http://www.freebsddiary.org/phorum/read.php?f=1&i=2778&t=2778
 
 -- 
 Dan Langille
 pgpkey - finger dan@unixathome.org | http://unixathome.org/finger.php

From: Ruslan Ermilov <ru@FreeBSD.ORG>
To: Dan Langille <dan@langille.org>
Cc: FreeBSD-gnats-submit@FreeBSD.ORG
Subject: Re: bin/29736: remove ambiguous statements from /etc/rc.conf
Date: Thu, 16 Aug 2001 18:41:15 +0300

 On Thu, Aug 16, 2001 at 09:43:46AM -0400, Dan Langille wrote:
 > On 16 Aug 2001, at 11:14, Ruslan Ermilov wrote:
 > 
 > > On Wed, Aug 15, 2001 at 05:08:19PM -0400, dan@freebsddiary.org wrote:
 > > > 
 > > > >Description:
 > > > 
 > > > At present, users see this:
 > > > 
 > > > $ more /etc/rc.conf
 > > > # This file now contains just the overrides from /etc/defaults/rc.conf
 > > > # please make all changes to this file.
 > > > 
 > > > That is misleading some of them.
 > > > 
 > > > I suggest is should say:
 > > > 
 > > > $ more /etc/rc.conf
 > > > # This file (/etc/rc.conf) now contains just the overrides from
 > > > # /etc/defaults/rc.conf please make all changes to /etc/rc.conf.
 > > > 
 > > Umm, doesn't "This file" implies /etc/rc.conf?
 > 
 > If you want to see the incident which prompted my PR, please read 
 > http://www.freebsddiary.org/phorum/read.php?f=1&i=2778&t=2778
 > 
 Been there, read that.  One (!) user was confused by misinterpreting
 "this file" as "/etc/defaults/rc.conf" while editing /etc/rc.conf.
 I think "this file" is enough.  Are we going to increase the verbosity
 even more, and say: "this file, yes, this, that you are currently
 edited, damn, you know how it's named, yeah?"?  "This file" has only
 one meaning, at least for me, no?  :-)
 
 This is going to turn into bikeshed now.  I would like to close this PR.
 
 
 Cheers,
 -- 
 Ruslan Ermilov		Oracle Developer/DBA,
 ru@sunbay.com		Sunbay Software AG,
 ru@FreeBSD.org		FreeBSD committer,
 +380.652.512.251	Simferopol, Ukraine
 
 http://www.FreeBSD.org	The Power To Serve
 http://www.oracle.com	Enabling The Information Age

From: "Dan Langille" <dan@langille.org>
To: Ruslan Ermilov <ru@FreeBSD.ORG>
Cc: FreeBSD-gnats-submit@FreeBSD.ORG
Subject: Re: bin/29736: remove ambiguous statements from /etc/rc.conf
Date: Thu, 16 Aug 2001 11:56:54 -0400

 On 16 Aug 2001, at 18:41, Ruslan Ermilov wrote:
 
 > On Thu, Aug 16, 2001 at 09:43:46AM -0400, Dan Langille wrote:
 > > On 16 Aug 2001, at 11:14, Ruslan Ermilov wrote:
 > > 
 > > > On Wed, Aug 15, 2001 at 05:08:19PM -0400, dan@freebsddiary.org wrote:
 > > > > 
 > > > > >Description:
 > > > > 
 > > > > At present, users see this:
 > > > > 
 > > > > $ more /etc/rc.conf
 > > > > # This file now contains just the overrides from
 > > > > # /etc/defaults/rc.conf please make all changes to this file.
 > > > > 
 > > > > That is misleading some of them.
 > > > > 
 > > > > I suggest is should say:
 > > > > 
 > > > > $ more /etc/rc.conf
 > > > > # This file (/etc/rc.conf) now contains just the overrides from
 > > > > # /etc/defaults/rc.conf please make all changes to /etc/rc.conf.
 > > > > 
 > > > Umm, doesn't "This file" implies /etc/rc.conf?
 > > 
 > > If you want to see the incident which prompted my PR, please read 
 > > http://www.freebsddiary.org/phorum/read.php?f=1&i=2778&t=2778
 > > 
 > Been there, read that.  One (!) user was confused by misinterpreting
 > "this file" as "/etc/defaults/rc.conf" while editing /etc/rc.conf.
 
 Yes.  That is correct.  That thread gives visible proof that one person 
 was confused.  That does not mean there was only one person.  There 
 will have been more.  There will be more.  The PR removes the 
 confusion.  How can that be bad?
 
 > I think "this file" is enough.  Are we going to increase the verbosity even
 > more, and say: "this file, yes, this, that you are currently edited, damn,
 > you know how it's named, yeah?"?  "This file" has only one meaning, at
 > least for me, no?  :-)
 
 Being silly about it isn't going to improve your argument.
 
 Here is what occurs in /etc/rc.conf
 
 # This file now contains just the overrides from /etc/defaults/rc.conf
 # please make all changes to this file.
 
 The string "this file" occurs twice.  Some people are mistakenly (but not 
 suprisingly) assuming that the second instance refers to the previously 
 named file.
 
 Face it, for us, who know what we're talking about, the above has just 
 one meaning.  But for newbies, it's confusing.  The PR eliminates that 
 confusion.
 
 > This is going to turn into bikeshed now.  I would like to close this PR.
 
 Only because you're making it a bikeshed.  This PR is about providing 
 clear concise instructions to people who don't know what they're doing.  
 And that is always A Good Thing (tm).
 
 -- 
 Dan Langille
 pgpkey - finger dan@unixathome.org | http://unixathome.org/finger.php

From: Ruslan Ermilov <ru@FreeBSD.ORG>
To: Dan Langille <dan@langille.org>
Cc: FreeBSD-gnats-submit@FreeBSD.ORG
Subject: Re: bin/29736: remove ambiguous statements from /etc/rc.conf
Date: Thu, 16 Aug 2001 19:25:56 +0300

 On Thu, Aug 16, 2001 at 11:56:54AM -0400, Dan Langille wrote:
 > On 16 Aug 2001, at 18:41, Ruslan Ermilov wrote:
 > 
 > > On Thu, Aug 16, 2001 at 09:43:46AM -0400, Dan Langille wrote:
 > > > On 16 Aug 2001, at 11:14, Ruslan Ermilov wrote:
 > > > 
 > > > > On Wed, Aug 15, 2001 at 05:08:19PM -0400, dan@freebsddiary.org wrote:
 > > > > > 
 > > > > > >Description:
 > > > > > 
 > > > > > At present, users see this:
 > > > > > 
 > > > > > $ more /etc/rc.conf
 > > > > > # This file now contains just the overrides from
 > > > > > # /etc/defaults/rc.conf please make all changes to this file.
 > > > > > 
 > > > > > That is misleading some of them.
 > > > > > 
 > > > > > I suggest is should say:
 > > > > > 
 > > > > > $ more /etc/rc.conf
 > > > > > # This file (/etc/rc.conf) now contains just the overrides from
 > > > > > # /etc/defaults/rc.conf please make all changes to /etc/rc.conf.
 > > > > > 
 > > > > Umm, doesn't "This file" implies /etc/rc.conf?
 > > > 
 > > > If you want to see the incident which prompted my PR, please read 
 > > > http://www.freebsddiary.org/phorum/read.php?f=1&i=2778&t=2778
 > > > 
 > > Been there, read that.  One (!) user was confused by misinterpreting
 > > "this file" as "/etc/defaults/rc.conf" while editing /etc/rc.conf.
 > 
 > Yes.  That is correct.  That thread gives visible proof that one person 
 > was confused.  That does not mean there was only one person.  There 
 > will have been more.  There will be more.  The PR removes the 
 > confusion.  How can that be bad?
 > 
 Because "this file" can potentially become /etc/rc.conf.local.
 
 > > I think "this file" is enough.  Are we going to increase the verbosity even
 > > more, and say: "this file, yes, this, that you are currently edited, damn,
 > > you know how it's named, yeah?"?  "This file" has only one meaning, at
 > > least for me, no?  :-)
 > 
 > Being silly about it isn't going to improve your argument.
 > 
 > Here is what occurs in /etc/rc.conf
 > 
 > # This file now contains just the overrides from /etc/defaults/rc.conf
 > # please make all changes to this file.
 > 
 > The string "this file" occurs twice.  Some people are mistakenly (but not 
 > suprisingly) assuming that the second instance refers to the previously 
 > named file.
 > 
 Clearly there's a missing punctuation here.  How about this?
 
 # This file now contains just the overrides from /etc/defaults/rc.conf.
 # Please make all changes to this file, not to /etc/defaults/rc.conf.
 
 
 Cheers,
 -- 
 Ruslan Ermilov		Oracle Developer/DBA,
 ru@sunbay.com		Sunbay Software AG,
 ru@FreeBSD.org		FreeBSD committer,
 +380.652.512.251	Simferopol, Ukraine
 
 http://www.FreeBSD.org	The Power To Serve
 http://www.oracle.com	Enabling The Information Age

From: "Dan Langille" <dan@langille.org>
To: Ruslan Ermilov <ru@FreeBSD.ORG>
Cc: FreeBSD-gnats-submit@FreeBSD.ORG
Subject: Re: bin/29736: remove ambiguous statements from /etc/rc.conf
Date: Thu, 16 Aug 2001 12:54:22 -0400

 On 16 Aug 2001, at 19:25, Ruslan Ermilov wrote:
 
 > On Thu, Aug 16, 2001 at 11:56:54AM -0400, Dan Langille wrote:
 > > The string "this file" occurs twice.  Some people are mistakenly (but not
 > > suprisingly) assuming that the second instance refers to the previously
 > > named file.
 > > 
 > Clearly there's a missing punctuation here.  How about this?
 > 
 > # This file now contains just the overrides from /etc/defaults/rc.conf.
 > # Please make all changes to this file, not to /etc/defaults/rc.conf.
 
 That's great.
 
 -- 
 Dan Langille
 pgpkey - finger dan@unixathome.org | http://unixathome.org/finger.php
State-Changed-From-To: open->closed 
State-Changed-By: ru 
State-Changed-When: Fri Aug 17 09:05:52 PDT 2001 
State-Changed-Why:  
Fixed in 5.0-CURRENT. 


Responsible-Changed-From-To: eric->ru 
Responsible-Changed-By: ru 
Responsible-Changed-When: Fri Aug 17 09:05:52 PDT 2001 
Responsible-Changed-Why:  
I promised to commit the patch today. 

http://www.FreeBSD.org/cgi/query-pr.cgi?pr=29736 
>Unformatted:
