From owner-svn-doc-all@freebsd.org Tue Apr 14 14:27:55 2020 Return-Path: Delivered-To: svn-doc-all@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id 0A7D82C1DC9; Tue, 14 Apr 2020 14:27:55 +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 491nrp6YKNz4HGH; Tue, 14 Apr 2020 14:27:54 +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 DB57869D6; Tue, 14 Apr 2020 14:27:54 +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 03EERssS011796; Tue, 14 Apr 2020 14:27:54 GMT (envelope-from mat@FreeBSD.org) Received: (from mat@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id 03EERsMP011795; Tue, 14 Apr 2020 14:27:54 GMT (envelope-from mat@FreeBSD.org) Message-Id: <202004141427.03EERsMP011795@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: mat set sender to mat@FreeBSD.org using -f From: Mathieu Arnold Date: Tue, 14 Apr 2020 14:27:54 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r54055 - 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: 54055 X-SVN-Commit-Repository: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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, 14 Apr 2020 14:27:55 -0000 Author: mat Date: Tue Apr 14 14:27:54 2020 New Revision: 54055 URL: https://svnweb.freebsd.org/changeset/doc/54055 Log: Fix the pkg-message documentation, it ways lagging behind policies. 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 Mon Apr 13 14:53:20 2020 (r54054) +++ head/en_US.ISO8859-1/books/porters-handbook/pkg-files/chapter.xml Tue Apr 14 14:27:54 2020 (r54055) @@ -62,8 +62,8 @@ raw - A regular plain text file. Its message is always - displayed, on install, and on upgrade. + A regular plain text file. Its message is only + displayed on install. @@ -140,19 +140,11 @@ minimum_version keywords can be combined. - The type keyword can have four + The type keyword can have three values: - (no type specified) - - - The message is always displayed. - - - - install @@ -199,7 +191,7 @@ strings: [ -{ +{ type: install message: "Simple message" } ] @@ -219,7 +211,7 @@ as: [ -{ +{ type: install message: <<EOM Simple message EOM @@ -227,31 +219,6 @@ EOM ] - - Always Display a Message - - If a port has a pkg-message - containing simple text, it can be transformed into - UCL easily. Given this - pkg-message: - - * BIND requires configuration of rndc, including a "secret" key. * -* The easiest, and most secure way to configure rndc is to run * -* 'rndc-confgen -a' to generate the proper conf file, with a new * -* random key, and appropriate file permissions. * - - [ -{ - message: <<EOD -* BIND requires configuration of rndc, including a "secret" key. * -* The easiest, and most secure way to configure rndc is to run * -* 'rndc-confgen -a' to generate the proper conf file, with a new * -* random key, and appropriate file permissions. * -EOD -} -] - - Display a Message on Install/Deinstall @@ -295,6 +262,14 @@ EOD message: "Upgrading from > 1.0 and < 3.0 remove that file." } ] + + + When displaying a message on upgrade, it is important + to limit when it is being shown to the user. Most of the + time it is by using maximum_version to + limit its usage to upgrades from before a certain version + when something specific needs to be done. +