e42a5c78e7
skipping heading levels (eg from # to ###, or starting at ###) is legal in pandoc, but not in nixos-render-docs. pandoc acts as though section levels *were* consecutive, nixos-render-docs prefers to tell people not to do that kind of thing because it can make documents more fragile.
37 lines
1.1 KiB
Markdown
37 lines
1.1 KiB
Markdown
# pkgs.makeSetupHook {#sec-pkgs.makeSetupHook}
|
|
|
|
`pkgs.makeSetupHook` is a builder 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";
|
|
propagatedBuildInputs = [ pkgs.hello ];
|
|
substitutions = { shell = "${pkgs.bash}/bin/bash"; };
|
|
passthru.tests.greeting = callPackage ./test { };
|
|
meta.platforms = lib.platforms.linux;
|
|
} (writeScript "run-hello-hook.sh" ''
|
|
#!@shell@
|
|
hello
|
|
'')
|
|
```
|
|
|
|
## 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`
|