summary refs log tree commit diff
path: root/pkgs/build-support/trivial-builders.nix
diff options
context:
space:
mode:
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