substituteAll: deprecate by wolfgangwalther · Pull Request #395275 · NixOS/nixpkgs

wolfgangwalther · 2025-04-01T20:24:26Z

One step towards #237216.

Q1: Should we adjust the docs immediately? If yes, just add a deprecation or remove them already and point to ... (ah, we don't have replaceVars in the docs, yet?).

Q2: What to do about substituteAllFiles? It's unused in nixpkgs, so we could deprecate it immediately as well? Although we don't have a replacement for it.

Things done

Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
25.05 Release Notes (or backporting 24.11 and 25.05 Release notes)
- (Package updates) Added a release notes entry if the change is major or breaking
Fits CONTRIBUTING.md.

Add a 👍 reaction to pull requests you find important.

philiptaron

I'm accepting with feedback about the deprecation schedule.

pkgs/build-support/substitute/substitute-all.nix

philiptaron · 2025-04-01T22:13:16Z

`substituteAllFiles`

https://github.com/search?q=lang%3Anix+substituteAllFiles&type=code

It's used, but not widely. Immediate deprecation sounds good, with removal in 26.05 with the other one.

I don't believe that it's a useful thing to implement and is better implemented as a patch with multiple similar replacements.

wolfgangwalther · 2025-04-02T06:51:53Z

Another question comes to mind: Should we immediately deprecate the bash function substituteAll as well? We have not replaced its usage throughout nixpkgs, yet, but even if we add bash/docs warnings now, eval would not fail, so we don't need to wait with deprecation until we're clean.

We can then clean this up in the next cycle - and remove the function itself immediately, too.

philiptaron · 2025-04-02T17:26:37Z

Should we immediately deprecate the bash function substituteAll as well? We have not replaced its usage throughout nixpkgs, yet, but even if we add bash/docs warnings now, eval would not fail, so we don't need to wait with deprecation until we're clean.

I don't have a strong opinion other than that going off half-cocked is a bad idea. We're tracking the removal of the Nix function / build helper in #237216, not the Bash function, as I read it. So let's keep the course and merge this.

wolfgangwalther · 2025-04-05T13:23:04Z

It's used, but not widely. Immediate deprecation sounds good, with removal [..] with the other one.

I don't believe that it's a useful thing to implement and is better implemented as a patch with multiple similar replacements.

Did that.

I don't have a strong opinion other than that going off half-cocked is a bad idea.

OK, agreed. Will not deprecate it, yet.

We're tracking the removal of the Nix function / build helper in #237216, not the Bash function, as I read it.

#237216 is about both the nix and the bash function, at least for me. I'm 100% set on removing the bash function, too, because it's even worse, at least for my efforts around structuredAttrs.

Q1: Should we adjust the docs immediately? If yes, just add a deprecation or remove them already and point to ... (ah, we don't have replaceVars in the docs, yet?).

I now replaced the docs for substituteAll and substituteAllFiles with some basic docs for replaceVars (and replaceVarsWith).

Does that make sense at this stage?

philiptaron

I think this is still good to go.

wolfgangwalther · 2025-04-23T21:15:24Z

Just resolved conflicts, ready to merge once CI is through.

…uteAll

wolfgangwalther · 2025-04-23T21:29:43Z

Eval told me about 3 new offenders, the refactor tractor took care of them.

NixOS/nixpkgs#395275 Signed-off-by: Brian McGillion <[email protected]>

substituteAll has been deprecated so will start to cause warnings on 25.05 and nixos-unstable. NixOS/nixpkgs#395275 Signed-off-by: Brian McGillion <[email protected]>

substituteAll has been deprecated[1] and removed[2]. [1]: NixOS/nixpkgs#395275 [2]: NixOS/nixpkgs#410058

- substituteAll issues: NixOS/nixpkgs#237216 - substituteAll has been deprecated: NixOS/nixpkgs#395275 - substituteAll has been dropped: NixOS/nixpkgs#410058 - old substituteAll implementation: https://github.com/NixOS/nixpkgs/blob/nixos-24.05/pkgs/build-support/substitute/substitute-all.nix - new replaceVars implementation: https://github.com/hsjobeki/nixpkgs/blob/migrate-doc-comments/pkgs/build-support/replace-vars/replace-vars-with.nix

wolfgangwalther requested a review from philiptaron April 1, 2025 20:24

github-actions bot added 8.has: documentation This PR adds or changes documentation 10.rebuild-darwin: 1-10 This PR causes between 1 and 10 packages to rebuild on Darwin. 10.rebuild-linux: 11-100 This PR causes between 11 and 100 packages to rebuild on Linux. labels Apr 1, 2025

nix-owners bot requested review from GameDungeon, aware70 and jtojnar April 1, 2025 20:32

philiptaron approved these changes Apr 1, 2025

View reviewed changes

pkgs/build-support/substitute/substitute-all.nix Outdated Show resolved Hide resolved

wegank added the 12.approvals: 1 This PR was reviewed and approved by one person. label Apr 2, 2025

wolfgangwalther force-pushed the no-substitute-all branch from e7cd6f9 to 8c3776d Compare April 5, 2025 13:22

github-actions bot added the 6.topic: GNOME GNOME desktop environment and its underlying platform label Apr 5, 2025

nix-owners bot requested review from GetPsyched, fricklerhandwerk and hsjobeki April 5, 2025 13:24

wolfgangwalther force-pushed the no-substitute-all branch from 8c3776d to 7584a58 Compare April 5, 2025 13:26

wolfgangwalther requested a review from emilazy April 12, 2025 15:11

wegank added the 2.status: merge conflict This PR has merge conflicts with the target branch label Apr 17, 2025

philiptaron approved these changes Apr 23, 2025

View reviewed changes

wolfgangwalther added 3 commits April 23, 2025 23:13

recon-ng: use replaceVars instead of substituteAll

91e5816

supercell-wx: use replaceVars instead of substituteAll

78a0cd8

xdg-desktop-portal: use replaceVars instead of substituteAll

4e38e74

wolfgangwalther force-pushed the no-substitute-all branch from 7584a58 to be84e27 Compare April 23, 2025 21:14

ofborg bot removed the 2.status: merge conflict This PR has merge conflicts with the target branch label Apr 23, 2025

wolfgangwalther added 2 commits April 23, 2025 23:27

rocmPackages.llvm.clang-unwrapped: use replaceVars instead of substit…

9c45add

…uteAll

fim: use replaceVars instead of substituteAll

2b7b39c

wolfgangwalther force-pushed the no-substitute-all branch from be84e27 to d3842f2 Compare April 23, 2025 21:29

github-actions bot added the 6.topic: rocm ROCm is an Advanced Micro Devices software stack for graphics processing unit programming. label Apr 23, 2025

github-actions bot added 10.rebuild-linux: 101-500 This PR causes between 101 and 500 packages to rebuild on Linux. and removed 10.rebuild-linux: 11-100 This PR causes between 11 and 100 packages to rebuild on Linux. labels Apr 23, 2025

nix-owners bot requested review from 7c6f434c and primeos April 23, 2025 21:38

wolfgangwalther merged commit eb48ed1 into NixOS:master Apr 23, 2025
23 of 27 checks passed

wolfgangwalther deleted the no-substitute-all branch April 23, 2025 21:57

This was referenced Apr 24, 2025

{recon-ng,xdg-desktop-portal}: use replaceVars instead of substituteAll #393361

Closed

llvmPackages.bolt: add experimental bolt hook #375435

Open

brianmcgillion added a commit to brianmcgillion/ghaf that referenced this pull request Apr 28, 2025

fix: substituteAll has been deprecated

77f9863

NixOS/nixpkgs#395275 Signed-off-by: Brian McGillion <[email protected]>

brianmcgillion added a commit to brianmcgillion/ghaf that referenced this pull request Apr 29, 2025

fix: substituteAll has been deprecated

dc1ac70

NixOS/nixpkgs#395275 Signed-off-by: Brian McGillion <[email protected]>

brianmcgillion added a commit to brianmcgillion/ghaf that referenced this pull request May 3, 2025

fix: substituteAll has been deprecated

e213687

NixOS/nixpkgs#395275 Signed-off-by: Brian McGillion <[email protected]>

brianmcgillion added a commit to brianmcgillion/ghaf that referenced this pull request May 4, 2025

fix: substituteAll has been deprecated

e86fed9

NixOS/nixpkgs#395275 Signed-off-by: Brian McGillion <[email protected]>

brianmcgillion added a commit to brianmcgillion/ghaf that referenced this pull request May 4, 2025

fix: substituteAll has been deprecated

d39e79c

NixOS/nixpkgs#395275 Signed-off-by: Brian McGillion <[email protected]>

nakoo mentioned this pull request May 6, 2025

build.hooks: replace deprecated substituteAll with replaceVars pyproject-nix/pyproject.nix#301

Merged

brianmcgillion added a commit to brianmcgillion/ghaf that referenced this pull request May 8, 2025

fix: substituteAll has been deprecated

683394e

NixOS/nixpkgs#395275 Signed-off-by: Brian McGillion <[email protected]>

brianmcgillion added a commit to brianmcgillion/ghaf that referenced this pull request May 12, 2025

fix: substituteAll has been deprecated

72f67d3

NixOS/nixpkgs#395275 Signed-off-by: Brian McGillion <[email protected]>

brianmcgillion added a commit to brianmcgillion/ghaf that referenced this pull request May 18, 2025

fix: substituteAll has been deprecated

51d4a3f

NixOS/nixpkgs#395275 Signed-off-by: Brian McGillion <[email protected]>

brianmcgillion added a commit to tiiuae/ghaf that referenced this pull request May 19, 2025

fix: substituteAll has been deprecated

c1cda15

NixOS/nixpkgs#395275 Signed-off-by: Brian McGillion <[email protected]>

brianmcgillion mentioned this pull request May 21, 2025

fix(substituteAll): use replaceVars microvm-nix/microvm.nix#358

Merged

TheStachelfisch mentioned this pull request May 27, 2025

substituteAll has been removed and should be replaced with replaceVars AtaraxiaSjel/nur#76

Closed

dafitt mentioned this pull request May 31, 2025

error: substituteAll has been removed. Use replaceVars instead. snowfallorg/flake#11

Open

jian-lin added a commit to linj-fork/dream2nix that referenced this pull request Jun 5, 2025

Replace substituteAll with replaceVars

61cf79d

substituteAll has been deprecated[1] and removed[2]. [1]: NixOS/nixpkgs#395275 [2]: NixOS/nixpkgs#410058

jian-lin mentioned this pull request Jun 5, 2025

Replace substituteAll with replaceVars nix-community/dream2nix#1102

Merged

DavHau pushed a commit to nix-community/dream2nix that referenced this pull request Jun 13, 2025

Replace substituteAll with replaceVars

05f8848

substituteAll has been deprecated[1] and removed[2]. [1]: NixOS/nixpkgs#395275 [2]: NixOS/nixpkgs#410058

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

substituteAll: deprecate#395275

substituteAll: deprecate#395275
wolfgangwalther merged 9 commits intoNixOS:masterfrom
wolfgangwalther:no-substitute-all

wolfgangwalther commented Apr 1, 2025 •

edited

Loading

Uh oh!

philiptaron left a comment

Uh oh!

Uh oh!

philiptaron commented Apr 1, 2025 •

edited

Loading

Uh oh!

wolfgangwalther commented Apr 2, 2025

Uh oh!

philiptaron commented Apr 2, 2025

Uh oh!

wolfgangwalther commented Apr 5, 2025

Uh oh!

philiptaron left a comment

Uh oh!

wolfgangwalther commented Apr 23, 2025

Uh oh!

wolfgangwalther commented Apr 23, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

wolfgangwalther commented Apr 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Things done

Uh oh!

philiptaron left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

philiptaron commented Apr 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

substituteAllFiles

Uh oh!

wolfgangwalther commented Apr 2, 2025

Uh oh!

philiptaron commented Apr 2, 2025

Uh oh!

wolfgangwalther commented Apr 5, 2025

Uh oh!

philiptaron left a comment

Choose a reason for hiding this comment

Uh oh!

wolfgangwalther commented Apr 23, 2025

Uh oh!

wolfgangwalther commented Apr 23, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

wolfgangwalther commented Apr 1, 2025 •

edited

Loading

philiptaron commented Apr 1, 2025 •

edited

Loading

`substituteAllFiles`