git: aa2e780d4e - main - Copyedit zirias' pre*/post* update.

Pau Amma <[email protected]>
Newsgroups gmane.os.freebsd.devel.cvs.doc
Message-ID <[email protected]>
The branch main has been updated by pauamma:

URL: https://cgit.FreeBSD.org/doc/commit/?id=aa2e780d4e90c2be648323ff4cf56fc2a2aec79c

commit aa2e780d4e90c2be648323ff4cf56fc2a2aec79c
Author:     Pau Amma <[email protected]>
AuthorDate: 2022-09-27 21:12:11 +0000
Commit:     Pau Amma <[email protected]>
CommitDate: 2022-11-13 21:43:24 +0000

    Copyedit zirias' pre*/post* update.
    
    While there, wordsmith a bit more of those sections.
    
    Differential Revision:  https://reviews.freebsd.org/D36770
    
    Reviewed by:    bapt (previous version), bcr, carlavilla
    
    Approved by:    carlavilla (mentor)
---
 .../books/porters-handbook/pkg-files/_index.adoc   | 42 +++++++++++++---------
 1 file changed, 26 insertions(+), 16 deletions(-)

diff --git a/documentation/content/en/books/porters-handbook/pkg-files/_index.adoc b/documentation/content/en/books/porters-handbook/pkg-files/_index.adoc
index d56bc79d9c..413637c4af 100644
--- a/documentation/content/en/books/porters-handbook/pkg-files/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/pkg-files/_index.adoc
@@ -223,44 +223,54 @@ Most of the time it is by using `maximum_version` to limit its usage to upgrades
 ====
 
 [[pkg-install]]
-== pkg-install, pkg-pre-install and pkg-post-install
+== pkg-install, pkg-pre-install, and pkg-post-install
 
 If the port needs to execute commands when the binary package is installed with `pkg add` or `pkg install`, use [.filename]#pkg-install#.
-It will be run twice by `pkg`, the first time as `${SH} pkg-install ${PKGNAME} PRE-INSTALL` before the package is installed, and the second time as `${SH} pkg-install ${PKGNAME} POST-INSTALL` after it has been installed.
+It is run twice by `pkg`, the first time as `${SH} pkg-install ${PKGNAME} PRE-INSTALL` before the package is installed, and the second time as `${SH} pkg-install ${PKGNAME} POST-INSTALL` after it has been installed.
 `$2` can be tested to determine which mode the script is being run in.
-The `PKG_PREFIX` environmental variable will be set to the package installation directory.
+The `PKG_PREFIX` environment variable is set to the package installation directory.
 
-If you use [.filename]#pkg-pre-install# or [.filename]#pkg-post-install# instead, the script is only run once, before or after installation of the package.
-You can also use [.filename]#pkg-pre-install.lua# or [.filename]#pkg-post-install.lua# to run a lua script instead of a shell script.
-Lua scripts run by `pkg` provide some extensions and a few restrictions, for these see man:pkg-lua-script[5].
+If using [.filename]#pkg-pre-install# or [.filename]#pkg-post-install# instead, the script is run only once (before or after installing the package), with the single argument `${PKGNAME}`.
+Using [.filename]#pkg-pre-install.lua# or [.filename]#pkg-post-install.lua# will run a lua script instead of a shell script.
+Lua scripts run by `pkg` provide some extensions and a few restrictions, both explained in man:pkg-lua-script[5].
 
-These scripts will automatically be added to the package.
+[NOTE]
+====
+Using [.filename]#pkg-pre-install# (or [.filename]#pkg-pre-install.lua#) and [.filename]#pkg-post-install# (or [.filename]#pkg-post-install.lua#) is preferred to using [.filename]#pkg-install#.
+====
+
+These scripts are automatically added to the packing list.
 
 [IMPORTANT]
 ====
-These scripts are here to help you set up the package so that it is as ready to use as possible.
+These scripts are here to simplify package configuration after installation.
 They _must not_ be abused to start services, stop services, or run any other commands that will modify the currently running system.
 ====
 
 [[pkg-deinstall]]
-== pkg-deinstall, pkg-pre-deinstall and pkg-post-deinstall
+== pkg-deinstall, pkg-pre-deinstall, and pkg-post-deinstall
 
 These scripts execute when a package is removed.
 
-The [.filename]#pkg-deinstall# script will be run twice by `pkg delete`.
+The [.filename]#pkg-deinstall# script is run twice by `pkg delete`.
 The first time as `${SH} pkg-deinstall ${PKGNAME} DEINSTALL` before the port is de-installed and the second time as `${SH} pkg-deinstall ${PKGNAME} POST-DEINSTALL` after the port has been de-installed.
 `$2` can be tested to determine which mode the script is being run in.
-The `PKG_PREFIX` environmental variable will be set to the package installation directory.
+The `PKG_PREFIX` environment variable is set to the package installation directory.
 
-If you use [.filename]#pkg-pre-deinstall# or [.filename]#pkg-post-deinstall# instead, the script is only run once, before or after removal of the package.
-You can also use [.filename]#pkg-pre-deinstall.lua# or [.filename]#pkg-post-deinstall.lua# to run a lua script instead of a shell script.
-Lua scripts run by `pkg` provide some extensions and a few restrictions, for these see man:pkg-lua-script[5].
+If using [.filename]#pkg-pre-deinstall# or [.filename]#pkg-post-deinstall# instead, the script is run only once (before or after deinstalling the package), with the single argument `${PKGNAME}`.
+Using [.filename]#pkg-pre-deinstall.lua# or [.filename]#pkg-post-deinstall.lua# will run a lua script instead of a shell script.
+Lua scripts run by `pkg` provide some extensions and a few restrictions, both explained in man:pkg-lua-script[5].
+
+[NOTE]
+====
+Using [.filename]#pkg-pre-deinstall# (or [.filename]#pkg-pre-deinstall.lua#) and [.filename]#pkg-post-deinstall# (or [.filename]#pkg-post-deinstall.lua#) is preferred to using [.filename]#pkg-deinstall#.
+====
 
-These scripts will automatically be added to the package.
+These scripts are automatically added to the packing list.
 
 [IMPORTANT]
 ====
-These scripts are here to help you set up the package so that it is as ready to use as possible.
+These scripts are here to simplify cleanup after package deinstallation.
 They _must not_ be abused to start services, stop services, or run any other commands that will modify the currently running system.
 ====
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.