Warn about the usage of filterSource with Nix store paths #5286
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Sep 22, 2021
edolstra
approved these changes
Oct 6, 2021
src/libexpr/primops.cc
Outdated
Comment on lines
1924
to
1925
| > `filterSource` should not be used to filter Nix output paths | ||
| > (directories whose parent is `/nix/store`). Since `filterSource` |
There was a problem hiding this comment.
Suggested change
| > `filterSource` should not be used to filter Nix output paths | |
| > (directories whose parent is `/nix/store`). Since `filterSource` | |
| > `filterSource` should not be used to filter store paths. Since `filterSource` |
Warn about the usage of `filterSource` with Nix store paths
ilkecan
force-pushed
the
add-a-warning-to-filterSource
branch
from
fe89158
to
a4a6ef4
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There is a lot of confusion caused by the behaviour of
filterSourcewhen used on a nix store path. I guess this is becoming more common with the increased usage of flakes, where the repository is moved to the store before the evaluation. This PR adds a warning that tries to explain whyfilterSourcebehaves unexpectedly and points the users tobuiltins.pathinstead.Non exhaustive list of people's confusion:
https://discourse.nixos.org/t/flakes-and-filtersource/7787
https://discourse.nixos.org/t/builtins-filtersource-causes-rebuilds/12564
https://discourse.nixos.org/t/how-to-make-src-in-a-flake-nix-not-change-a-lot/15129