base16-schemes: unstable-2024-06-21 -> unstable-2024-11-12 (#356361)
[NixPkgs.git] / pkgs / top-level / config.nix
bloba4e1116a16dd037e7029cd1ebc1ee61b1ad7b268
1 # This file defines the structure of the `config` nixpkgs option.
3 # This file is tested in `pkgs/test/config.nix`.
4 # Run tests with:
6 #     nix-build -A tests.config
9 { config, lib, ... }:
11 let
12   inherit (lib)
13     literalExpression
14     mapAttrsToList
15     mkOption
16     optionals
17     types
18     ;
20   mkMassRebuild = args: mkOption (builtins.removeAttrs args [ "feature" ] // {
21     type = args.type or (types.uniq types.bool);
22     default = args.default or false;
23     description = ((args.description or ''
24       Whether to ${args.feature} while building nixpkgs packages.
25     '') + ''
26       Changing the default may cause a mass rebuild.
27     '');
28   });
30   options = {
32     /* Internal stuff */
34     # Hide built-in module system options from docs.
35     _module.args = mkOption {
36       internal = true;
37     };
39     warnings = mkOption {
40       type = types.listOf types.str;
41       default = [];
42       internal = true;
43     };
45     /* Config options */
47     warnUndeclaredOptions = mkOption {
48       description = "Whether to warn when `config` contains an unrecognized attribute.";
49       type = types.bool;
50       default = false;
51     };
53     doCheckByDefault = mkMassRebuild {
54       feature = "run `checkPhase` by default";
55     };
57     strictDepsByDefault = mkMassRebuild {
58       feature = "set `strictDeps` to true by default";
59     };
61     structuredAttrsByDefault = mkMassRebuild {
62       feature = "set `__structuredAttrs` to true by default";
63     };
65     enableParallelBuildingByDefault = mkMassRebuild {
66       feature = "set `enableParallelBuilding` to true by default";
67     };
69     configurePlatformsByDefault = mkMassRebuild {
70       feature = "set `configurePlatforms` to `[\"build\" \"host\"]` by default";
71     };
73     contentAddressedByDefault = mkMassRebuild {
74       feature = "set `__contentAddressed` to true by default";
75     };
77     allowAliases = mkOption {
78       type = types.bool;
79       default = true;
80       description = ''
81         Whether to expose old attribute names for compatibility.
83         The recommended setting is to enable this, as it
84         improves backward compatibility, easing updates.
86         The only reason to disable aliases is for continuous
87         integration purposes. For instance, Nixpkgs should
88         not depend on aliases in its internal code. Projects
89         that aren't Nixpkgs should be cautious of instantly
90         removing all usages of aliases, as migrating too soon
91         can break compatibility with the stable Nixpkgs releases.
92       '';
93     };
95     allowUnfree = mkOption {
96       type = types.bool;
97       default = false;
98       # getEnv part is in check-meta.nix
99       defaultText = literalExpression ''false || builtins.getEnv "NIXPKGS_ALLOW_UNFREE" == "1"'';
100       description = ''
101         Whether to allow unfree packages.
103         See [Installing unfree packages](https://nixos.org/manual/nixpkgs/stable/#sec-allow-unfree) in the NixOS manual.
104       '';
105     };
107     allowBroken = mkOption {
108       type = types.bool;
109       default = false;
110       # getEnv part is in check-meta.nix
111       defaultText = literalExpression ''false || builtins.getEnv "NIXPKGS_ALLOW_BROKEN" == "1"'';
112       description = ''
113         Whether to allow broken packages.
115         See [Installing broken packages](https://nixos.org/manual/nixpkgs/stable/#sec-allow-broken) in the NixOS manual.
116       '';
117     };
119     allowUnsupportedSystem = mkOption {
120       type = types.bool;
121       default = false;
122       # getEnv part is in check-meta.nix
123       defaultText = literalExpression ''false || builtins.getEnv "NIXPKGS_ALLOW_UNSUPPORTED_SYSTEM" == "1"'';
124       description = ''
125         Whether to allow unsupported packages.
127         See [Installing packages on unsupported systems](https://nixos.org/manual/nixpkgs/stable/#sec-allow-unsupported-system) in the NixOS manual.
128       '';
129     };
131     cudaSupport = mkMassRebuild {
132       type = types.bool;
133       default = false;
134       feature = "build packages with CUDA support by default";
135     };
137     replaceBootstrapFiles = mkMassRebuild {
138       type = types.functionTo (types.attrsOf types.package);
139       default = lib.id;
140       defaultText = literalExpression "lib.id";
141       description = ''
142         Use the bootstrap files returned instead of the default bootstrap
143         files.
144         The default bootstrap files are passed as an argument.
145       '';
146       example = literalExpression ''
147         prevFiles:
148         let
149           replacements = {
150             "sha256-YQlr088HPoVWBU2jpPhpIMyOyoEDZYDw1y60SGGbUM0=" = import <nix/fetchurl.nix> {
151               url = "(custom glibc linux x86_64 bootstrap-tools.tar.xz)";
152               hash = "(...)";
153             };
154             "sha256-QrTEnQTBM1Y/qV9odq8irZkQSD9uOMbs2Q5NgCvKCNQ=" = import <nix/fetchurl.nix> {
155               url = "(custom glibc linux x86_64 busybox)";
156               hash = "(...)";
157               executable = true;
158             };
159           };
160         in
161         builtins.mapAttrs (name: prev: replacements.''${prev.outputHash} or prev) prevFiles
162       '';
163     };
165     rocmSupport = mkMassRebuild {
166       type = types.bool;
167       default = false;
168       feature = "build packages with ROCm support by default";
169     };
171     showDerivationWarnings = mkOption {
172       type = types.listOf (types.enum [ "maintainerless" ]);
173       default = [];
174       description = ''
175         Which warnings to display for potentially dangerous
176         or deprecated values passed into `stdenv.mkDerivation`.
178         A list of warnings can be found in
179         [/pkgs/stdenv/generic/check-meta.nix](https://github.com/NixOS/nixpkgs/blob/master/pkgs/stdenv/generic/check-meta.nix).
181         This is not a stable interface; warnings may be added, changed
182         or removed without prior notice.
183       '';
184     };
186     checkMeta = mkOption {
187       type = types.bool;
188       default = false;
189       description = ''
190         Whether to check that the `meta` attribute of derivations are correct during evaluation time.
191       '';
192     };
193   };
195 in {
197   freeformType =
198     let t = types.lazyAttrsOf types.raw;
199     in t // {
200       merge = loc: defs:
201         let r = t.merge loc defs;
202         in r // { _undeclared = r; };
203     };
205   inherit options;
207   config = {
208     warnings = optionals config.warnUndeclaredOptions (
209       mapAttrsToList (k: v: "undeclared Nixpkgs option set: config.${k}") config._undeclared or {}
210     );
211   };