diff options
author | Alyssa Ross <hi@alyssa.is> | 2023-09-01 11:51:02 +0000 |
---|---|---|
committer | Alyssa Ross <hi@alyssa.is> | 2023-09-01 11:51:02 +0000 |
commit | aa4353b499e6950b7333578f936455a628145c31 (patch) | |
tree | c6332cedece2327a18d08794755b3fc0f9f1905b /nixpkgs/doc/hooks | |
parent | ac456d475f4e50818499b804359355c0f3b4bbf7 (diff) | |
parent | 52185f4d76c18d8348f963795dfed1de018e8dfe (diff) | |
download | nixlib-aa4353b499e6950b7333578f936455a628145c31.tar nixlib-aa4353b499e6950b7333578f936455a628145c31.tar.gz nixlib-aa4353b499e6950b7333578f936455a628145c31.tar.bz2 nixlib-aa4353b499e6950b7333578f936455a628145c31.tar.lz nixlib-aa4353b499e6950b7333578f936455a628145c31.tar.xz nixlib-aa4353b499e6950b7333578f936455a628145c31.tar.zst nixlib-aa4353b499e6950b7333578f936455a628145c31.zip |
Merge https://github.com/NixOS/nixpkgs
Diffstat (limited to 'nixpkgs/doc/hooks')
-rw-r--r-- | nixpkgs/doc/hooks/index.md | 1 | ||||
-rw-r--r-- | nixpkgs/doc/hooks/mpi-check-hook.section.md | 24 | ||||
-rw-r--r-- | nixpkgs/doc/hooks/waf.section.md | 49 |
3 files changed, 73 insertions, 1 deletions
diff --git a/nixpkgs/doc/hooks/index.md b/nixpkgs/doc/hooks/index.md index 602febaf9d9b..8100e91c8b48 100644 --- a/nixpkgs/doc/hooks/index.md +++ b/nixpkgs/doc/hooks/index.md @@ -17,6 +17,7 @@ installShellFiles.section.md libiconv.section.md libxml2.section.md meson.section.md +mpi-check-hook.section.md ninja.section.md patch-rc-path-hooks.section.md perl.section.md diff --git a/nixpkgs/doc/hooks/mpi-check-hook.section.md b/nixpkgs/doc/hooks/mpi-check-hook.section.md new file mode 100644 index 000000000000..e3fb5c40dada --- /dev/null +++ b/nixpkgs/doc/hooks/mpi-check-hook.section.md @@ -0,0 +1,24 @@ +# mpiCheckPhaseHook {#setup-hook-mpi-check} + + +This hook can be used to setup a check phase that +requires running a MPI application. It detects the +used present MPI implementaion type and exports +the neceesary environment variables to use +`mpirun` and `mpiexec` in a Nix sandbox. + + +Example: + +```nix + { mpiCheckPhaseHook, mpi, ... }: + + ... + + nativeCheckInputs = [ + openssh + mpiCheckPhaseHook + ]; +``` + + diff --git a/nixpkgs/doc/hooks/waf.section.md b/nixpkgs/doc/hooks/waf.section.md index ee1bccff1d0a..8cacb30ea85f 100644 --- a/nixpkgs/doc/hooks/waf.section.md +++ b/nixpkgs/doc/hooks/waf.section.md @@ -1,3 +1,50 @@ # wafHook {#wafhook} -Overrides the configure, build, and install phases. This will run the “waf” script used by many projects. If `wafPath` (default `./waf`) doesn’t exist, it will copy the version of waf available in Nixpkgs. `wafFlags` can be used to pass flags to the waf script. +[Waf](https://waf.io) is a Python-based software building system. + +In Nixpkgs, `wafHook` overrides the default configure, build, and install phases. + +## Variables controlling wafHook {#variablesControllingWafHook} + +### `wafPath` {#wafPath} + +Location of the `waf` tool. It defaults to `./waf`, to honor software projects that include it directly inside their source trees. + +If `wafPath` doesn't exist, then `wafHook` will copy the `waf` provided from Nixpkgs to it. + +### `wafConfigureFlags` {#wafConfigureFlags} + +Controls the flags passed to waf tool during configure phase. + +### `wafFlags` {#wafFlags} + +Controls the flags passed to waf tool during build and install phases. + +### `dontAddWafCrossFlags` {#dontAddWafCrossFlags} + +When set to `true`, don't add cross compilation flags during configure phase. + +### `dontUseWafConfigure` {#dontUseWafConfigure} + +When set to true, don't use the predefined `wafConfigurePhase`. + +### `dontUseWafBuild` {#dontUseWafBuild} + +When set to true, don't use the predefined `wafBuildPhase`. + +### `dontUseWafInstall` {#dontUseWafInstall} + +When set to true, don't use the predefined `wafInstallPhase`. + +### Variables honored by wafHook {#variablesHonoredByWafHook} + +The following variables commonly used by `stdenv.mkDerivation` are also honored by `wafHook`. + +- `prefixKey` +- `configureTargets` +- `enableParallelBuilding` +- `enableParallelInstalling` +- `buildFlags` +- `buildTargets` +- `installFlags` +- `installTargets` |