From 6517e5b10f901fb4e41fbf8a5a8b2456ae03c3bc Mon Sep 17 00:00:00 2001 From: Doron Behar Date: Tue, 19 Oct 2021 17:33:02 +0300 Subject: [PATCH] Improve explenations for wrap*Program --- doc/stdenv/stdenv.chapter.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/stdenv/stdenv.chapter.md b/doc/stdenv/stdenv.chapter.md index 55e9ae48fb16..031880fbc687 100644 --- a/doc/stdenv/stdenv.chapter.md +++ b/doc/stdenv/stdenv.chapter.md @@ -871,15 +871,15 @@ someVar=$(stripHash $name) ### `wrapProgram` \ \ {#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` \ \ {#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}