doc/hooks/haredo: add documentation

Hook introduced in #269767 by @pbsds.

Part of #341479.
This commit is contained in:
Tomodachi94 2024-09-14 10:29:43 -07:00
parent 64f1b1421a
commit 6157b42ca7
No known key found for this signature in database
GPG Key ID: 2E275F21C4D554A3
2 changed files with 30 additions and 0 deletions

View File

@ -0,0 +1,29 @@
# `haredo` {#haredo-hook}
This hook uses [the `haredo` command runner](https://sr.ht/~autumnull/haredo/) 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`](#var-stdenv-enableParallelBuilding) is set to `true`.
## `buildPhase` {#haredo-hook-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` {#haredo-hook-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` {#haredo-hook-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`.

View File

@ -15,6 +15,7 @@ cmake.section.md
gdk-pixbuf.section.md gdk-pixbuf.section.md
ghc.section.md ghc.section.md
gnome.section.md gnome.section.md
haredo.section.md
installShellFiles.section.md installShellFiles.section.md
libiconv.section.md libiconv.section.md
libxml2.section.md libxml2.section.md