On Tue, Aug 13, 2019 at 11:18:33AM +0200, Klemens Nanni wrote: > On Tue, Aug 13, 2019 at 08:37:18AM +0000, Gilles Chehade wrote: > > filter-rspamd doesn't have any configuration itself, all it needs is for > > smtpd.conf to reference it: > > > > filter "rspamd" proc-exec "/usr/local/bin/filter-rspamd" > > listen on all filter "rspamd" > > > > I thought I'd add this as an example to the smtpd.conf(5) man page itself. > Sounds good. > > > Should I add a README in the port too ? > Yes please, either reference smtpd.conf(5) or just include the same > example here. Adding a pkg/README to the port should do it; this way > pkg_add would tell you > > opensmtpd-filter-rspamd-X.Y: ok > New and changed readme(s): > /usr/local/share/doc/pkg-readmes/opensmtpd-filter-rspamd > > so users know immediately how to set things up.
Sorry, but i dont think this makes sense. With your reasoning, 2 extra lines will be displayed at the end of pkg_add, for a 2-lines README. lots of indirections for not much information... and we already know users dont read them anyway. I doubt ppl will come to filter-rspamd directly (and then wonder how to set it up, in that case they will lookup HOMEPAGE), they might be more 'directed' at it by a mention of this same example in smtpd.conf(5) or a commented out entry in the default smtpd.conf. Adding a README for 2 lines is abusing the README mechanism imo. Landry
