diff options
| author | Eli Schwartz <eschwartz@archlinux.org> | 2019-03-12 18:01:13 +0100 |
|---|---|---|
| committer | Allan McRae <allan@archlinux.org> | 2019-03-19 05:33:50 +0100 |
| commit | 9f5412d809a50a7ad18013222582d5b943216ae1 (patch) | |
| tree | 52fa4837ef0d9696f09012dc63e7640ca261f061 /doc/PKGBUILD.5.asciidoc | |
| parent | 7b15918b6526b52823b869050e430b24b30c3ca1 (diff) | |
| download | pacman-9f5412d809a50a7ad18013222582d5b943216ae1.tar.gz pacman-9f5412d809a50a7ad18013222582d5b943216ae1.tar.xz | |
doc: generalize description of the bash nature of PKGBUILD functions
Currently this is scoped to the build() function, which is simply wrong
as it equally applies to any function. Simply moving the paragraphs up
to the main manpage section makes this clear.
Signed-off-by: Eli Schwartz <eschwartz@archlinux.org>
Signed-off-by: Allan McRae <allan@archlinux.org>
Diffstat (limited to 'doc/PKGBUILD.5.asciidoc')
| -rw-r--r-- | doc/PKGBUILD.5.asciidoc | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/doc/PKGBUILD.5.asciidoc b/doc/PKGBUILD.5.asciidoc index 7d6f3271..3bcf5ed7 100644 --- a/doc/PKGBUILD.5.asciidoc +++ b/doc/PKGBUILD.5.asciidoc @@ -332,6 +332,14 @@ PKGBUILD must contain a `package()` function which installs all the package's files into the packaging directory, with optional `prepare()`, `build()`, and `check()` functions being used to create those files from source. +This is directly sourced and executed by makepkg, so anything that Bash or the +system has available is available for use here. Be sure any exotic commands +used are covered by the `makedepends` array. + +If you create any variables of your own in any of these functions, it is +recommended to use the Bash `local` keyword to scope the variable to inside the +function. + *package() Function*:: The `package()` function is used to install files into the directory that will become the root directory of the built package and is run after all @@ -348,14 +356,7 @@ files into the packaging directory, with optional `prepare()`, `build()`, and *build() Function*:: The optional `build()` function is use to compile and/or adjust the source - files in preparation to be installed by the `package()` function. This is - directly sourced and executed by makepkg, so anything that Bash or the - system has available is available for use here. Be sure any exotic - commands used are covered by the `makedepends` array. -+ -If you create any variables of your own in the `build()` function, it is -recommended to use the Bash `local` keyword to scope the variable to inside -the `build()` function. + files in preparation to be installed by the `package()` function. *check() Function*:: An optional `check()` function can be specified in which a package's |