void-packages/common/hooks
Noah Huppert 984fa5d9cb xbps-src: fixed dangling binpkg lock on error
Co-authored-by: Noah Huppert <contact@noahh.io>
Co-authored-by: Andrew J. Hesford <ajh@sideband.org>

Closes: #24191 [via git-merge-pr]
2020-08-17 09:42:08 -04:00
..
do-build
do-check add hook-directories for check phase 2017-11-18 14:32:37 +01:00
do-configure
do-extract hooks/do-extract: refrain from extracting text files outside wrksrc 2020-02-19 19:02:01 +01:00
do-fetch 00-distfiles.sh: fix status phrasing 2020-05-10 10:57:40 +02:00
do-install
do-patch 00-patches.sh: avoid useless use of cat 2019-04-15 12:18:00 -03:00
do-pkg xbps-src: fixed dangling binpkg lock on error 2020-08-17 09:42:08 -04:00
post-build
post-check add hook-directories for check phase 2017-11-18 14:32:37 +01:00
post-configure
post-extract meta: move 00-patches.sh hook to do-patch phase 2019-02-27 22:56:19 -03:00
post-fetch
post-install xbps-triggers: add texmf-dist regeneration trigger 2020-07-14 02:38:24 +02:00
post-patch meta: add hook directories for patch phase 2019-02-27 22:56:19 -03:00
post-pkg common: merge only_for_archs and noarch=yes into one. 2019-02-15 13:19:44 +01:00
pre-build
pre-check add hook-directories for check phase 2017-11-18 14:32:37 +01:00
pre-configure common/wrapper: python*-config: answer --includes 2020-07-04 22:22:10 +07:00
pre-extract
pre-fetch
pre-install base-files: install /usr/lib32 symlink on i686 2019-12-15 09:17:51 +01:00
pre-patch meta: add hook directories for patch phase 2019-02-27 22:56:19 -03:00
pre-pkg xbps-src: consume all shebang arguments during rewrite 2020-06-18 09:38:18 +02:00
README

README

HOOKS
=====

This directory contains shell hooks that are processed after or before the
specified phase. The shell hooks are simply shell snippets (must not be
executable nor contain a shebang) that are processed lexically by xbps-src.
Only files with the `.sh` extension are processed.

A shell hook must provide a `hook()` function which is the entry point to
execute it via xbps-src.

The following directories are used to set the order in which the hooks
should be processed by xbps-src:

	* pre-fetch		(before running fetch phase)
	* do-fetch		(running fetch phase)
	* post-fetch		(after running fetch phase)

	* pre-extract		(before running extract phase)
	* do-extract		(running extract phase)
	* post-extract		(after running extract phase)

	* pre-configure		(before running configure phase)
	* do-configure		(running configure phase)
	* post-configure	(after running configure phase)

	* pre-build		(before running build phase)
	* do-build		(running build phase)
	* post-build		(after running build phase)

	* pre-install		(before running install phase)
	* do-install		(running install phase)
	* post-install		(after running install phase)

	* pre-pkg		(before running pkg phase)
	* do-pkg		(running pkg phase)
	* post-pkg		(after running pkg phase)

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

* The phases do-fetch, do-extract, do-configure, do-build, and do-install can
  be overwritten by the template file. That means if a template contains a
  do_install function, the hooks defined for do-install won't be executed.
  Note that this is only true for the do-* hooks.

* the pre_* function of the template will be run *after* the corresponding
  pre-* hooks.

* the post_* function of the template will be run *before* the corresponding
  post-* hooks.