Hi,

clematis wrote on Sat, Apr 25, 2020 at 11:34:14PM +0200:

> But then based on your feedback I wonder if there's even any 
> value of an example file which gives not much more than an already
> well documented manpage?

We had that discussion among developers at least twice in the past.

If i were the only developer, which very fortunately i'm not,
i would probably go for fewer files in /etc/examples/.

But there are also several developers who find it quite
convenient to have a larger number of small example files
around, for various reasons, for example because it is often
quicker to get a general feeling for the basic syntax by looking
at a concise example file compared to reading an abstract
description in the manual page, and because copy and paste
from manual pages is somewhat hindered by indentation (don't
suggest solutions for that, it is not really an issue that
needs solving).

It hasn't been very productive when i proposed such files
for deletion, so i tend to not press such issues again.

But that doesn't mean i'd gladly agree to start tripling or
quadrupling the sizes of existing files without good reasons.

> And again, please don't get me wrong, I don't
> mean to play devil's advocate but do we even need an
> /etc/examples/doas.conf? 
> (for all the very valid reasons you've mentioned as well, clarity,
> existing documentation etc...)

If i remember correctly, there were quite a few developers
who considered it useful to keep a short examples/doas.conf
around and didn't like the idea of deleting it.

> I would be tempted to put a few others in the same boat:

Yes, there are certainly a few others were more or less the
same arguments apply like for doas.conf.

Yours,
  Ingo

Reply via email to