Commit 0fdae315 authored by Artturin's avatar Artturin
Browse files

stdenv: let overrideAttrs accept attrset OR function 



Makes overrideAttrs usable in the same way that `override` can be used.
It allows the first argument of `overrideAttrs` to be either a function
or an attrset, instead of only a function:

hello.overrideAttrs (old: { postBuild = "echo hello"; })
hello.overrideAttrs { postBuild = "echo hello"; }

Previously only the first example was possible.

Co-authored-by: default avataradisbladis <adisbladis@gmail.com>
Co-authored-by: default avatarmatthewcroughan <matt@croughan.sh>
parent 3cd360a2

doc/using/overrides.chapter.md

+12 −4
Original line number Diff line number Diff line
@@ -36,15 +36,15 @@ In the first example, `pkgs.foo` is the result of a function call with some defa 


The function `overrideAttrs` allows overriding the attribute set passed to a `stdenv.mkDerivation` call, producing a new derivation based on the original one. This function is available on all derivations produced by the `stdenv.mkDerivation` function, which is most packages in the nixpkgs expression `pkgs`.



Example usage:

Example usages:



```nix

helloWithDebug = pkgs.hello.overrideAttrs (finalAttrs: previousAttrs: {

  separateDebugInfo = true;

helloBar = pkgs.hello.overrideAttrs (finalAttrs: previousAttrs: {

  pname = previousAttrs.pname + "-bar";

});

```



In the above example, the `separateDebugInfo` attribute is overridden to be true, thus building debug info for `helloWithDebug`, while all other attributes will be retained from the original `hello` package.

In the above example, "-bar" is appended to the pname attribute, while all other attributes will be retained from the original `hello` package.



The argument `previousAttrs` is conventionally used to refer to the attr set originally passed to `stdenv.mkDerivation`.
@@ -52,6 +52,14 @@ The argument `finalAttrs` refers to the final attributes passed to `mkDerivation 


If only a one-argument function is written, the argument has the meaning of `previousAttrs`.



```nix

helloWithDebug = pkgs.hello.overrideAttrs {

  separateDebugInfo = true;

};

```



In the above example, the `separateDebugInfo` attribute is overridden to be true, thus building debug info for `helloWithDebug`. Function arguments can be omitted if there is no need to access previousAttrs or finalAttrs.



::: {.note}

Note that `separateDebugInfo` is processed only by the `stdenv.mkDerivation` function, not the generated, raw Nix derivation. Thus, using `overrideDerivation` will not work in this case, as it overrides only the attributes of the final derivation. It is for this reason that `overrideAttrs` should be preferred in (almost) all cases to `overrideDerivation`, i.e. to allow using `stdenv.mkDerivation` to process input arguments, as well as the fact that it is easier to use (you can use the same attribute names you see in your Nix code, instead of the ones generated (e.g. `buildInputs` vs `nativeBuildInputs`), and it involves less typing).

:::

pkgs/stdenv/generic/make-derivation.nix

+1 −1
Original line number Diff line number Diff line
@@ -41,7 +41,7 @@ let 
              else x;

        in

          makeDerivationExtensible

            (self: let super = rattrs self; in super // f self super);

            (self: let super = rattrs self; in super // (if builtins.isFunction f0 || f0?__functor then f self super else f0));



      finalPackage =

        mkDerivationSimple overrideAttrs args;

pkgs/test/overriding.nix

+5 −0
Original line number Diff line number Diff line
@@ -21,6 +21,11 @@ let 
        expr = repeatedOverrides.entangled.pname == "a-better-figlet-with-blackjack";

        expected = true;

      })

      ({

        name = "overriding-using-only-attrset";

        expr = (pkgs.hello.overrideAttrs { pname = "hello-overriden"; }).pname == "hello-overriden";

        expected = true;

      })

    ];



  addEntangled = origOverrideAttrs: f: