From owner-freebsd-bugs@FreeBSD.ORG Sat Feb 14 05:40:14 2004 Return-Path: Delivered-To: freebsd-bugs@hub.freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 146F216A4F0 for ; Sat, 14 Feb 2004 05:40:14 -0800 (PST) Received: from freefall.freebsd.org (freefall.freebsd.org [216.136.204.21]) by mx1.FreeBSD.org (Postfix) with ESMTP id ED94843D31 for ; Sat, 14 Feb 2004 05:40:13 -0800 (PST) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (gnats@localhost [127.0.0.1]) i1EDeDbv079751 for ; Sat, 14 Feb 2004 05:40:13 -0800 (PST) (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.12.10/8.12.10/Submit) id i1EDeDOv079749; Sat, 14 Feb 2004 05:40:13 -0800 (PST) (envelope-from gnats) Date: Sat, 14 Feb 2004 05:40:13 -0800 (PST) Message-Id: <200402141340.i1EDeDOv079749@freefall.freebsd.org> To: freebsd-bugs@FreeBSD.org From: "Simon L. Nielsen" Subject: Re: conf/62772: static_routes needs an example in X-BeenThere: freebsd-bugs@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list Reply-To: "Simon L. Nielsen" List-Id: Bug reports List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 14 Feb 2004 13:40:14 -0000 The following reply was made to PR conf/62772; it has been noted by GNATS. From: "Simon L. Nielsen" To: Jerry McAllister Cc: kris@obsecurity.org, Alain Hoang , freebsd-gnats-submit@FreeBSD.org Subject: Re: conf/62772: static_routes needs an example in Date: Sat, 14 Feb 2004 14:36:45 +0100 --y0ulUmNC+osPPQO6 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On 2004.02.13 10:45:31 -0500, Jerry McAllister wrote: > >=20 > > The following reply was made to PR conf/62772; it has been noted by GNA= TS. > >=20 > > From: Kris Kennaway > > To: hoanga@alum.rpi.edu > > Cc: kris@obsecurity.org, freebsd-gnats-submit@FreeBSD.org > > Subject: Re: conf/62772: static_routes needs an example in /etc/default= s/rc.conf > > Date: Fri, 13 Feb 2004 01:22:28 -0800 > >=20 > > > Thanks for the quick response. I had read the documentation > > > in the manpage as well and misinterpreted 'Set to the list of static > > > routes' > > > as 'please insert your static route here' rather than 'please > > > put a list of identifiers that are space seperated that will be used= as > > > a reference to route_ that containts all the options=20 > > > you need to feed to the route command to add the route'. > > =20 > > The second sentence says precisely that, although perhaps it can be > > clarified..I don't think an example is needed here, but I'll leave it > > up to the manpage people to decide. >=20 > I have always been of the opinion that examples are always in order. > Language is a funny thing - especially English and can be misunderstood > regardless of how clear the writer thinks the text is. An example > or two tends to clear away a lot of potential fog (for both the writer=20 > and the reader) even in the simplest situation. At least it can give=20 > the reader - who is reading it because [s]he doesn't already know > the information - some comfort and that has value too. While I generally agree that examples are a very good thing, I don't think it's a good idea to put on in either defaults/rc.conf or the rc.conf(5) manual page, since both are already very big files. I think the best solution would be for someone to write a section about this for the Handbook (section '19.2 Gateways and Routes' seems the right place). Any takes ? :-) --=20 Simon L. Nielsen FreeBSD Documentation Team --y0ulUmNC+osPPQO6 Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.3 (FreeBSD) iD8DBQFALiRmh9pcDSc1mlERAv6IAKCgZoizqdLRdgmMh4tUq6B1Khd/4wCeNeaA cb4PbYkBpvhUf277nyoDqL4= =pIQr -----END PGP SIGNATURE----- --y0ulUmNC+osPPQO6--