From owner-freebsd-bugs@FreeBSD.ORG Fri Feb 13 07:45:35 2004 Return-Path: Delivered-To: freebsd-bugs@freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 19FB516A4CE for ; Fri, 13 Feb 2004 07:45:35 -0800 (PST) Received: from clunix.cl.msu.edu (clunix.cl.msu.edu [35.9.2.10]) by mx1.FreeBSD.org (Postfix) with ESMTP id 9981E43D1D for ; Fri, 13 Feb 2004 07:45:34 -0800 (PST) (envelope-from jerrymc@clunix.cl.msu.edu) Received: (from jerrymc@localhost) by clunix.cl.msu.edu (8.11.7p1+Sun/8.11.7) id i1DFjWp07103; Fri, 13 Feb 2004 10:45:32 -0500 (EST) From: Jerry McAllister Message-Id: <200402131545.i1DFjWp07103@clunix.cl.msu.edu> To: kris@obsecurity.org Date: Fri, 13 Feb 2004 10:45:31 -0500 (EST) In-Reply-To: <200402130930.i1D9UP0E039134@freefall.freebsd.org> from "Kris Kennaway" at Feb 13, 2004 01:30:25 AM X-Mailer: ELM [version 2.5 PL2] MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: 7bit cc: freebsd-bugs@freebsd.org Subject: Re: conf/62772: static_routes needs an example in X-BeenThere: freebsd-bugs@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list List-Id: Bug reports List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 13 Feb 2004 15:45:35 -0000 > > The following reply was made to PR conf/62772; it has been noted by GNATS. > > 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/defaults/rc.conf > Date: Fri, 13 Feb 2004 01:22:28 -0800 > > On Fri, Feb 13, 2004 at 01:06:20AM -0800, hoanga@alum.rpi.edu wrote: > > Hi there, > > > > > The documentation is (surprise!) in the manpage. > > > > > static_routes > > > (str) Set to the list of static routes that are to be added > > > at system boot time. If not set to ``NO'' then for each > > > whitespace separated element in the value, a route_ > > > variable is assumed to exist whose contents will later be > > > passed to a ``route add'' operation. > > > > >Is that really unclear enough to require an example? > > > > 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 > > you need to feed to the route command to add the route'. > > 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. 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 and the reader) even in the simplest situation. At least it can give the reader - who is reading it because [s]he doesn't already know the information - some comfort and that has value too. ////jerry > > Kris > _______________________________________________ > freebsd-bugs@freebsd.org mailing list > http://lists.freebsd.org/mailman/listinfo/freebsd-bugs > To unsubscribe, send any mail to "freebsd-bugs-unsubscribe@freebsd.org" >