bryson/pacman
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: generalize description of the bash nature of PKGBUILD functions

Browse source 
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>
This commit is contained in:
Eli Schwartz 2019-03-12 13:01:13 -04:00 • committed by Allan McRae
parent 7b15918b65
commit 9f5412d809
1 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
doc/PKGBUILD.5.asciidoc
View file

@ -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 files into the packaging directory, with optional `prepare()`, `build()`, and
`check()` functions being used to create those files from source. `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*:: *package() Function*::
The `package()` function is used to install files into the directory that 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 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*:: *build() Function*::
The optional `build()` function is use to compile and/or adjust the source 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 files in preparation to be installed by the `package()` function.
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.
*check() Function*:: *check() Function*::
An optional `check()` function can be specified in which a package's An optional `check()` function can be specified in which a package's