summary refs log tree commit diff
path: root/doc/stdenv
diff options
context:
space:
mode:
authorJan Tojnar <jtojnar@gmail.com>2020-10-02 06:16:09 +0200
committerGitHub <noreply@github.com>2020-10-02 06:16:09 +0200
commit74c547209048372ca10fa92660108b03363c3489 (patch)
treee05d73a6e46902684221a97dbaf7bc43500820dd /doc/stdenv
parent1b17aea63e33d4facfc4e303704fcb8a1f7777bb (diff)
parent74a5bb4041bb4ef001875d5b6b26a2105dc24450 (diff)
downloadnixpkgs-74c547209048372ca10fa92660108b03363c3489.tar
nixpkgs-74c547209048372ca10fa92660108b03363c3489.tar.gz
nixpkgs-74c547209048372ca10fa92660108b03363c3489.tar.bz2
nixpkgs-74c547209048372ca10fa92660108b03363c3489.tar.lz
nixpkgs-74c547209048372ca10fa92660108b03363c3489.tar.xz
nixpkgs-74c547209048372ca10fa92660108b03363c3489.tar.zst
nixpkgs-74c547209048372ca10fa92660108b03363c3489.zip
Merge pull request #98304 from jtojnar/updateScript-commit3
maintainers/scripts/update.nix: Add support for auto-commiting changes
Diffstat (limited to 'doc/stdenv')
-rw-r--r--doc/stdenv/stdenv.xml9
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/stdenv/stdenv.xml b/doc/stdenv/stdenv.xml
index 42fae73e881..706a010715d 100644
--- a/doc/stdenv/stdenv.xml
+++ b/doc/stdenv/stdenv.xml
@@ -475,9 +475,12 @@ passthru.updateScript = writeScript "update-zoom-us" ''
 <programlisting>
 passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ];
 </programlisting>
-     </para>
-     <para>
-      The script will be usually run from the root of the Nixpkgs repository but you should not rely on that. Also note that the update scripts will be run in parallel by default; you should avoid running <command>git commit</command> or any other commands that cannot handle that.
+      The script will be run with <variable>UPDATE_NIX_ATTR_PATH</variable> environment variable set to the attribute path it is supposed to update.
+      <note>
+       <para>
+        The script will be usually run from the root of the Nixpkgs repository but you should not rely on that. Also note that the update scripts will be run in parallel by default; you should avoid running <command>git commit</command> or any other commands that cannot handle that.
+       </para>
+      </note>
      </para>
      <para>
       For information about how to run the updates, execute <command>nix-shell maintainers/scripts/update.nix</command>.