diff options
author | Silvan Mosberger <contact@infinisil.com> | 2024-02-09 04:30:09 +0100 |
---|---|---|
committer | Silvan Mosberger <silvan.mosberger@tweag.io> | 2024-02-29 00:35:27 +0100 |
commit | cd5dc76d8340c38487d1b48a3ba090683fa35493 (patch) | |
tree | cc863ca7b4dfb80e3df0f31142af877b723707e2 /pkgs/build-support/substitute/substitute.nix | |
parent | 0151be1b329b9b8eeed6e035a415f571b49ae356 (diff) |
substitute: Deprecate `replacements`, introduce `replacementsList`
Also: - Add tests - Treewide update - Improve docs
Diffstat (limited to 'pkgs/build-support/substitute/substitute.nix')
-rw-r--r-- | pkgs/build-support/substitute/substitute.nix | 56 |
1 files changed, 50 insertions, 6 deletions
diff --git a/pkgs/build-support/substitute/substitute.nix b/pkgs/build-support/substitute/substitute.nix index 7f0332334585b..37233a306840d 100644 --- a/pkgs/build-support/substitute/substitute.nix +++ b/pkgs/build-support/substitute/substitute.nix @@ -1,14 +1,58 @@ -{ stdenvNoCC }: +{ lib, stdenvNoCC }: +/* +This is a wrapper around `substitute` in the stdenv. +Attribute arguments: +- `name` (optional): The name of the resulting derivation +- `src`: The path to the file to substitute +- `substitutions`: The list of substitution arguments to pass + See https://nixos.org/manual/nixpkgs/stable/#fun-substitute +- `replacements`: Deprecated version of `substitutions` + that doesn't support spaces in arguments. + +Example: + +```nix +{ substitute }: +substitute { + src = ./greeting.txt; + substitutions = [ + "--replace" + "world" + "paul" + ]; +} +``` + +See ../../test/substitute for tests +*/ args: -# This is a wrapper around `substitute` in the stdenv. -# The `replacements` attribute should be a list of list of arguments -# to `substitute`, such as `[ "--replace" "sourcetext" "replacementtext" ]` -stdenvNoCC.mkDerivation ({ +let name = if args ? name then args.name else baseNameOf (toString args.src); + deprecationReplacement = lib.pipe args.replacements [ + lib.toList + (map (lib.splitString " ")) + lib.concatLists + (lib.concatMapStringsSep " " lib.strings.escapeNixString) + ]; + optionalDeprecationWarning = + # substitutions is only available starting 24.05. + # TODO: Remove support for replacements sometime after the next release + lib.warnIf (args ? replacements && lib.isInOldestRelease 2405) '' + pkgs.substitute: For "${name}", `replacements` is used, which is deprecated since it doesn't support arguments with spaces. Use `substitutions` instead: + substitutions = [ ${deprecationReplacement} ];''; +in +optionalDeprecationWarning +stdenvNoCC.mkDerivation ({ + inherit name; builder = ./substitute.sh; inherit (args) src; preferLocalBuild = true; allowSubstitutes = false; -} // args // { replacements = args.replacements; }) +} // args // lib.optionalAttrs (args ? substitutions) { + substitutions = + assert lib.assertMsg (lib.isList args.substitutions) '' + pkgs.substitute: For "${name}", `substitutions` is passed, which is expected to be a list, but it's a ${builtins.typeOf args.substitutions} instead.''; + lib.escapeShellArgs args.substitutions; +}) |