mirror of
https://github.com/NixOS/nixpkgs.git
synced 2024-10-23 12:00:35 -04:00
767d80099c
Previously the .enable option was used to encode the condition as well, which lead to some oddness: - In order to encode an assertion, one had to invert it - To disable a check, one had to mkForce it By introducing a separate .check option this is solved because: - It can be used to encode assertions - Disabling is done separately with .enable option, whose default can be overridden without a mkForce
48 lines
1.3 KiB
Nix
48 lines
1.3 KiB
Nix
{ lib, config, ... }:
|
|
|
|
with lib;
|
|
|
|
{
|
|
|
|
options = {
|
|
|
|
assertions = mkOption {
|
|
type = types.listOf types.unspecified;
|
|
internal = true;
|
|
default = [];
|
|
example = [ { assertion = false; message = "you can't enable this for that reason"; } ];
|
|
description = ''
|
|
This option allows modules to express conditions that must
|
|
hold for the evaluation of the system configuration to
|
|
succeed, along with associated error messages for the user.
|
|
'';
|
|
};
|
|
|
|
warnings = mkOption {
|
|
internal = true;
|
|
default = [];
|
|
type = types.listOf types.str;
|
|
example = [ "The `foo' service is deprecated and will go away soon!" ];
|
|
description = ''
|
|
This option allows modules to show warnings to users during
|
|
the evaluation of the system configuration.
|
|
'';
|
|
};
|
|
|
|
};
|
|
|
|
config._module.checks = lib.listToAttrs (lib.imap1 (n: value:
|
|
let
|
|
name = "_${toString n}";
|
|
isWarning = lib.isString value;
|
|
result = {
|
|
check = if isWarning then false else value.assertion;
|
|
type = if isWarning then "warning" else "error";
|
|
message = if isWarning then value else value.message;
|
|
};
|
|
in nameValuePair name result
|
|
) (config.assertions ++ config.warnings));
|
|
|
|
# impl of assertions is in <nixpkgs/nixos/modules/system/activation/top-level.nix>
|
|
}
|