vp-build/common/environment/README

ENVIRONMENT SHELL SNIPPETS
==========================

This directory contains shell files (must not be executable nor contain a shebang)
that are read by xbps-src when building source packages. The shell files
are read in lexical order (as ordered by shell rules).

These files shall set or unset environment variables while building packages.
Only files with the `.sh' extension are read, so this file will be simply ignored.

The following directories are used to set the order in which the shell snippets
should be read by xbps-src:

	* build-style	(to set vars for a specific build_style helper)
	* setup		(before reading template)
	* setup-subpkg	(before running the subpkg <pkgname>_package() function)
	* fetch		(before running fetch phase)
	* extract	(before running extract phase)
	* configure	(before running configure phase)
	* build		(before running build phase)
	* check		(before running check phase)
	* install	(before running install phase)
	* pkg		(before running pkg phase)

NOTES
~~~~~
* Symlinks can be created (relative) to make a shell snippet available in
  multiple phases.
Update infrastructure for xbps-src >= 100. 2014-01-28 13:07:02 +01:00			`ENVIRONMENT SHELL SNIPPETS`
			`==========================`

			`This directory contains shell files (must not be executable nor contain a shebang)`
			`that are read by xbps-src when building source packages. The shell files`
			`are read in lexical order (as ordered by shell rules).`

Infrastructure changes to allow unsetting template vars/funcs. xbps-src-112 does not unset those vars/funcs anymore, so it's a work that must be done via common/environment/setup{,-subpkg}. 2014-03-19 09:03:21 +01:00			`These files shall set or unset environment variables while building packages.`
			Only files with the `.sh' extension are read, so this file will be simply ignored.
Update infrastructure for xbps-src >= 100. 2014-01-28 13:07:02 +01:00
Update environment shell snippets for xbps-src>=101. 2014-02-11 11:09:16 +01:00			`The following directories are used to set the order in which the shell snippets`
			`should be read by xbps-src:`

common/environment/README: build_style -> build-style. 2015-02-21 12:25:57 +01:00			`* build-style (to set vars for a specific build_style helper)`
Update environment shell snippets for xbps-src>=101. 2014-02-11 11:09:16 +01:00			`* setup (before reading template)`
Infrastructure changes to allow unsetting template vars/funcs. xbps-src-112 does not unset those vars/funcs anymore, so it's a work that must be done via common/environment/setup{,-subpkg}. 2014-03-19 09:03:21 +01:00			`* setup-subpkg (before running the subpkg <pkgname>_package() function)`
Update environment shell snippets for xbps-src>=101. 2014-02-11 11:09:16 +01:00			`* fetch (before running fetch phase)`
			`* extract (before running extract phase)`
			`* configure (before running configure phase)`
			`* build (before running build phase)`
xbps-src: implement a 'check' stage Add another stage 'check' between 'build' and 'install'. It is be enabled using the variable XBPS_CHECK_PKGS=yes and disabled if unset, set to "0" or "no" in your local etc/conf. A new xbps-src option `-q` for `quick` will disable XBPS_CHECK_PKGS by overriding it to 0. If enabled, `common/xbps-src/shutils/xbps-src-docheck.sh` checks for an existing `do_check()` function in the package's template and, if it exists, calls it. A new template variable `checkdepends` may be present and list packages required to run the `do_check()` function. Example: `checkdepends="bc unittest-cpp"`. 2017-02-23 22:03:31 +01:00			`* check (before running check phase)`
Update environment shell snippets for xbps-src>=101. 2014-02-11 11:09:16 +01:00			`* install (before running install phase)`
			`* pkg (before running pkg phase)`

			`NOTES`
			`~~~~~`
			`* Symlinks can be created (relative) to make a shell snippet available in`
			`multiple phases.`