Bug 50457

Summary:	/etc/defaults/rc.conf pccard_ifconfig could be more descriptive
Product:	Documentation	Reporter:	phoffman
Component:	Books & Articles	Assignee:	freebsd-doc (Nobody) <doc>
Status:	Closed FIXED
Severity:	Affects Only Me
Priority:	Normal
Version:	Latest
Hardware:	Any
OS:	Any

Description phoffman 2003-03-30 17:00:28 UTC

	
The description of pccard_ifconfig currently reads:
pccard_ifconfig="NO"    # Specialized pccard ethernet configuration (or NO).
This doesn't tell people that the most common setting is going to be "DHCP"
or what would have been in the ifconfig_foo line.

Fix: 

Change the line to 
pccard_ifconfig="NO" # Same as what would go on ifconfig_dev lines, like "DHCP"

Comment 1 simon 2003-04-30 22:15:28 UTC

Hello

The variables in etc/defaults/rc.conf are not meant to be documented
there only have a brief description so a user can have some idea what
the variable does.  The documentation of the variables are in the man
page rc.conf(5) which says the following about pccard_ifconfig :

     pccard_ifconfig
                 (str) List of arguments to be passed to ifconfig(8) at boot
                 time or on insertion of the card (e.g. ``inet 192.168.1.1
                 netmask 255.255.255.0'' for a fixed address or ``DHCP'' for a
                 DHCP client).

I think is sufficient documentation and see no reason to change the
description in defaults/rc.conf since it is descriptive of the variable.

Therefor I think this PR should be closed.

Thanks for the submission, I just don't think the proposed change is
needed.

-- 
Simon L. Nielsen

Comment 2 Ceri Davies freebsd_committer

2003-04-30 22:24:47 UTC

State Changed
From-To: open->closed

I'm with Simon; the correct place for rc.conf documentation is the manual 
page, which seems clear on this issue. 

Thanks for your efforts to improve FreeBSD.

Comment 3 phoffman 2003-05-01 01:16:19 UTC

At 11:15 PM +0200 4/30/03, Simon L. Nielsen wrote:
>Thanks for the submission, I just don't think the proposed change is
>needed.

OK, that makes sense.