From owner-freebsd-ports@freebsd.org Sat Jun 8 18:12:15 2019 Return-Path: Delivered-To: freebsd-ports@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id F3D5315AF59C for ; Sat, 8 Jun 2019 18:12:14 +0000 (UTC) (envelope-from adamw@freebsd.org) Received: from smtp.freebsd.org (smtp.freebsd.org [96.47.72.83]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) server-signature RSA-PSS (4096 bits) client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "smtp.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 91C556CDFC for ; Sat, 8 Jun 2019 18:12:14 +0000 (UTC) (envelope-from adamw@freebsd.org) Received: from mail-wr1-f49.google.com (mail-wr1-f49.google.com [209.85.221.49]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (Client CN "smtp.gmail.com", Issuer "GTS CA 1O1" (verified OK)) (Authenticated sender: adamw/mail) by smtp.freebsd.org (Postfix) with ESMTPSA id 61062413D for ; Sat, 8 Jun 2019 18:12:14 +0000 (UTC) (envelope-from adamw@freebsd.org) Received: by mail-wr1-f49.google.com with SMTP id r18so5207646wrm.10 for ; Sat, 08 Jun 2019 11:12:14 -0700 (PDT) X-Gm-Message-State: APjAAAWB4TUdtp70jCR20UgV2K3BHiQESvVuJLMEKY+HWXeDgO8esk16 lKAzEWuKLeraTZfLMoH6IF4W8VNrGPZrKNuZn6iEOA== X-Google-Smtp-Source: APXvYqx/+q6Lys/E0u/+iu3Nv/hbfN4aWyM+JLnbFV+Cu0YUIEpyCh9n2g8GEJVwe2Wc5LbBO9Kyk/yaXkv+I6m2ZNs= X-Received: by 2002:adf:da4d:: with SMTP id r13mr201494wrl.54.1560017533339; Sat, 08 Jun 2019 11:12:13 -0700 (PDT) MIME-Version: 1.0 From: Adam Weinberger Date: Sat, 8 Jun 2019 12:11:57 -0600 X-Gmail-Original-Message-ID: Message-ID: Subject: Cleaning up pkg-message To: FreeBSD Ports Content-Type: text/plain; charset="UTF-8" X-Rspamd-Queue-Id: 91C556CDFC X-Spamd-Bar: -- Authentication-Results: mx1.freebsd.org X-Spamd-Result: default: False [-2.98 / 15.00]; local_wl_from(0.00)[freebsd.org]; NEURAL_HAM_MEDIUM(-1.00)[-0.999,0]; NEURAL_HAM_SHORT(-0.98)[-0.985,0]; ASN(0.00)[asn:11403, ipnet:96.47.64.0/20, country:US]; NEURAL_HAM_LONG(-1.00)[-1.000,0] X-BeenThere: freebsd-ports@freebsd.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Porting software to FreeBSD List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 08 Jun 2019 18:12:15 -0000 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