From 949182a4a243f9884a02c0dc5c2667f312f8bbc2 Mon Sep 17 00:00:00 2001
From: Bernardo Meurer <bernardo@meurer.org>
Date: Sun, 7 Nov 2021 20:22:03 -0800
Subject: [PATCH] writeShellApplication: document runtimeShell == stdenv.shell
 assumption

---
 pkgs/build-support/trivial-builders.nix | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/pkgs/build-support/trivial-builders.nix b/pkgs/build-support/trivial-builders.nix
index 5f2d845e1b81..3d5eb64bc821 100644
--- a/pkgs/build-support/trivial-builders.nix
+++ b/pkgs/build-support/trivial-builders.nix
@@ -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 {