diff options
author | Doron Behar <doron.behar@gmail.com> | 2021-10-19 17:33:02 +0300 |
---|---|---|
committer | Doron Behar <doron.behar@gmail.com> | 2021-10-19 17:33:02 +0300 |
commit | 6517e5b10f901fb4e41fbf8a5a8b2456ae03c3bc (patch) | |
tree | b884734538c73e55307ca1217475d8169eaf0370 /doc/stdenv | |
parent | 1218b82bce915e2cde8820b13768ed00d7e84b53 (diff) |
Improve explenations for wrap*Program
Diffstat (limited to 'doc/stdenv')
-rw-r--r-- | doc/stdenv/stdenv.chapter.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/stdenv/stdenv.chapter.md b/doc/stdenv/stdenv.chapter.md index 55e9ae48fb16b..031880fbc687c 100644 --- a/doc/stdenv/stdenv.chapter.md +++ b/doc/stdenv/stdenv.chapter.md @@ -871,15 +871,15 @@ someVar=$(stripHash $name) ### `wrapProgram` \<executable\> \<makeWrapperArgs\> {#fun-wrapProgram} -Convenience function for `makeWrapper` that automatically creates a sane wrapper file. It takes all the same arguments as `makeWrapper`, except for `--argv0`. +Convenience function for `makeWrapper` that replaces `<\executable\>` with a wrapper that executes the original program. It takes all the same arguments as `makeWrapper`, except for `--argv0`. -It cannot be applied multiple times, since it will overwrite the wrapper file and you will end up with double wrapping. +If you will apply it multiple times, it will overwrite the wrapper file and you will end up with double wrapping, which should be avoided. ### `wrapProgramBinary` \<executable\> \<makeBinaryWrapperArgs\> {#fun-wrapProgramBinary} -Convenience function for `makeWrapperBinary` that automatically creates a sane wrapper file. It takes all the same arguments as `makeBinaryWrapper`, except for `--argv0`. +Convenience function for `makeBinaryWrapper` that replaces `<\executable\>` with a wrapper that executes the original program. It takes all the same arguments as `makeBinaryWrapper`, except for `--argv0`. -It cannot be applied multiple times, since it will overwrite the wrapper file and you will end up with double wrapping. +If you will apply it multiple times, it will overwrite the wrapper file and you will end up with double wrapping, which should be avoided. ## Package setup hooks {#ssec-setup-hooks} |