From phoffman@scruz.proper.com Sun Mar 30 07:55:49 2003 Return-Path: Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 164FA37B401 for ; Sun, 30 Mar 2003 07:55:49 -0800 (PST) Received: from scruz.proper.com (adsl-63-202-92-130.dsl.snfc21.pacbell.net [63.202.92.130]) by mx1.FreeBSD.org (Postfix) with ESMTP id 77DD143F3F for ; Sun, 30 Mar 2003 07:55:48 -0800 (PST) (envelope-from phoffman@scruz.proper.com) Received: from scruz.proper.com (localhost.vpnc.org [127.0.0.1]) by scruz.proper.com (8.12.6/8.12.6) with ESMTP id h2UFuVFX001299 for ; Sun, 30 Mar 2003 07:56:31 -0800 (PST) (envelope-from phoffman@scruz.proper.com) Received: (from phoffman@localhost) by scruz.proper.com (8.12.6/8.12.6/Submit) id h2UFuUtE001298; Sun, 30 Mar 2003 07:56:30 -0800 (PST) Message-Id: <200303301556.h2UFuUtE001298@scruz.proper.com> Date: Sun, 30 Mar 2003 07:56:30 -0800 (PST) From: Paul Reply-To: Paul To: FreeBSD-gnats-submit@freebsd.org Cc: Subject: /etc/defaults/rc.conf pccard_ifconfig could be more descriptive X-Send-Pr-Version: 3.113 X-GNATS-Notify: >Number: 50457 >Category: docs >Synopsis: /etc/defaults/rc.conf pccard_ifconfig could be more descriptive >Confidential: no >Severity: serious >Priority: medium >Responsible: freebsd-doc >State: closed >Quarter: >Keywords: >Date-Required: >Class: sw-bug >Submitter-Id: current-users >Arrival-Date: Sun Mar 30 08:00:28 PST 2003 >Closed-Date: Wed Apr 30 14:25:49 PDT 2003 >Last-Modified: Wed Apr 30 17:20:06 PDT 2003 >Originator: Paul >Release: FreeBSD 4.7-RELEASE i386 >Organization: >Environment: System: FreeBSD scruz.proper.com 4.7-RELEASE FreeBSD 4.7-RELEASE #9: Thu Mar 27 10:16:36 PST 2003 toor@scruz.proper.com:/usr/obj/usr/src/sys/GENERIC-PLUS-NAT i386 >Description: 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. >How-To-Repeat: >Fix: Change the line to pccard_ifconfig="NO" # Same as what would go on ifconfig_dev lines, like "DHCP" >Release-Note: >Audit-Trail: From: "Simon L. Nielsen" To: freebsd-gnats-submit@FreeBSD.org, phoffman@proper.com Cc: Subject: Re: docs/50457: /etc/defaults/rc.conf pccard_ifconfig could be more descriptive Date: Wed, 30 Apr 2003 23:15:28 +0200 --3U8TY7m7wOx7RL1F Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable 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'' fo= r 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. --=20 Simon L. Nielsen --3U8TY7m7wOx7RL1F Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.1 (FreeBSD) iD8DBQE+sDzw8kocFXgPTRwRAki5AKDJx0RL/jlpm2wreMmPGdG4Ajo3VwCfeFFx 7hvUIH+0AZ8pGh03T4GbiZY= =r7OD -----END PGP SIGNATURE----- --3U8TY7m7wOx7RL1F-- State-Changed-From-To: open->closed State-Changed-By: ceri State-Changed-When: Wed Apr 30 14:24:47 PDT 2003 State-Changed-Why: 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. http://www.freebsd.org/cgi/query-pr.cgi?pr=50457 From: Paul Hoffman To: "Simon L. Nielsen" , freebsd-gnats-submit@FreeBSD.org Cc: Subject: Re: docs/50457: /etc/defaults/rc.conf pccard_ifconfig could be more descriptive Date: Wed, 30 Apr 2003 17:16:19 -0700 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. >Unformatted: non-critical low doc-bug