mirror of
https://github.com/NixOS/nixpkgs.git
synced 2024-10-20 11:11:43 -04:00
56 lines
1.5 KiB
Markdown
56 lines
1.5 KiB
Markdown
# pkgs.makeSetupHook {#sec-pkgs.makeSetupHook}
|
|
|
|
`pkgs.makeSetupHook` is a build helper that produces hooks that go in to `nativeBuildInputs`
|
|
|
|
## Usage {#sec-pkgs.makeSetupHook-usage}
|
|
|
|
```nix
|
|
pkgs.makeSetupHook {
|
|
name = "something-hook";
|
|
propagatedBuildInputs = [ pkgs.commandsomething ];
|
|
depsTargetTargetPropagated = [ pkgs.libsomething ];
|
|
} ./script.sh;
|
|
```
|
|
|
|
### setup hook that depends on the hello package and runs hello and @shell@ is substituted with path to bash {#sec-pkgs.makeSetupHook-usage-example}
|
|
|
|
```nix
|
|
pkgs.makeSetupHook
|
|
{
|
|
name = "run-hello-hook";
|
|
# Put dependencies here if they have hooks or necessary dependencies propagated
|
|
# otherwise prefer direct paths to executables.
|
|
propagatedBuildInputs = [
|
|
pkgs.hello
|
|
pkgs.cowsay
|
|
];
|
|
substitutions = {
|
|
shell = "${pkgs.bash}/bin/bash";
|
|
cowsay = "${pkgs.cowsay}/bin/cowsay";
|
|
};
|
|
}
|
|
(
|
|
writeScript "run-hello-hook.sh" ''
|
|
#!@shell@
|
|
# the direct path to the executable has to be here because
|
|
# this will be run when the file is sourced
|
|
# at which point '$PATH' has not yet been populated with inputs
|
|
@cowsay@ cow
|
|
|
|
_printHelloHook() {
|
|
hello
|
|
}
|
|
preConfigureHooks+=(_printHelloHook)
|
|
''
|
|
);
|
|
```
|
|
|
|
## Attributes {#sec-pkgs.makeSetupHook-attributes}
|
|
|
|
* `name` Set the name of the hook.
|
|
* `propagatedBuildInputs` Runtime dependencies (such as binaries) of the hook.
|
|
* `depsTargetTargetPropagated` Non-binary dependencies.
|
|
* `meta`
|
|
* `passthru`
|
|
* `substitutions` Variables for `substituteAll`
|