[pacman-dev] [PATCH] doc/PKGBUILD: clarify scriptlet version arguments

Dan McGee dan at archlinux.org
Tue Jul 5 23:30:35 EDT 2011


It was a bit unclear that both pkgver and pkgrel were included in the
passed version strings; clarify this fact in the manpage.

Also make two other minor consistency touchups to code-print variables
in text.

Signed-off-by: Dan McGee <dan at archlinux.org>
---

On maint, not that I think we will be doing another release.

 doc/PKGBUILD.5.txt |   16 ++++++++--------
 1 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/doc/PKGBUILD.5.txt b/doc/PKGBUILD.5.txt
index c0fa594..0ead546 100644
--- a/doc/PKGBUILD.5.txt
+++ b/doc/PKGBUILD.5.txt
@@ -99,7 +99,7 @@ similar to `$_basekernver`.
 	An array of source files required to build the package. Source files
 	must either reside in the same directory as the PKGBUILD file, or be a
 	fully-qualified URL that makepkg will use to download the file. In order
-	to make the PKGBUILD as useful as possible, use the $pkgname and $pkgver
+	to make the PKGBUILD as useful as possible, use the `$pkgname` and `$pkgver`
 	variables if possible when specifying the download location. Any files
 	that are compressed will automatically be extracted, unless found in
 	the noextract array listed below.
@@ -255,7 +255,7 @@ use here. The function is run in `bash -e` mode, meaning any command that exits
 with a non-zero status will cause the function to exit. Be sure any exotic
 commands used are covered by `makedepends`.
 
-All of the above variables such as `pkgname` and `pkgver` are available for use
+All of the above variables such as `$pkgname` and `$pkgver` are available for use
 in the build function. In addition, makepkg defines three variables for your
 use during the build and install process. These three variables are as follows:
 
@@ -325,27 +325,27 @@ The exact time the script is run varies with each operation:
 
 *pre_install*::
 	script is run right before files are extracted. One argument is passed:
-	new package version.
+	new package 'pkgver-pkgrel'.
 
 *post_install*::
 	script is run right after files are extracted. One argument is passed:
-	new package version.
+	new package 'pkgver-pkgrel'.
 
 *pre_upgrade*::
 	script is run right before files are extracted. Two arguments are passed
-	in the following order: new package version, old package version.
+	in this order: new package 'pkgver-pkgrel', old package 'pkgver-pkgrel'.
 
 *post_upgrade*::
 	script is run after files are extracted. Two arguments are passed
-	in the following order: new package version, old package version.
+	in this order: new package 'pkgver-pkgrel', old package 'pkgver-pkgrel'.
 
 *pre_remove*::
 	script is run right before files are removed. One argument is passed:
-	old package version.
+	old package 'pkgver-pkgrel'.
 
 *post_remove*::
 	script is run right after files are removed. One argument is passed:
-	old package version.
+	old package 'pkgver-pkgrel'.
 
 To use this feature, create a file such as 'pkgname.install' and put it in the
 same directory as the PKGBUILD script. Then use the install directive:
-- 
1.7.6



More information about the pacman-dev mailing list