diff options
author | aszlig <aszlig@nix.build> | 2018-11-19 23:33:44 +0100 |
---|---|---|
committer | aszlig <aszlig@nix.build> | 2018-11-20 00:11:31 +0100 |
commit | 503b41b9b2d726f10372e3daac713cc2042b8cf0 (patch) | |
tree | 8f667064ef6dfe271ed32d0324bc1045c922d509 /doc/stdenv.xml | |
parent | 3ca35ce0b2dd1adb11044e03a816c77a72f7135d (diff) |
doc/stdenv: Document autoPatchelfHook changes
First of all, this makes the existing documentation a bit more clear on what autoPatchelfHook is all about, because after discussing with @svanderburg - who wrote a similar implementation - the rationale about autoPatchelfHook wasn't very clear in the documentation. I also added the recent changes around being able to use autoPatchelf manually and the new --no-recurse flag. Signed-off-by: aszlig <aszlig@nix.build>
Diffstat (limited to 'doc/stdenv.xml')
-rw-r--r-- | doc/stdenv.xml | 31 |
1 files changed, 25 insertions, 6 deletions
diff --git a/doc/stdenv.xml b/doc/stdenv.xml index 9ed9a448c614f..e1e8090dcb89e 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> |