Better paths in documentation

Julien ÉLIE julien at trigofacile.com
Mon Sep 3 09:49:45 UTC 2007


En réponse à Julien ÉLIE :
> En réponse à Russ Allbery :
>> I think there are only a few places that aren't controlled by the inn.conf
>> options.

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?


>> One of them is the path to inn.conf, which is referenced in
>> various places and which should have a hard-coded path.

Yes.  It is INN_PATH_CONFIG but it does not appear in the POD documentation.
There is also contrib/innconfcheck which uses a hard-coded path.


>    ignore_file=<pathetc in inn.conf>/actsync.ign
>    :<pathbin>/archive -f -i <patharchive>/INDEX
>
> Which behaviour do you prefer?
>
> It could be a mix of the first [for first use in the man page for instance]
> and the second.

I did that.


> By the way, is it OK if I commit makedepend's changes?

Done.

-- 
Julien ÉLIE

« Après la clairière d'attente, on entre dans la hutte
  de consultation. » (Astérix) 



More information about the inn-workers mailing list