diff --git a/doc/stdenv.xml b/doc/stdenv.xml index 9ed9a448c614..e1e8090dcb89 100644 --- a/doc/stdenv.xml +++ b/doc/stdenv.xml @@ -2421,12 +2421,31 @@ addEnvHooks "$hostOffset" myBashFunction <para> This is a special setup hook which helps in packaging proprietary software in that it automatically tries to find missing shared library - dependencies of ELF files. All packages within the - <envar>runtimeDependencies</envar> environment variable are - unconditionally added to executables, which is useful for programs that - use <citerefentry> - <refentrytitle>dlopen</refentrytitle> - <manvolnum>3</manvolnum> </citerefentry> to load libraries at runtime. + dependencies of ELF files based on the given + <varname>buildInputs</varname> and <varname>nativeBuildInputs</varname>. + </para> + <para> + You can also specify a <envar>runtimeDependencies</envar> environment + variable which lists dependencies that are unconditionally added to all + executables. + </para> + <para> + This is useful for programs that use <citerefentry> + <refentrytitle>dlopen</refentrytitle> + <manvolnum>3</manvolnum> + </citerefentry> to load libraries at runtime. + </para> + <para> + In certain situations you may want to run the main command + (<command>autoPatchelf</command>) of the setup hook on a file or a set + of directories instead of unconditionally patching all outputs. This + can be done by setting the <envar>dontAutoPatchelf</envar> environment + variable to a non-empty value. + </para> + <para> + The <command>autoPatchelf</command> command also recognizes a + <parameter class="command">--no-recurse</parameter> command line flag, + which prevents it from recursing into subdirectories. </para> </listitem> </varlistentry>