mirror of
https://github.com/NixOS/nixpkgs.git
synced 2024-11-24 07:53:19 +00:00
b81b3ad1b0
This commit adds a function `mkAliasOptionModuleWithPriority`. This function will make an alias to an existing option and copy over the priority. This functionality is needed for PRs like #53041. In that case `nixos-generate-config` added an option to `hardware-configuration.nix` with `mkDefault`. That option was then changed and an alias created for the old name. The end user should be able to set the non-alias option in their `configuration.nix` and have everything work correctly. Without this function, the priority for the option won't be copied over correctly and the end-user will get a message saying they have the same option set to two different values.
53 lines
1.3 KiB
Nix
53 lines
1.3 KiB
Nix
# This is a test to show that mkAliasOptionModule sets the priority correctly
|
|
# for aliased options.
|
|
|
|
{ config, lib, ... }:
|
|
|
|
with lib;
|
|
|
|
{
|
|
options = {
|
|
# A simple boolean option that can be enabled or disabled.
|
|
enable = lib.mkOption {
|
|
type = types.nullOr types.bool;
|
|
default = null;
|
|
example = true;
|
|
description = ''
|
|
Some descriptive text
|
|
'';
|
|
};
|
|
|
|
# mkAliasOptionModule sets warnings, so this has to be defined.
|
|
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.
|
|
'';
|
|
};
|
|
};
|
|
|
|
imports = [
|
|
# Create an alias for the "enable" option.
|
|
(mkAliasOptionModuleWithPriority [ "enableAlias" ] [ "enable" ])
|
|
|
|
# Disable the aliased option, but with a default (low) priority so it
|
|
# should be able to be overridden by the next import.
|
|
( { config, lib, ... }:
|
|
{
|
|
enableAlias = lib.mkDefault false;
|
|
}
|
|
)
|
|
|
|
# Enable the normal (non-aliased) option.
|
|
( { config, lib, ... }:
|
|
{
|
|
enable = true;
|
|
}
|
|
)
|
|
];
|
|
}
|