On Tue, Aug 13, 2019 at 11:32:37AM +0200, Landry Breuil wrote: > 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 agree that the indirection could be avoided, but people *do* read these readmes.
> 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. Well, I know smtpd and we have packages for it, so I search the packages to see what I can do. I hate having to open some HOMEPAGE only to find out how to use a port: that is was README and/or MESSAGE is for. My goal is to provide packages which include all neccessary information if possible, without forcing users through web browsers. > Adding a README for 2 lines is abusing the README mechanism imo. I'm also fine with amending DESCR or putting it in MESSAGE, as long as I don't have to guess where to start after installing the package, because I personally would be one of those users that would install it only to find no manual or documentation whatsoever, angrily going though smtpd(8) and smtpd.conf(5) first hoping for examples, then falling back to the web.
