about summary refs log tree commit diff
path: root/doc
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
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')
-rw-r--r--doc/languages-frameworks/python.md1
-rw-r--r--doc/package-notes.xml16
-rw-r--r--doc/stdenv.xml12
3 files changed, 28 insertions, 1 deletions
diff --git a/doc/languages-frameworks/python.md b/doc/languages-frameworks/python.md
index 098df2dfa5dd..c6d38c6989a7 100644
--- a/doc/languages-frameworks/python.md
+++ b/doc/languages-frameworks/python.md
@@ -534,6 +534,7 @@ All parameters from `mkDerivation` function are still supported.
 * `postShellHook`: Hook to execute commands after `shellHook`.
 * `makeWrapperArgs`: A list of strings. Arguments to be passed to `makeWrapper`, which wraps generated binaries. By default, the arguments to `makeWrapper` set `PATH` and `PYTHONPATH` environment variables before calling the binary. Additional arguments here can allow a developer to set environment variables which will be available when the binary is run. For example, `makeWrapperArgs = ["--set FOO BAR" "--set BAZ QUX"]`.
 * `installFlags`: A list of strings. Arguments to be passed to `pip install`. To pass options to `python setup.py install`, use `--install-option`. E.g., `installFlags=["--install-option='--cpp_implementation'"].
+* `format`: Format of the source. Options are `setup` for when the source has a `setup.py` and `setuptools` is used to build a wheel, and `wheel` in case the source is already a binary wheel. The default value is `setup`.
 
 #### `buildPythonApplication` function
 
diff --git a/doc/package-notes.xml b/doc/package-notes.xml
index 4148e87e0189..f0015a7f9ace 100644
--- a/doc/package-notes.xml
+++ b/doc/package-notes.xml
@@ -366,4 +366,20 @@ it. Place the resulting <filename>package.nix</filename> file into
 
 </section>
 
+<section xml:id="sec-autojump">
+
+<title>Autojump</title>
+
+<para>
+  autojump needs the shell integration to be useful but unlike other systems,
+  nix doesn't have a standard share directory location. This is why a
+  <command>autojump-share</command> script is shipped that prints the location
+  of the shared folder. This can then be used in the .bashrc like this:
+<screen>
+  source "$(autojump-share)/autojump.bash"
+</screen>
+</para>
+
+</section>
+
 </chapter>
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>