From owner-freebsd-bugs@FreeBSD.ORG Fri Feb 13 01:10:31 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 E23C716A5F4 for ; Fri, 13 Feb 2004 01:10:31 -0800 (PST) Received: from freefall.freebsd.org (freefall.freebsd.org [216.136.204.21]) by mx1.FreeBSD.org (Postfix) with ESMTP id C4CA843D39 for ; Fri, 13 Feb 2004 01:10:31 -0800 (PST) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (gnats@localhost [127.0.0.1]) i1D9AVbv037020 for ; Fri, 13 Feb 2004 01:10:31 -0800 (PST) (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.12.10/8.12.10/Submit) id i1D9AVqE037014; Fri, 13 Feb 2004 01:10:31 -0800 (PST) (envelope-from gnats) Date: Fri, 13 Feb 2004 01:10:31 -0800 (PST) Message-Id: <200402130910.i1D9AVqE037014@freefall.freebsd.org> To: freebsd-bugs@FreeBSD.org From: Subject: Re: conf/62772: static_routes needs an example in /etc/defaults/rc.conf X-BeenThere: freebsd-bugs@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list Reply-To: hoanga@alum.rpi.edu List-Id: Bug reports List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 13 Feb 2004 09:10:32 -0000 The following reply was made to PR conf/62772; it has been noted by GNATS. From: To: Cc: Subject: Re: conf/62772: static_routes needs an example in /etc/defaults/rc.conf Date: Fri, 13 Feb 2004 01:06:20 -0800 This is a multi-part message in MIME format. ------=_NextPart_000_15C4D_01C3F1CD.973860F0 Content-Type: text/plain; charset="iso-8859-1" Content-Transfer-Encoding: 7bit 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'. I understand that this is documented if you read this very carefully however I don't feel it's crystal clear to people who are slow to read these manpages (like me). After a reboot and realizing I was making a mistake I started looking for an example to clarify exactly what the manpage meant. (I personally like looking at examples to clarify manpage explanations). In the end I just looked at /etc/rc.d/routing (after tracing the system startup scripts) and and figured out how static_routes was parsed and its relation to route_. This process took me about a few hours of looking at the documentation, trying my own examples and finally looking at the shell scripts for what I assumed was a 15 minute change and check. So yes, I feel this is unclear. Considering the large amount of examples and documentation that went into making an IPv6 static route, a few lines for creating a static IPv4 route wouldn't hurt for someone else in the future. Best regards, Alain ------=_NextPart_000_15C4D_01C3F1CD.973860F0 Content-Type: text/html Content-Transfer-Encoding: 7bit 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'.
I understand that this is documented if you read this very carefully
however I don't feel it's crystal clear to people who are slow to
read these manpages (like me).
After a reboot and realizing I was making a mistake I started
looking for an example to clarify exactly what the manpage meant.
(I personally like looking at examples to clarify manpage explanations).
In the end I just looked at /etc/rc.d/routing (after tracing the system
startup scripts) and and figured out how static_routes was parsed
and its relation to route_. This process took me about
a few hours of looking at the documentation, trying my own examples and
finally looking at the shell scripts for what I assumed was a 15 minute
change and check. So yes, I feel this is unclear. Considering the
large amount of examples and documentation that went into making
an IPv6 static route, a few lines for creating a static IPv4 route wouldn't
hurt for someone else in the future.

Best regards,
Alain ------=_NextPart_000_15C4D_01C3F1CD.973860F0--