lix/doc/manual/src/expressions/arguments-variables.md

75 lines
2.9 KiB
Markdown
Raw Normal View History

2020-07-22 21:17:48 +00:00
# Arguments and Variables
2020-07-24 12:31:33 +00:00
The [Nix expression for GNU Hello](expression-syntax.md) is a
function; it is missing some arguments that have to be filled in
somewhere. In the Nix Packages collection this is done in the file
`pkgs/top-level/all-packages.nix`, where all Nix expressions for
packages are imported and called with the appropriate arguments. Here
are some fragments of `all-packages.nix`, with annotations of what
they mean:
2020-07-22 21:17:48 +00:00
...
rec { ①
2020-07-22 21:17:48 +00:00
hello = import ../applications/misc/hello/ex-1 ② { ③
2020-07-22 21:17:48 +00:00
inherit fetchurl stdenv perl;
};
perl = import ../development/interpreters/perl { ④
2020-07-22 21:17:48 +00:00
inherit fetchurl stdenv;
};
fetchurl = import ../build-support/fetchurl {
inherit stdenv; ...
};
stdenv = ...;
}
1. This file defines a set of attributes, all of which are concrete
2020-07-22 21:17:48 +00:00
derivations (i.e., not functions). In fact, we define a *mutually
recursive* set of attributes. That is, the attributes can refer to
each other. This is precisely what we want since we want to “plug”
the various packages into each other.
2. Here we *import* the Nix expression for GNU Hello. The import
2020-07-22 21:17:48 +00:00
operation just loads and returns the specified Nix expression. In
2020-07-24 12:31:33 +00:00
fact, we could just have put the contents of the Nix expression
for GNU Hello in `all-packages.nix` at this point. That would be
completely equivalent, but it would make `all-packages.nix` rather
bulky.
2020-07-22 21:17:48 +00:00
Note that we refer to `../applications/misc/hello/ex-1`, not
`../applications/misc/hello/ex-1/default.nix`. When you try to
import a directory, Nix automatically appends `/default.nix` to the
file name.
3. This is where the actual composition takes place. Here we *call* the
2020-07-22 21:17:48 +00:00
function imported from `../applications/misc/hello/ex-1` with a set
containing the things that the function expects, namely `fetchurl`,
`stdenv`, and `perl`. We use inherit again to use the attributes
defined in the surrounding scope (we could also have written
`fetchurl = fetchurl;`, etc.).
The result of this function call is an actual derivation that can be
built by Nix (since when we fill in the arguments of the function,
what we get is its body, which is the call to `stdenv.mkDerivation`
2020-07-24 12:31:33 +00:00
in the [Nix expression for GNU Hello](expression-syntax.md)).
2020-07-22 21:17:48 +00:00
> **Note**
>
> Nixpkgs has a convenience function `callPackage` that imports and
> calls a function, filling in any missing arguments by passing the
> corresponding attribute from the Nixpkgs set, like this:
>
> hello = callPackage ../applications/misc/hello/ex-1 { };
>
> If necessary, you can set or override arguments:
>
> hello = callPackage ../applications/misc/hello/ex-1 { stdenv = myStdenv; };
4. Likewise, we have to instantiate Perl, `fetchurl`, and the standard
2020-07-22 21:17:48 +00:00
environment.