diff options
author | Jan Tojnar <jtojnar@gmail.com> | 2020-02-14 06:57:25 +0100 |
---|---|---|
committer | Jan Tojnar <jtojnar@gmail.com> | 2020-06-01 07:21:48 +0200 |
commit | 55e7f95265c98bb3008f4d253ea7b6fa90fa6f92 (patch) | |
tree | f12716fe0cd4e14a6a25baca4862371cf4ca4093 /doc | |
parent | 67325b12c641378d622051b73ada8ae808ba318d (diff) |
doc/stdenv: improve autoPatchelfHook description
* Add id
* Mention rpath
* The control variables do not really have to be env vars (though without structuredAttrs there is not a difference)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/stdenv/stdenv.xml | 8 |
1 files changed, 3 insertions, 5 deletions
diff --git a/doc/stdenv/stdenv.xml b/doc/stdenv/stdenv.xml index 65a343d7edd8..a4174f4f7edc 100644 --- a/doc/stdenv/stdenv.xml +++ b/doc/stdenv/stdenv.xml @@ -2001,7 +2001,7 @@ addEnvHooks "$hostOffset" myBashFunction </para> </listitem> </varlistentry> - <varlistentry> + <varlistentry xml:id="setup-hook-autopatchelfhook"> <term> autoPatchelfHook </term> @@ -2010,15 +2010,13 @@ addEnvHooks "$hostOffset" myBashFunction 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 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> + You can also specify a <varname>runtimeDependencies</varname> variable which lists dependencies to be unconditionally added to <glossterm>rpath</glossterm> of all executables. 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. + 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 <varname>dontAutoPatchelf</varname> 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. |