conf/62772: static_routes needs an example in

[Jerry McAllister]

> 
> The following reply was made to PR conf/62772; it has been noted by GNATS.
> 
> From: Kris Kennaway <kris at obsecurity.org>
> To: hoanga at alum.rpi.edu
> Cc: kris at obsecurity.org, freebsd-gnats-submit at 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 at 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 at freebsd.org mailing list
> http://lists.freebsd.org/mailman/listinfo/freebsd-bugs
> To unsubscribe, send any mail to "freebsd-bugs-unsubscribe at freebsd.org"
>