summary refs log tree commit diff
path: root/doc/stdenv.xml
diff options
context:
space:
mode:
authorFranz Pletz <fpletz@fnordicwalking.de>2016-05-18 17:10:02 +0200
committerFranz Pletz <fpletz@fnordicwalking.de>2016-05-18 17:10:02 +0200
commitf8d481754cf842ca6e6ac1427ce0f571f5a44108 (patch)
tree70e702285987429aed275e0d5e2dc15c050e1f8c /doc/stdenv.xml
parent9fbc20e2f89bc045efac7ade41949a2c2d571dec (diff)
parent3cd63ade1614d4c581735ffb0cebe181bf87dfc8 (diff)
downloadnixlib-f8d481754cf842ca6e6ac1427ce0f571f5a44108.tar
nixlib-f8d481754cf842ca6e6ac1427ce0f571f5a44108.tar.gz
nixlib-f8d481754cf842ca6e6ac1427ce0f571f5a44108.tar.bz2
nixlib-f8d481754cf842ca6e6ac1427ce0f571f5a44108.tar.lz
nixlib-f8d481754cf842ca6e6ac1427ce0f571f5a44108.tar.xz
nixlib-f8d481754cf842ca6e6ac1427ce0f571f5a44108.tar.zst
nixlib-f8d481754cf842ca6e6ac1427ce0f571f5a44108.zip
Merge remote-tracking branch 'origin/master' into hardened-stdenv
Diffstat (limited to 'doc/stdenv.xml')
-rw-r--r--doc/stdenv.xml12
1 files changed, 11 insertions, 1 deletions
diff --git a/doc/stdenv.xml b/doc/stdenv.xml
index 895892938442..434b61fd6a4b 100644
--- a/doc/stdenv.xml
+++ b/doc/stdenv.xml
@@ -1169,7 +1169,17 @@ PATH=/nix/store/68afga4khv0w...-coreutils-6.12/bin
 echo @foo@
 </programlisting>
 
-    That is, no substitution is performed for undefined variables.</para></listitem>
+    That is, no substitution is performed for undefined variables.</para>
+
+    <para>Environment variables that start with an uppercase letter or an
+    underscore are filtered out,
+    to prevent global variables (like <literal>HOME</literal>) or private
+    variables (like <literal>__ETC_PROFILE_DONE</literal>) from accidentally
+    getting substituted.
+    The variables also have to be valid bash “names”, as
+    defined in the bash manpage (alphanumeric or <literal>_</literal>,
+    must not start with a number).</para>
+  </listitem>
   </varlistentry>