diff options
author | aszlig <aszlig@nix.build> | 2018-02-01 22:54:18 +0100 |
---|---|---|
committer | aszlig <aszlig@nix.build> | 2018-02-10 00:27:24 +0530 |
commit | 1cba74dfc1541673f91b91c3ab50dbdce43c764a (patch) | |
tree | 594504843a1e313a424b6a32c643aa6f6a8d333c /doc/stdenv.xml | |
parent | 2c134357345d4166d62db2e4cc029d004f28edae (diff) |
setup-hooks: Add autoPatchelfHook
I originally wrote this for packaging proprietary games in Vuizvui[1] but I thought it would be generally useful as we have a fair amount of proprietary software lurking around in nixpkgs, which are a bit tedious to maintain, especially when the library dependencies change after an update. So this setup hook searches for all ELF executables and libraries in the resulting output paths after install phase and uses patchelf to set the RPATH and interpreter according to what dependencies are available inside the builder. For example consider something like this: stdenv.mkDerivation { ... nativeBuildInputs = [ autoPatchelfHook ]; buildInputs = [ mesa zlib ]; ... } Whenever for example an executable requires mesa or zlib, the RPATH will automatically be set to the lib dir of the corresponding dependency. If the library dependency is required at runtime, an attribute called runtimeDependencies can be used to list dependencies that are added to all executables that are discovered unconditionally. Beside this, it also makes initial packaging of proprietary software easier, because one no longer has to manually figure out the dependencies in the first place. [1]: https://github.com/openlab-aux/vuizvui Signed-off-by: aszlig <aszlig@nix.build> Closes: #34506
Diffstat (limited to 'doc/stdenv.xml')
-rw-r--r-- | doc/stdenv.xml | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/stdenv.xml b/doc/stdenv.xml index 3a7b23baaa7e1..2a3316b8d0183 100644 --- a/doc/stdenv.xml +++ b/doc/stdenv.xml @@ -1802,6 +1802,20 @@ addEnvHooks "$hostOffset" myBashFunction disabled or patched to work with PaX.</para></listitem> </varlistentry> + <varlistentry> + <term>autoPatchelfHook</term> + <listitem><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.</para></listitem> + </varlistentry> + </variablelist> </para> |