[PATCH] Characters allowed in folder names (#2633)
Jeroen van Meeuwen (Kolab Systems)
vanmeeuwen at kolabsys.com
Sun Aug 8 07:05:22 EDT 2010
Henrique de Moraes Holschuh wrote:
> On Sun, 08 Aug 2010, Jeroen van Meeuwen (Kolab Systems) wrote:
> > - "Expert" settings - you're on your own.
> >
> > This setting, I think, is a typical "you're on your own" type of setting.
>
> So, make it compile-time.
>
I think -from the perspective of a distributor- having consumers of such
distribution recompile with different options because of a niche situation
eliminates an otherwise smooth update path and does deserve some thought
beforehand -like what we're doing here.
> > While I think it should be configurable, I dislike throwing it in the man
> > page. I would argue this type of thing is way better documented on a
> > cyrusimap.org Wiki article.
>
> Bad idea. VERY bad idea.
I take it you disagree ;-)
My point was that (some) advanced settings are more appropriately documented
in a "live" document that can be enhanced by many to explain more about the
advanced setting. Not unlike the documentation in Cyrus IMAP that Debian
patches to express additional information about the use of virtdomains and
authorisation IDs, but not in CVS nor in a specific package from one specific
distributor.
> Please document it properly in the manpage, and
> label it as an advanced config option.
>
And how do you suggest we do mark it as an advanced config option?
> Or make it a compile-time option AND document it in a textfile somewhere.
>
We can ship a text file with the distribution from a wiki article, and put it
in /usr/share/doc/cyrus-imapd. We could create man pages from that content, or
refer to such wiki pages from within the man pages, too. Similarly, relatively
many README articles are being shipped. A wiki article was just a suggestion
though, shipping advanced docs in doc/ would virtually be the same.
The OP already has exactly what you want. It was argued we need to be careful
throwing all too many configurables at the consumer, for which there is
currently only a single mechanism in place. *That's* what I'm trying to work
with here.
--
Jeroen van Meeuwen
Senior Engineer, Kolab Systems AG
e: vanmeeuwen at kolabsys.com
t: +316 42 801 403
w: http://www.kolabsys.com
pgp: 9342 BF08
More information about the Cyrus-devel
mailing list