Better paths in documentation

Russ Allbery rra at stanford.edu
Sun Dec 14 03:34:29 UTC 2008


This was about changing references to mention I<pathbin> and friends
instead of the /usr/local/news default paths.

Julien ÉLIE <julien at trigofacile.com> writes:

> I have just updated the POD documentation to mention inn.conf paths
> whenever it is possible.
>
> Note that I did not change checklist.pod and install.pod because I am
> not sure whether it is better to put <pathbin> & co in these files
> (except for the first instruction which explains how to use --prefix).
> I don't know; it can also be better for clarity and understanding the
> role of the paths set in inn.conf if these two files are using
> <path...>.  Better sooner than later for they who install INN.
>
> What do you think about that?

I think changing checklist.pod and install.pod that way is a good idea for
exactly the reasons that you state.  We may as well be consistent across
all of the documentation, including the install documentation.

I've created a ticket for this (#5).

-- 
Russ Allbery (rra at stanford.edu)             <http://www.eyrie.org/~eagle/>

    Please send questions to the list rather than mailing me directly.
     <http://www.eyrie.org/~eagle/faqs/questions.html> explains why.



More information about the inn-workers mailing list