diff options
author | Profpatsch <mail@profpatsch.de> | 2016-10-07 15:55:16 +0200 |
---|---|---|
committer | Profpatsch <mail@profpatsch.de> | 2016-10-08 23:36:40 +0200 |
commit | dd58d24fa612df73264bb69f82517e1c2bc6999a (patch) | |
tree | b7340b0798ecd4b22e7097661ebe9095b26bef32 /pkgs/build-support/setup-hooks/make-wrapper.sh | |
parent | 40fc02bb30343a79c827fce478436d9d72ab0f86 (diff) | |
download | nixpkgs-dd58d24fa612df73264bb69f82517e1c2bc6999a.tar nixpkgs-dd58d24fa612df73264bb69f82517e1c2bc6999a.tar.gz nixpkgs-dd58d24fa612df73264bb69f82517e1c2bc6999a.tar.bz2 nixpkgs-dd58d24fa612df73264bb69f82517e1c2bc6999a.tar.lz nixpkgs-dd58d24fa612df73264bb69f82517e1c2bc6999a.tar.xz nixpkgs-dd58d24fa612df73264bb69f82517e1c2bc6999a.tar.zst nixpkgs-dd58d24fa612df73264bb69f82517e1c2bc6999a.zip |
stdenv: document makeWrapper
Add function documentation to `makeWrapper`. Also add user documentation to the nixpkgs manual.
Diffstat (limited to 'pkgs/build-support/setup-hooks/make-wrapper.sh')
-rw-r--r-- | pkgs/build-support/setup-hooks/make-wrapper.sh | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/pkgs/build-support/setup-hooks/make-wrapper.sh b/pkgs/build-support/setup-hooks/make-wrapper.sh index d922db5ccf5..086875976d3 100644 --- a/pkgs/build-support/setup-hooks/make-wrapper.sh +++ b/pkgs/build-support/setup-hooks/make-wrapper.sh @@ -1,3 +1,23 @@ +# construct an executable file that wraps the actual executable +# makeWrapper EXECUTABLE ARGS + +# ARGS: +# --argv0 NAME : set name of executed process to NAME +# (otherwise it’s called …-wrapped) +# --set VAR VAL : add VAR with value VAL to the executable’s environment +# --unset VAR : remove VAR from the environment +# --run COMMAND : run command before the executable +# The command can push extra flags to a magic list variable +# extraFlagsArray, which are then added to the invocation +# of the executable +# --add-flags FLAGS : add FLAGS to invocation of executable + +# --prefix ENV SEP VAL : suffix/prefix ENV with VAL, separated by SEP +# --suffix +# --suffix-each ENV SEP VALS : like --suffix, but VALS is a list +# --prefix-contents ENV SEP FILES : like --suffix-each, but contents of FILES +# are read first and used as VALS +# --suffix-contents makeWrapper() { local original=$1 local wrapper=$2 |