diff options
author | Robert Hensing <robert@roberthensing.nl> | 2018-11-10 23:21:21 +0100 |
---|---|---|
committer | Robert Hensing <robert@roberthensing.nl> | 2018-11-10 23:21:21 +0100 |
commit | b60dccbf4f021596913ad595dc43a3dff9f44ad4 (patch) | |
tree | 971a2e914ea818d80128b2486aa4bb5d4bf5c973 /nixos/modules/misc | |
parent | b682778366f91bd3a2b5746cfc951ad429904f16 (diff) | |
download | nixpkgs-b60dccbf4f021596913ad595dc43a3dff9f44ad4.tar nixpkgs-b60dccbf4f021596913ad595dc43a3dff9f44ad4.tar.gz nixpkgs-b60dccbf4f021596913ad595dc43a3dff9f44ad4.tar.bz2 nixpkgs-b60dccbf4f021596913ad595dc43a3dff9f44ad4.tar.lz nixpkgs-b60dccbf4f021596913ad595dc43a3dff9f44ad4.tar.xz nixpkgs-b60dccbf4f021596913ad595dc43a3dff9f44ad4.tar.zst nixpkgs-b60dccbf4f021596913ad595dc43a3dff9f44ad4.zip |
NixOS: update config.nixpkgs.pkgs documentation
Diffstat (limited to 'nixos/modules/misc')
-rw-r--r-- | nixos/modules/misc/nixpkgs.nix | 20 |
1 files changed, 12 insertions, 8 deletions
diff --git a/nixos/modules/misc/nixpkgs.nix b/nixos/modules/misc/nixpkgs.nix index 2bebbdcad94..93fbf16841e 100644 --- a/nixos/modules/misc/nixpkgs.nix +++ b/nixos/modules/misc/nixpkgs.nix @@ -75,11 +75,18 @@ in type = pkgsType; example = literalExample ''import <nixpkgs> {}''; description = '' - This is the evaluation of Nixpkgs that will be provided to - all NixOS modules. Defining this option has the effect of - ignoring the other options that would otherwise be used to - evaluate Nixpkgs, because those are arguments to the default - value. The default value imports the Nixpkgs source files + If set, the pkgs argument to all NixOS modules is the value of + this option, extended with <code>nixpkgs.overlays</code>, if + that is also set. Either <code>nixpkgs.crossSystem</code> or + <code>nixpkgs.localSystem</code> will be used in an assertion + to check that the NixOS and Nixpkgs architectures match. Any + other options in <code>nixpkgs.*</code>, notably <code>config</code>, + will be ignored. + + If unset, the pkgs argument to all NixOS modules is determined + as shown in the default value for this option. + + The default value imports the Nixpkgs source files relative to the location of this NixOS module, because NixOS and Nixpkgs are distributed together for consistency, so the <code>nixos</code> in the default value is in fact a @@ -140,9 +147,6 @@ in If <code>nixpkgs.pkgs</code> is set, overlays specified here will be applied after the overlays that were already present in <code>nixpkgs.pkgs</code>. - - Note that other options such as <code>nixpkgs.config</code> will - be ignored when <code>nixpkgs.pkgs</code> is set. ''; }; |