[arch-general] rc.conf man page

Dave Reisner d at falconindy.com
Tue Aug 24 12:07:58 EDT 2010

On Mon, Aug 23, 2010 at 05:37:29PM -0400, David Campbell wrote:
> Excerpts from Dave Reisner's message of 2010-08-23 14:59:11 -0400:
> > *ROUTES (array)*::
> >         A list of routes to be created. For each item in this list, the 'network'
> >         service expects to find a variable of the same name to exist providing a
> >         string of parameters to be passed to the 'route' command in order to create
> >         the route. Routes can prevented from being created by prefixing with a '!' symbol.
> For a variable to be found it must exist, so "to exist" is
> redundant.
Fixed on my copy.

> The last sentence should read, "Routes can be...", not "Routes can
> prevented...", or better yet, "Prevent a route from being created
> by prefixing it with a bang (!).".
Also fixed, and I like your rewording.

> I like this manpage, although, I am not so sure it is wise to
> have a manpage for rc.conf. rc.conf is well commented, and if
> there is a manpage, the two will have to be kept in sync with
> each other. Having the code with the documentation also makes
> understanding the documentation easier. I suggest either adding
> to the comments in rc.conf if they are not sufficient, or leaving
> out of the manpage information that can already be found in
> rc.conf.

My concern is that /etc/rc.conf is mutable, while a man page is not. AIF
uses this commenting as guidance, but it (as well as rc.conf itself)
could just as easily say "refer to the man page".


More information about the arch-general mailing list