> --- Simon Matter <simon.matter@...> wrote:
>> I still don't really like it. Why not have a .txt
>> file for every config
>> file which holds the comments? Like
>> Then, the package management could always overwrite
>> the .txt files and
>> never has to care about any real config file.
> That was my original thought too but that would imply
> moving the *.txt to something like /usr/share/doc. Why
> keep them in the config dir?
I'd keep them just for convenience, even if they don't really belong
there. ( Some other software like squid also does this somehow, you
usually find /etc/squid/squid.conf.default which is something I like.)
> It's a solution anyway but what I like about the
> current config files is that you have all the keywords
> at your fingertips. I don't have to open another
> console to read a doc file unless I need more info on
> a specific command/option. That's why I proposed to
> leave a few lines with only a "quick reference" to
> Shorewall syntax.
> But of course I realize that it would also double the
> maintenance (config headers + full documentation).
> I must say however that leaving the *.txt files in the
> config dir might be better than moving them to the doc
> dir because the update script would then force the
> user to "see the version changes" and avoid errors.
One more idea: You can still cut'n'paste the relevant parts of the .txt
files to your real config files. Everybody is free to do that but I don't
think it makes sense to include parts of the .txt file in the config
So, it still seems the easiest solution to have the documentation in .txt
(or .sample) files and keep the real config files clean.
Let's wait what Tom has to say about it, he usually comes up with an even
better solution :)