gador/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

substituteAll: deprecate (#395275)

Browse Source
This commit is contained in:
Wolfgang Walther
2025-04-23 21:57:12 +00:00
committed by GitHub
parent 9e8b372b7e d3842f26e8
commit eb48ed1c8e
12 changed files with 114 additions and 101 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/languages-frameworks/gnome.section.md
+2 -2
View File
@@ -214,7 +214,7 @@ stdenv.mkDerivation {
You can rely on applications depending on the library setting the necessary environment variables but that is often easy to miss. Instead we recommend to patch the paths in the source code whenever possible. Here are some examples:
- []{#ssec-gnome-common-issues-unwrappable-package-gnome-shell-ext} [Replacing a `GI_TYPELIB_PATH` in GNOME Shell extension](https://github.com/NixOS/nixpkgs/blob/7bb8f05f12ca3cff9da72b56caa2f7472d5732bc/pkgs/desktops/gnome-3/core/gnome-shell-extensions/default.nix#L21-L24) – we are using `substituteAll` to include the path to a typelib into a patch.
- []{#ssec-gnome-common-issues-unwrappable-package-gnome-shell-ext} [Replacing a `GI_TYPELIB_PATH` in GNOME Shell extension](https://github.com/NixOS/nixpkgs/blob/e981466fbb08e6231a1377539ff17fbba3270fda/pkgs/by-name/gn/gnome-shell-extensions/package.nix#L25-L32) – we are using `replaceVars` to include the path to a typelib into a patch.
- []{#ssec-gnome-common-issues-unwrappable-package-gsettings} The following examples are hardcoding GSettings schema paths. To get the schema paths we use the functions
@@ -222,7 +222,7 @@ You can rely on applications depending on the library setting the necessary envi
* `glib.makeSchemaPath` Takes a package output like `$out` and a derivation name. You should use this if the schemas you need to hardcode are in the same derivation.
[]{#ssec-gnome-common-issues-unwrappable-package-gsettings-vala} [Hard-coding GSettings schema path in Vala plug-in (dynamically loaded library)](https://github.com/NixOS/nixpkgs/blob/7bb8f05f12ca3cff9da72b56caa2f7472d5732bc/pkgs/desktops/pantheon/apps/elementary-files/default.nix#L78-L86) – here, `substituteAll` cannot be used since the schema comes from the same package preventing us from pass its path to the function, probably due to a [Nix bug](https://github.com/NixOS/nix/issues/1846).
[]{#ssec-gnome-common-issues-unwrappable-package-gsettings-vala} [Hard-coding GSettings schema path in Vala plug-in (dynamically loaded library)](https://github.com/NixOS/nixpkgs/blob/7bb8f05f12ca3cff9da72b56caa2f7472d5732bc/pkgs/desktops/pantheon/apps/elementary-files/default.nix#L78-L86) – here, `replaceVars` cannot be used since the schema comes from the same package preventing us from pass its path to the function, probably due to a [Nix bug](https://github.com/NixOS/nix/issues/1846).
[]{#ssec-gnome-common-issues-unwrappable-package-gsettings-c} [Hard-coding GSettings schema path in C library](https://github.com/NixOS/nixpkgs/blob/29c120c065d03b000224872251bed93932d42412/pkgs/development/libraries/glib-networking/default.nix#L31-L34) – nothing special other than using [Coccinelle patch](https://github.com/NixOS/nixpkgs/pull/67957#issuecomment-527717467) to generate the patch itself.
doc/packages/build-support.md
+32 -29
View File
@@ -30,13 +30,12 @@ substitute {
```
:::
## `pkgs.substituteAll` {#pkgs-substituteall}
## `pkgs.replaceVars` {#pkgs-replacevars}
`pkgs.substituteAll` substitutes all instances of `@varName@` (`@`s included) in file `src` with the value of the corresponding environment variable.
As this uses the [`substituteAll`] (#fun-substitute) function, its limitations regarding variable names that will or will not be replaced also apply here.
`pkgs.replaceVars <src> <replacements>` replaces all instances of `@varName@` (`@`s included) in file `src` with the respective value in the attribute set `replacements`.
:::{.example #ex-pkgs-substituteAll}
# Usage of `pkgs.substituteAll`
:::{.example #ex-pkgs-replace-vars}
# Usage of `pkgs.replaceVars`
If `say-goodbye.sh` contains the following:
@@ -51,16 +50,14 @@ the following derivation will make substitutions to `@bash@`, `@hello@`, and `@g
```nix
{
substituteAll,
replaceVars,
bash,
hello,
}:
substituteAll {
src = ./say-goodbye.sh;
env = {
inherit bash hello;
greeting = "goodbye";
};
replaceVars ./say-goodbye.sh {
inherit bash hello;
greeting = "goodbye";
unchanged = null;
}
```
@@ -72,31 +69,37 @@ such that `$out` will result in something like the following:
echo @unchanged@
/nix/store/566f5isbvw014h7knmzmxa5l6hshx43k-hello-2.12.1/bin/hello --greeting goodbye
```
Note that, in contrast to the old `substituteAll`, `unchanged = null` must explicitly be set.
Any unreferenced `@...@` pattern in the source file will throw an error.
:::
## `pkgs.substituteAllFiles` {#pkgs-substituteallfiles}
## `pkgs.replaceVarsWith` {#pkgs-replacevarswith}
`pkgs.substituteAllFiles` replaces `@varName@` with the value of the environment variable `varName`.
It expects `src` to be a directory and requires a `files` argument that specifies which files will be subject to replacements; only these files will be placed in `$out`.
`pkgs.replaceVarsWith` works the same way as [pkgs.replaceVars](#pkgs-replacevars), but additionally allows more options.
As it also uses the `substituteAll` function, it is subject to the same limitations on environment variables as discussed in [pkgs.substituteAll](#pkgs-substituteall).
:::{.example #ex-pkgs-replace-vars-with}
# Usage of `pkgs.replaceVarsWith`
:::{.example #ex-pkgs-substitute-all-files}
# Usage of `pkgs.substituteAllFiles`
If the current directory contains `{foo,bar,baz}.txt` and the following `default.nix`
With the example file `say-goodbye.sh`, consider:
```nix
{ substituteAllFiles }:
substituteAllFiles {
src = ./.;
files = [
"foo.txt"
"bar.txt"
];
hello = "there";
{ replaceVarsWith }:
replaceVarsWith {
src = ./say-goodbye.sh;
replacements = {
inherit bash hello;
greeting = "goodbye";
unchanged = null;
};
name = "say-goodbye";
dir = "bin";
isExecutable = true;
meta.mainProgram = "say-goodbye";
}
```
in the resulting derivation, every instance of `@hello@` will be replaced with `there` in `$out/foo.txt` and `$out/bar.txt`; `baz.txt` will not be processed nor will it appear in `$out`.
This will make the resulting file executable, put it in `bin/say-goodbye` and set `meta` attributes respectively.
:::
doc/redirects.json
+16 -12
View File
@@ -8,6 +8,14 @@
"ex-build-helpers-extendMkDerivation": [
"index.html#ex-build-helpers-extendMkDerivation"
],
"ex-pkgs-replace-vars": [
"index.html#ex-pkgs-replace-vars",
"index.html#ex-pkgs-substituteAll",
"index.html#ex-pkgs-substitute-all-files"
],
"ex-pkgs-replace-vars-with": [
"index.html#ex-pkgs-replace-vars-with"
],
"ex-shfmt": [
"index.html#ex-shfmt"
],
@@ -35,6 +43,14 @@
"no-broken-symlinks.sh": [
"index.html#no-broken-symlinks.sh"
],
"pkgs-replacevars": [
"index.html#pkgs-replacevars",
"index.html#pkgs-substituteall",
"index.html#pkgs-substituteallfiles"
],
"pkgs-replacevarswith": [
"index.html#pkgs-replacevarswith"
],
"preface": [
"index.html#preface"
],
@@ -4193,18 +4209,6 @@
"ex-pkgs-substitute": [
"index.html#ex-pkgs-substitute"
],
"pkgs-substituteall": [
"index.html#pkgs-substituteall"
],
"ex-pkgs-substituteAll": [
"index.html#ex-pkgs-substituteAll"
],
"pkgs-substituteallfiles": [
"index.html#pkgs-substituteallfiles"
],
"ex-pkgs-substitute-all-files": [
"index.html#ex-pkgs-substitute-all-files"
],
"part-development": [
"index.html#part-development"
],
doc/release-notes/rl-2505.section.md
+2
View File
@@ -112,6 +112,8 @@
- All support for 32‐bit Darwin systems has been dropped.
- `substituteAll` and `substituteAllFiles` have been deprecated in favor of `replaceVars` and will be removed in the next release.
- Default ICU version updated from 74 to 76
- Apache Kafka was updated to `>= 4.0.0`. Please note that this is the first release which operates
pkgs/build-support/substitute-files/substitute-all-files.nix
+25 -20
View File
@@ -2,27 +2,32 @@
args:
stdenv.mkDerivation (
{
name = if args ? name then args.name else baseNameOf (toString args.src);
builder = builtins.toFile "builder.sh" ''
set -o pipefail
# TODO(@wolfgangwalther): Remove substituteAllFiles after 25.05 branch-off.
lib.warn
"substituteAllFiles is deprecated and will be removed in 25.11. Use replaceVars for each file instead."
(
stdenv.mkDerivation (
{
name = if args ? name then args.name else baseNameOf (toString args.src);
builder = builtins.toFile "builder.sh" ''
set -o pipefail
eval "$preInstall"
eval "$preInstall"
args=
args=
pushd "$src"
echo -ne "${lib.concatStringsSep "\\0" args.files}" | xargs -0 -n1 -I {} -- find {} -type f -print0 | while read -d "" line; do
mkdir -p "$out/$(dirname "$line")"
substituteAll "$line" "$out/$line"
done
popd
pushd "$src"
echo -ne "${lib.concatStringsSep "\\0" args.files}" | xargs -0 -n1 -I {} -- find {} -type f -print0 | while read -d "" line; do
mkdir -p "$out/$(dirname "$line")"
substituteAll "$line" "$out/$line"
done
popd
eval "$postInstall"
'';
preferLocalBuild = true;
allowSubstitutes = false;
}
// args
)
eval "$postInstall"
'';
preferLocalBuild = true;
allowSubstitutes = false;
}
// args
)
)
pkgs/build-support/substitute/substitute-all.nix
+21 -18
View File
@@ -6,21 +6,24 @@ let
isInvalidArgName = x: builtins.match "^[a-z][a-zA-Z0-9_]*$" x == null;
invalidArgs = builtins.filter isInvalidArgName (builtins.attrNames args);
in
if invalidArgs == [ ] then
stdenvNoCC.mkDerivation (
{
name = if args ? name then args.name else baseNameOf (toString args.src);
builder = ./substitute-all.sh;
inherit (args) src;
preferLocalBuild = true;
allowSubstitutes = false;
}
// args
)
else
throw ''
Argument names for `pkgs.substituteAll` must:
- start with a lower case ASCII letter
- only contain ASCII letters, digits and underscores
Found invalid argument names: ${lib.concatStringsSep ", " invalidArgs}.
''
# TODO(@wolfgangwalther): Remove substituteAll, the nix function, after 25.05 branch-off.
lib.warn "substituteAll is deprecated and will be removed in 25.11. Use replaceVars instead." (
if invalidArgs == [ ] then
stdenvNoCC.mkDerivation (
{
name = if args ? name then args.name else baseNameOf (toString args.src);
builder = ./substitute-all.sh;
inherit (args) src;
preferLocalBuild = true;
allowSubstitutes = false;
}
// args
)
else
throw ''
Argument names for `pkgs.substituteAll` must:
- start with a lower case ASCII letter
- only contain ASCII letters, digits and underscores
Found invalid argument names: ${lib.concatStringsSep ", " invalidArgs}.
''
)
pkgs/by-name/bo/box2d/package.nix
+2 -3
View File
@@ -3,7 +3,7 @@
stdenv,
fetchFromGitHub,
substituteAll,
replaceVars,
# nativeBuildInputs
cmake,
@@ -41,8 +41,7 @@ stdenv.mkDerivation (finalAttrs: {
patches = [
# prevent CMake from trying to download some libraries from the internet
(substituteAll {
src = ./cmake_dont_fetch_enkits.patch;
(replaceVars ./cmake_dont_fetch_enkits.patch {
enkits_src = fetchFromGitHub {
owner = "dougbinks";
repo = "enkiTS";
pkgs/by-name/fi/fim/package.nix
+5 -3
View File
@@ -4,7 +4,7 @@
autoconf,
automake,
pkg-config,
substituteAll,
replaceVars,
lib,
perl,
flex,
@@ -41,9 +41,11 @@ stdenv.mkDerivation rec {
patches = [
# build tools with a build compiler
(substituteAll {
src = ./native-tools.patch;
(replaceVars ./native-tools.patch {
cc_for_build = lib.getExe buildPackages.stdenv.cc;
# patch context
FIM_WANT_CUSTOM_HARDCODED_CONSOLEFONT_TRUE = null;
HAVE_RUNNABLE_TESTS_TRUE = null;
})
];
pkgs/by-name/re/recon-ng/package.nix
+2 -3
View File
@@ -2,7 +2,7 @@
lib,
fetchFromGitHub,
python3,
substituteAll,
replaceVars,
fetchpatch,
}:
python3.pkgs.buildPythonApplication rec {
@@ -49,8 +49,7 @@ python3.pkgs.buildPythonApplication rec {
postPatch =
let
setup = substituteAll {
src = ./setup.py;
setup = replaceVars ./setup.py {
inherit pname version;
};
in
pkgs/by-name/su/supercell-wx/package.nix
+2 -3
View File
@@ -26,7 +26,7 @@
qt6,
tbb_2021_11,
tracy,
substituteAll,
replaceVars,
python3,
}:
let
@@ -94,9 +94,8 @@ stdenv.mkDerivation (finalAttrs: {
patches = [
# These are for Nix compatibility {{{
./patches/use-find-package.patch # Replace some vendored dependencies with Nix provided versions
(substituteAll {
(replaceVars ./patches/skip-git-versioning.patch {
# Skip tagging build with git version, and substitute it with the src revision (still uses current year timestamp)
src = ./patches/skip-git-versioning.patch;
rev = finalAttrs.src.rev;
})
# Prevents using some Qt scripts that seemed to break the install step. Fixes missing link to some targets.
pkgs/development/libraries/xdg-desktop-portal/default.nix
+3 -5
View File
@@ -27,7 +27,7 @@
gst_all_1,
libgudev,
umockdev,
substituteAll,
replaceVars,
enableGeoLocation ? true,
enableSystemd ? true,
}:
@@ -51,14 +51,12 @@ stdenv.mkDerivation (finalAttrs: {
patches = [
# The icon validator copied from Flatpak needs to access the gdk-pixbuf loaders
# in the Nix store and cannot bind FHS paths since those are not available on NixOS.
(substituteAll {
src = ./fix-icon-validation.patch;
(replaceVars ./fix-icon-validation.patch {
inherit (builtins) storeDir;
})
# Same for the sound validator, except the gdk-pixbuf part.
(substituteAll {
src = ./fix-sound-validation.patch;
(replaceVars ./fix-sound-validation.patch {
inherit (builtins) storeDir;
})
pkgs/development/rocm-modules/6/llvm/default.nix
+2 -3
View File
@@ -15,7 +15,7 @@
zlib,
gcc-unwrapped,
glibc,
substituteAll,
replaceVars,
libffi,
libxml2,
removeReferencesTo,
@@ -319,8 +319,7 @@ rec {
})
# FIXME: Needed due to https://github.com/NixOS/nixpkgs/issues/375431
# Once we can switch to overrideScope this can be removed
(substituteAll {
src = ./../../../compilers/llvm/common/clang/clang-at-least-16-LLVMgold-path.patch;
(replaceVars ./../../../compilers/llvm/common/clang/clang-at-least-16-LLVMgold-path.patch {
libllvmLibdir = "${llvm.lib}/lib";
})
];