From swear@blarg.net  Thu Mar  7 13:55:12 2002
Return-Path: <swear@blarg.net>
Received: from lists.blarg.net (lists.blarg.net [206.124.128.17])
	by hub.freebsd.org (Postfix) with ESMTP id 37E9637B439
	for <FreeBSD-gnats-submit@freebsd.org>; Thu,  7 Mar 2002 13:55:06 -0800 (PST)
Received: from thig.blarg.net (thig.blarg.net [206.124.128.18])
	by lists.blarg.net (Postfix) with ESMTP id 997F9BD80
	for <FreeBSD-gnats-submit@freebsd.org>; Thu,  7 Mar 2002 13:55:06 -0800 (PST)
Received: from localhost.localdomain ([206.124.139.115])
	by thig.blarg.net (8.9.3/8.9.3) with ESMTP id NAA12521
	for <FreeBSD-gnats-submit@freebsd.org>; Thu, 7 Mar 2002 13:55:06 -0800
Received: (from jojo@localhost)
	by localhost.localdomain (8.11.6/8.11.3) id g27LwIL46775;
	Thu, 7 Mar 2002 13:58:18 -0800 (PST)
	(envelope-from swear@blarg.net)
Message-Id: <zc3czcca6d.czc@localhost.localdomain>
Date: 07 Mar 2002 13:58:18 -0800
From: "Gary W. Swearingen" <swear@blarg.net>
Reply-To: swear@blarg.net
To: FreeBSD-gnats-submit@freebsd.org
Subject: rc.conf; add note about "flags" to both files
X-GNATS-Notify:

>Number:         35648
>Category:       docs
>Synopsis:       rc.conf; add note about "flags" to both files
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    keramida
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          change-request
>Submitter-Id:   current-users
>Arrival-Date:   Thu Mar 07 14:00:09 PST 2002
>Closed-Date:    Tue Feb 22 13:18:14 GMT 2005
>Last-Modified:  Tue Feb 22 13:18:14 GMT 2005
>Originator:     Gary W. Swearingen
>Release:        FreeBSD 4.5-STABLE i386
>Organization:
none
>Environment:
n/a
================
>Description:

The /etc/rc.conf and /etc/default/rc.conf files should have a comment
near the top noting that "_flags" may be interpreted as "_options"
and that "flags" always need a leading "-".

The term "flag" is ambiguous (see sh(1) and csh(1) for examples) as to
whether it means, eg, "-o" or just the "o".

It is also ambiguous in referring only to the "-o" and not including
the "-o' option's arguments (or even to only single-character options),
so it should be made clear that _flags is used here for both kinds.
================
>How-To-Repeat:
n/a
================
>Fix:

Add something like:

#
# Variable names with "_flags" suffixes may be interpreted as "_options"
# and the quoted arguments should always begin with "-".
>Release-Note:
>Audit-Trail:

From: "Crist J. Clark" <cjc@FreeBSD.ORG>
To: "Gary W. Swearingen" <swear@blarg.net>
Cc: FreeBSD-gnats-submit@FreeBSD.ORG
Subject: Re: bin/35648: rc.conf; add note about "flags" to both files
Date: Thu, 7 Mar 2002 16:35:09 -0800

 On Thu, Mar 07, 2002 at 01:58:18PM -0800, Gary W. Swearingen wrote:
 [snip]
 
 > The /etc/rc.conf and /etc/default/rc.conf files should have a comment
 > near the top noting that "_flags" may be interpreted as "_options"
 > and that "flags" always need a leading "-".
 
 The correct place for this kind of documentation would be the
 rc.conf(5) manpage.
 -- 
 Crist J. Clark                     |     cjclark@alum.mit.edu
                                    |     cjclark@jhu.edu
 http://people.freebsd.org/~cjc/    |     cjc@freebsd.org

From: swear@blarg.net (Gary W. Swearingen)
To: "Crist J. Clark" <cjc@FreeBSD.ORG>
Cc: FreeBSD-gnats-submit@FreeBSD.ORG
Subject: Re: bin/35648: rc.conf; add note about "flags" to both files
Date: 07 Mar 2002 20:02:33 -0800

 "Crist J. Clark" <cjc@FreeBSD.ORG> writes:
 
 > The correct place for this kind of documentation would be the
 > rc.conf(5) manpage.
 
 Duh!  Of course!  Thanks.
 
 But the two files (and many others) should note that they have man
 pages.  (It probably would have saved this embarrassment and would save
 the time of many others who either forget or don't know about the man
 page.  I didn't know about the rc.conf(5) man page for several weeks
 after starting FreeBSD.)
 
 Can/should the PR be switched to "doc/35648" or leave this for
 the "rc.conf man page mention" and write a new one for the
 "flags=options" thing?
Responsible-Changed-From-To: freebsd-bugs->freebsd-doc 
Responsible-Changed-By: cjc 
Responsible-Changed-When: Thu Mar 7 23:12:18 PST 2002 
Responsible-Changed-Why:  
Category changed to docs after analysis and agreement from submitter. 

http://www.FreeBSD.org/cgi/query-pr.cgi?pr=35648 
State-Changed-From-To: open->patched 
State-Changed-By: keramida 
State-Changed-When: Mon Jan 24 21:53:26 GMT 2005 
State-Changed-Why:  
A reference to rc.conf(5) in the CURRENT version of 
src/etc/defaults/rc.conf has been added.  Thanks :) 


Responsible-Changed-From-To: freebsd-doc->keramida 
Responsible-Changed-By: keramida 
Responsible-Changed-When: Mon Jan 24 21:53:26 GMT 2005 
Responsible-Changed-Why:  
I'll handle the MFC. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=35648 
State-Changed-From-To: patched->closed 
State-Changed-By: keramida 
State-Changed-When: Tue Feb 22 13:17:34 GMT 2005 
State-Changed-Why:  
The changes to src/etc/defaults/{rc,periodic}.conf have been merged 
from HEAD to 5-STABLE. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=35648 
>Unformatted:
