nixpkgs/doc/hooks/haredo.section.md
Tomodachi94 6157b42ca7
doc/hooks/haredo: add documentation
Hook introduced in #269767 by @pbsds.

Part of #341479.
2024-09-14 10:33:41 -07:00

1.4 KiB

haredo

This hook uses the haredo command runner to build, check, and install the package. It overrides buildPhase, checkPhase, and installPhase by default.

The hook builds its targets in parallel if config.enableParallelBuilding is set to true.

buildPhase

This phase attempts to build the default target.

[]{#haredo-hook-haredoBuildTargets} Targets can be explicitly set by adding a string to the haredoBuildTargets list.

[]{#haredo-hook-dontUseHaredoBuild} This behavior can be disabled by setting dontUseHaredoBuild to true.

checkPhase

This phase searches for the check.do or test.do targets, running them if they exist.

[]{#haredo-hook-haredoCheckTargets} Targets can be explicitly set by adding a string to the haredoCheckTargets list.

[]{#haredo-hook-dontUseHaredoCheck} This behavior can be disabled by setting dontUseHaredoCheck to true.

installPhase

This phase attempts to build the install.do target, if it exists.

[]{#haredo-hook-haredoInstallTargets} Targets can be explicitly set by adding a string to the haredoInstallTargets list.

[]{#haredo-hook-dontUseHaredoInstall} This behavior can be disabled by setting dontUseHaredoInstall to true.