diff options
author | Peder Bergebakken Sundt <pbsds@hotmail.com> | 2023-10-12 23:43:03 +0200 |
---|---|---|
committer | misuzu <bakalolka@gmail.com> | 2024-02-29 08:42:38 +0200 |
commit | 8e0416b05d86783f7c052d511c9d3a5c5691084d (patch) | |
tree | 2929f95a62a4ae69924f6b8793681d743cf7ebf3 /doc/stdenv | |
parent | b7ee09cf5614b02d289cd86fcfa6f24d4e078c2a (diff) |
stdenv: substituteStream: deprecate --replace in favor of --replace-{fail,warn,quiet}
Diffstat (limited to 'doc/stdenv')
-rw-r--r-- | doc/stdenv/platform-notes.chapter.md | 2 | ||||
-rw-r--r-- | doc/stdenv/stdenv.chapter.md | 23 |
2 files changed, 18 insertions, 7 deletions
diff --git a/doc/stdenv/platform-notes.chapter.md b/doc/stdenv/platform-notes.chapter.md index b47f5af349b8d..409c9f2e7b2ea 100644 --- a/doc/stdenv/platform-notes.chapter.md +++ b/doc/stdenv/platform-notes.chapter.md @@ -54,7 +54,7 @@ Some common issues when packaging software for Darwin: # ... prePatch = '' substituteInPlace Makefile \ - --replace '/usr/bin/xcrun clang' clang + --replace-fail '/usr/bin/xcrun clang' clang ''; } ``` diff --git a/doc/stdenv/stdenv.chapter.md b/doc/stdenv/stdenv.chapter.md index 03bb8a9ff790e..7f62af5997b51 100644 --- a/doc/stdenv/stdenv.chapter.md +++ b/doc/stdenv/stdenv.chapter.md @@ -230,9 +230,9 @@ stdenv.mkDerivation rec { postInstall = '' substituteInPlace $out/bin/solo5-virtio-mkimage \ - --replace "/usr/lib/syslinux" "${syslinux}/share/syslinux" \ - --replace "/usr/share/syslinux" "${syslinux}/share/syslinux" \ - --replace "cp " "cp --no-preserve=mode " + --replace-fail "/usr/lib/syslinux" "${syslinux}/share/syslinux" \ + --replace-fail "/usr/share/syslinux" "${syslinux}/share/syslinux" \ + --replace-fail "cp " "cp --no-preserve=mode " wrapProgram $out/bin/solo5-virtio-mkimage \ --prefix PATH : ${lib.makeBinPath [ dosfstools mtools parted syslinux ]} @@ -1217,9 +1217,20 @@ postInstall = '' Performs string substitution on the contents of \<infile\>, writing the result to \<outfile\>. The substitutions in \<subs\> are of the following form: -#### `--replace` \<s1\> \<s2\> {#fun-substitute-replace} +#### `--replace-fail` \<s1\> \<s2\> {#fun-substitute-replace-fail} Replace every occurrence of the string \<s1\> by \<s2\>. +Will error if no change is made. + +#### `--replace-warn` \<s1\> \<s2\> {#fun-substitute-replace-warn} + +Replace every occurrence of the string \<s1\> by \<s2\>. +Will print a warning if no change is made. + +#### `--replace-quiet` \<s1\> \<s2\> {#fun-substitute-replace-quiet} + +Replace every occurrence of the string \<s1\> by \<s2\>. +Will do nothing if no change can be made. #### `--subst-var` \<varName\> {#fun-substitute-subst-var} @@ -1233,8 +1244,8 @@ Example: ```shell substitute ./foo.in ./foo.out \ - --replace /usr/bin/bar $bar/bin/bar \ - --replace "a string containing spaces" "some other text" \ + --replace-fail /usr/bin/bar $bar/bin/bar \ + --replace-fail "a string containing spaces" "some other text" \ --subst-var someVar ``` |