blob: 948eb5ef9b72cf32deff606fec52d0cc92f4c8ab (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
# This file defines the structure of the `config` nixpkgs option.
{ lib, ... }:
with lib;
let
mkMassRebuild = args: mkOption (builtins.removeAttrs args [ "feature" ] // {
type = args.type or (types.uniq types.bool);
default = args.default or false;
description = (args.description or ''
Whether to ${args.feature} while building nixpkgs packages.
'') + ''
Changing the default may cause a mass rebuild.
'';
});
options = {
/* Internal stuff */
warnings = mkOption {
type = types.listOf types.str;
default = [];
internal = true;
};
/* Config options */
doCheckByDefault = mkMassRebuild {
feature = "run <literal>checkPhase</literal> by default";
};
allowAliases = mkOption {
type = types.bool;
default = true;
description = ''
Whether to expose old attribute names for compatibility.
The recommended setting is to enable this, as it
improves backward compatibity, easing updates.
The only reason to disable aliases is for continuous
integration purposes. For instance, Nixpkgs should
not depend on aliases in its internal code. Projects
that aren't Nixpkgs should be cautious of instantly
removing all usages of aliases, as migrating too soon
can break compatibility with the stable Nixpkgs releases.
'';
};
};
in {
inherit options;
}
|