From owner-svn-doc-all@freebsd.org Tue Jun 11 13:00:58 2019 Return-Path: Delivered-To: svn-doc-all@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 7643F15BA51F; Tue, 11 Jun 2019 13:00:58 +0000 (UTC) (envelope-from mat@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (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 "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 1DABA8AC1E; Tue, 11 Jun 2019 13:00:58 +0000 (UTC) (envelope-from mat@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id BD0FE1DE6; Tue, 11 Jun 2019 13:00:57 +0000 (UTC) (envelope-from mat@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id x5BD0vmW069824; Tue, 11 Jun 2019 13:00:57 GMT (envelope-from mat@FreeBSD.org) Received: (from mat@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id x5BD0vEr069823; Tue, 11 Jun 2019 13:00:57 GMT (envelope-from mat@FreeBSD.org) Message-Id: <201906111300.x5BD0vEr069823@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: mat set sender to mat@FreeBSD.org using -f From: Mathieu Arnold Date: Tue, 11 Jun 2019 13:00:57 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r53135 - head/en_US.ISO8859-1/books/porters-handbook/pkg-files X-SVN-Group: doc-head X-SVN-Commit-Author: mat X-SVN-Commit-Paths: head/en_US.ISO8859-1/books/porters-handbook/pkg-files X-SVN-Commit-Revision: 53135 X-SVN-Commit-Repository: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Rspamd-Queue-Id: 1DABA8AC1E X-Spamd-Bar: -- Authentication-Results: mx1.freebsd.org X-Spamd-Result: default: False [-2.95 / 15.00]; local_wl_from(0.00)[FreeBSD.org]; NEURAL_HAM_MEDIUM(-1.00)[-0.999,0]; NEURAL_HAM_SHORT(-0.95)[-0.955,0]; ASN(0.00)[asn:11403, ipnet:2610:1c1:1::/48, country:US]; NEURAL_HAM_LONG(-1.00)[-1.000,0] X-BeenThere: svn-doc-all@freebsd.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "SVN commit messages for the entire doc trees \(except for " user" , " projects" , and " translations" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 11 Jun 2019 13:00:58 -0000 Author: mat Date: Tue Jun 11 13:00:57 2019 New Revision: 53135 URL: https://svnweb.freebsd.org/changeset/doc/53135 Log: Add guidelines for when to add a pkg-message. Submitted by: adamw Reviewed by: adamw, bapt Differential Revision: https://reviews.freebsd.org/D20578 Modified: head/en_US.ISO8859-1/books/porters-handbook/pkg-files/chapter.xml Modified: head/en_US.ISO8859-1/books/porters-handbook/pkg-files/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/pkg-files/chapter.xml Tue Jun 11 08:23:17 2019 (r53134) +++ head/en_US.ISO8859-1/books/porters-handbook/pkg-files/chapter.xml Tue Jun 11 13:00:57 2019 (r53135) @@ -18,11 +18,26 @@ <filename>pkg-message</filename> - To display a message when the package is installed, - place the message in pkg-message. This + To display a message when the package is installed, place + the message in pkg-message. This capability is often useful to display additional installation - steps to be taken after a pkg install or to - display licensing information. + steps to be taken after a pkg install or + pkg upgrade. + + + pkg-message must contain only + information that is vital to setup and + operation on &os;, and that is unique to the port in + question. + + Setup information should only be shown on initial install. + Upgrade instructions should be shown only when upgrading from + the relevant version. + + Committers have blanket approval to constrain existing + messages to install or upgrade ranges using the + UCL format specifications. + pkg-message supports two formats: