2020-04-24 23:36:52 +00:00
|
|
|
{ lib, ... }:
|
|
|
|
|
|
|
|
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"; } ];
|
2022-09-09 14:08:57 +00:00
|
|
|
description = lib.mdDoc ''
|
2020-04-24 23:36:52 +00:00
|
|
|
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!" ];
|
2022-09-09 14:08:57 +00:00
|
|
|
description = lib.mdDoc ''
|
2020-04-24 23:36:52 +00:00
|
|
|
This option allows modules to show warnings to users during
|
|
|
|
the evaluation of the system configuration.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
};
|
|
|
|
# impl of assertions is in <nixpkgs/nixos/modules/system/activation/top-level.nix>
|
|
|
|
}
|