summary refs log tree commit diff
path: root/pkgs/build-support/trivial-builders.nix
diff options
context:
space:
mode:
authorJaakko Luttinen <jaakko.luttinen@iki.fi>2019-06-07 19:28:01 +0300
committerFrederik Rietdijk <freddyrietdijk@fridh.nl>2019-06-09 12:45:31 +0200
commitfa95878fd369ef3e194c6fcab08772446067c53e (patch)
tree10170abd421f08060848372e9ced6362e1fb427e /pkgs/build-support/trivial-builders.nix
parentc9b2d776710123323810705af978842ffd21fd0e (diff)
downloadnixpkgs-fa95878fd369ef3e194c6fcab08772446067c53e.tar
nixpkgs-fa95878fd369ef3e194c6fcab08772446067c53e.tar.gz
nixpkgs-fa95878fd369ef3e194c6fcab08772446067c53e.tar.bz2
nixpkgs-fa95878fd369ef3e194c6fcab08772446067c53e.tar.lz
nixpkgs-fa95878fd369ef3e194c6fcab08772446067c53e.tar.xz
nixpkgs-fa95878fd369ef3e194c6fcab08772446067c53e.tar.zst
nixpkgs-fa95878fd369ef3e194c6fcab08772446067c53e.zip
writeScript: fix docstring
Fixes #59299

See:
https://github.com/NixOS/nixpkgs/commit/b23dbb1a5dffbfa3abb47fcd0f1579ac2e6f29fc
Diffstat (limited to 'pkgs/build-support/trivial-builders.nix')
-rw-r--r--pkgs/build-support/trivial-builders.nix9
1 files changed, 7 insertions, 2 deletions
diff --git a/pkgs/build-support/trivial-builders.nix b/pkgs/build-support/trivial-builders.nix
index f56ce7bb87d..b66c1d9e4d1 100644
--- a/pkgs/build-support/trivial-builders.nix
+++ b/pkgs/build-support/trivial-builders.nix
@@ -107,10 +107,15 @@ rec {
   writeTextDir = name: text: writeTextFile {inherit name text; destination = "/${name}";};
 
   /*
-   * Writes a text file to /nix/store/<store path> and marks the file as executable.
+   * Writes a text file to /nix/store/<store path> and marks the file as
+   * executable.
+   *
+   * If passed as a build input, will be used as a setup hook. This makes setup
+   * hooks more efficient to create: you don't need a derivation that copies
+   * them to $out/nix-support/setup-hook, instead you can use the file as is.
    *
    * Example:
-   * # Writes my-file to /nix/store/<store path>/bin/my-file and makes executable
+   * # Writes my-file to /nix/store/<store path> and makes executable
    * writeScript "my-file"
    *   ''
    *   Contents of File