Date: Sat, 8 Jun 2019 12:16:05 -0600 From: Adam Weinberger <adamw@adamw.org> To: FreeBSD Ports <freebsd-ports@freebsd.org> Subject: Cleaning up pkg-message Message-ID: <CAP7rwcin2C6LbKTKzDYe1Y1mzZN%2Bu7J-5MMEfjw7BgptKHs4mA@mail.gmail.com>
next in thread | raw e-mail | index | archive | help
Hello everyone,
I want to get some stakeholder input on our pkg-message files. I think
we need to have a clear policy about what does and doesn't belong in
them, and I'd like to get your input.
pkg-message is shown to every user on every install. UPDATING is only
shown when users run `pkg updating` *and* /usr/ports/UPDATING exists.
I suspect that only a small proportion of users do that.
pkg-message needs to contain only highly relevant information. Many,
many ports have messages with irrelevant information that users are
likely to get message fatigue and ignore them entirely. I don't want
to pick on Joe Barbish, because his work is absolutely fantastic, but
dns/dns2blackhole/pkg-message is an example of a giant message that
tells users to do the same thing they always do for any port:
########################################################################
dns2blackhole
Malware Prevention through Domain Blocking (Black Hole)
Issue "man dns2blackhole" For configuration and usage information
########################################################################
We now have the ability to specify messages that appear on initial
install, or on upgrades from/to specific version. So here is what I
propose as policy:
>>>
pkg-message must contain only information that is vital to setup and
operation, and that is unique to the port in question. Setup
information should only be shown on initial install, and upgrade
instructions should be shown only when upgrading to the relevant
version. All committers have blanket approval to constrain existing
messages to install/upgrade ranges using the UCL format
specifications. Message pruning falls under the blanket approval as
well, but committers are encouraged to get maintainer input
beforehand.
<<<
What are your thoughts?
# Adam
--
Adam Weinberger
adamw@adamw.org // adamw@FreeBSD.org
https://www.adamw.org
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?CAP7rwcin2C6LbKTKzDYe1Y1mzZN%2Bu7J-5MMEfjw7BgptKHs4mA>