2020-12-18 16:42:42 +01:00
|
|
|
{ lib, ... }:
|
2009-04-28 23:05:03 +00:00
|
|
|
{
|
|
|
|
|
2009-09-10 13:53:31 +00:00
|
|
|
options = {
|
|
|
|
|
2024-08-30 00:46:30 +02:00
|
|
|
assertions = lib.mkOption {
|
|
|
|
type = lib.types.listOf lib.types.unspecified;
|
2013-10-23 16:59:33 +02:00
|
|
|
internal = true;
|
2009-09-10 13:53:31 +00:00
|
|
|
default = [ ];
|
2012-04-01 10:54:06 +00:00
|
|
|
example = [
|
|
|
|
{
|
|
|
|
assertion = false;
|
|
|
|
message = "you can't enable this for that reason";
|
|
|
|
}
|
|
|
|
];
|
2009-09-10 13:53:31 +00:00
|
|
|
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.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2024-08-30 00:46:30 +02:00
|
|
|
warnings = lib.mkOption {
|
2013-10-23 18:21:15 +02:00
|
|
|
internal = true;
|
|
|
|
default = [ ];
|
2024-08-30 00:46:30 +02:00
|
|
|
type = lib.types.listOf lib.types.str;
|
2013-10-23 18:21:15 +02:00
|
|
|
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.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2009-04-28 23:05:03 +00:00
|
|
|
};
|
2015-08-05 15:52:12 +02:00
|
|
|
# impl of assertions is in <nixpkgs/nixos/modules/system/activation/top-level.nix>
|
2009-04-28 23:05:03 +00:00
|
|
|
}
|