writeShellApplication: document runtimeShell == stdenv.shell assumption

This commit is contained in:
Bernardo Meurer 2021-11-07 20:22:03 -08:00
parent 014b23232f
commit 949182a4a2
No known key found for this signature in database
GPG key ID: F4C0D53B8D14C246

View file

@ -256,6 +256,10 @@ rec {
* Automatically includes sane set of shellopts (errexit, nounset, pipefail)
* and handles creation of PATH based on runtimeInputs
*
* Note that the checkPhase uses stdenv.shell for the test run of the script,
* while the generated shebang uses runtimeShell. If, for whatever reason,
* those were to mismatch you might lose fidelity in the default checks.
*
* Example:
* # Writes my-file to /nix/store/<store path>/bin/my-file and makes executable.
* writeShellApplication {