NixOS:config argument: Difference between revisions
imported>Makefu No edit summary |
imported>Fadenb Syntax highlighting |
||
| Line 5: | Line 5: | ||
The following code is used to support the explanation. | The following code is used to support the explanation. | ||
< | <syntaxhighlight lang="nix"> | ||
{config, pkgs, ...}: | {config, pkgs, ...}: | ||
| Line 19: | Line 19: | ||
}; | }; | ||
} | } | ||
</ | </syntaxhighlight> | ||
This snippet of code is a module which declare the option "<code>foo</code>" and define the option "<code>bar</code>". The option "<code>bar</code>" is defined with the value <code>config.foo</code>. This attribute <code>foo</code> of the <code>config</code> argument, is the result of the [[NixOS:Declaration#Evaluation|evaluation]] of the definitions and the declarations of the option "<code>foo</code>". Definitions of the option "<code>foo</code>" may exists in other module used by the system. | This snippet of code is a module which declare the option "<code>foo</code>" and define the option "<code>bar</code>". The option "<code>bar</code>" is defined with the value <code>config.foo</code>. This attribute <code>foo</code> of the <code>config</code> argument, is the result of the [[NixOS:Declaration#Evaluation|evaluation]] of the definitions and the declarations of the option "<code>foo</code>". Definitions of the option "<code>foo</code>" may exists in other module used by the system. | ||
| Line 29: | Line 29: | ||
The process of module computation is highly recursive and may cause trouble when you want to add control flow statements. A common mistake is to use "<code>if</code>" or "<code>assert</code>" statements in the computation of a module. | The process of module computation is highly recursive and may cause trouble when you want to add control flow statements. A common mistake is to use "<code>if</code>" or "<code>assert</code>" statements in the computation of a module. | ||
< | <syntaxhighlight lang="nix"> | ||
{config, pkgs, ...}: | {config, pkgs, ...}: | ||
| Line 47: | Line 47: | ||
{}; | {}; | ||
} | } | ||
</ | </syntaxhighlight> | ||
The previous module cause an infinite recursion: | The previous module cause an infinite recursion: | ||
| Line 58: | Line 58: | ||
To avoid such infinite recursion, [[NixOS:Properties|properties]] have been introduced, thus the previous code should be rewritten in: | To avoid such infinite recursion, [[NixOS:Properties|properties]] have been introduced, thus the previous code should be rewritten in: | ||
< | <syntaxhighlight lang="nix"> | ||
{config, pkgs, ...}: | {config, pkgs, ...}: | ||
| Line 74: | Line 74: | ||
}; | }; | ||
} | } | ||
</ | </syntaxhighlight> | ||
== Common Pattern == | == Common Pattern == | ||
| Line 80: | Line 80: | ||
Often, the module declare options embedded inside an attribute set. To access these options, we add an attribute <code>cfg</code> as a shortcut notation. | Often, the module declare options embedded inside an attribute set. To access these options, we add an attribute <code>cfg</code> as a shortcut notation. | ||
< | <syntaxhighlight lang="nix"> | ||
{config, pkgs, ...}: | {config, pkgs, ...}: | ||
| Line 103: | Line 103: | ||
}; | }; | ||
} | } | ||
</ | </syntaxhighlight> | ||
[[Category:Discussion]] | [[Category:Discussion]] | ||
[[Category:Pages_with_syntax_highlighting_errors]] | [[Category:Pages_with_syntax_highlighting_errors]] | ||
Revision as of 19:45, 22 August 2017
This argument gives access to the entire configuration of the system. It is computed from option declarations and option definitions defined inside all modules used for the system.
Simple Case
The following code is used to support the explanation.
{config, pkgs, ...}:
{
options = {
foo = pkgs.lib.mkOption {
description = "...";
};
};
config = {
bar = config.foo;
};
}
This snippet of code is a module which declare the option "foo" and define the option "bar". The option "bar" is defined with the value config.foo. This attribute foo of the config argument, is the result of the evaluation of the definitions and the declarations of the option "foo". Definitions of the option "foo" may exists in other module used by the system.
Adding additional modules to the system may change the value of config.foo and may change the behavior of the previous module.
Conditional Statements
The process of module computation is highly recursive and may cause trouble when you want to add control flow statements. A common mistake is to use "if" or "assert" statements in the computation of a module.
{config, pkgs, ...}:
{
options = {
foo = pkgs.lib.mkOption {
default = false;
type = with pkgs.lib.types; bool;
description = "enable foo";
};
};
config =
if config.foo then
{ bar = 42; }
else
{};
}
The previous module cause an infinite recursion:
- The
configattribute is evaluated. This evaluation needs the result of theifstatement. - The
ifstatement is evaluated. This evaluation needs the result of the condition. - The condition (
config.foo) is evaluated. This evaluation needs the result of theconfigargument. - The
configargument is evaluated. This evaluation needs the result of merging of all modules. - The merge function of the modules is evaluated. This evaluation needs the evaluation of each module
configattribute.
To avoid such infinite recursion, properties have been introduced, thus the previous code should be rewritten in:
{config, pkgs, ...}:
{
options = {
foo = pkgs.lib.mkOption {
default = false;
type = with pkgs.lib.types; bool;
description = "enable foo";
};
};
config = pkgs.lib.mkIf config.foo {
bar = 42;
};
}
Common Pattern
Often, the module declare options embedded inside an attribute set. To access these options, we add an attribute cfg as a shortcut notation.
{config, pkgs, ...}:
let
cfg = config.foo.bar.baz;
# ...
in
with pkgs.lib; {
options = {
foo.bar.baz = {
enable = mkOption { /* ... */ };
option1 = mkOption { /* ... */ };
option2 = mkOption { /* ... */ };
option3 = mkOption { /* ... */ };
};
};
config = mkIf cfg.enable {
# ...
};
}