update some option descriptions
This commit is contained in:
8 files changed
+21
-16
No files matched your search
@@ -1,12 +1,12 @@
|
||||
{ inputs, self, ... }: let
|
||||
mkExtraPackagesDescription = optionName: "This option is equivalent to `${optionName}`, and exists purely for convenience.";
|
||||
in {
|
||||
imports = [ (inputs.helpers.mkMirroredModulesFlakeModule "globalOptions" ({ lib, ... }: {
|
||||
imports = [ (inputs.helpers.mkMirroredModulesFlakeModule "globalOptions" ({ lib, config, ... }: {
|
||||
options.info = {
|
||||
rootPath = lib.mkOption {
|
||||
type = lib.types.str;
|
||||
description = "Used to tell the config the global path to the flake's root directory, in order to perform direct symlinking (not in `/nix/store`).";
|
||||
default = "/home/grey/nixos";
|
||||
description = "Used to tell the config the absolute path to this flake's root directory, in order to perform actual symlinking (not in `/nix/store` but directly in the directory specified here).";
|
||||
defaultText = "/home/<config.info.userName>/flake";
|
||||
};
|
||||
|
||||
userName = lib.mkOption {
|
||||
@@ -21,6 +21,10 @@ in {
|
||||
default = "";
|
||||
};
|
||||
};
|
||||
|
||||
config = {
|
||||
info.rootPath = lib.mkDefault "/home/${config.info.userName}/flake";
|
||||
};
|
||||
})) ];
|
||||
|
||||
flake.nixosModules.globalOptions = { lib, ... }: {
|
||||
@@ -36,19 +40,19 @@ in {
|
||||
bootLoader = {
|
||||
selection = lib.mkOption {
|
||||
type = inputs.helpers.mkEnumFromDirContents "${self}/modules/components/boot-loaders";
|
||||
description = "This option defines the bootloader that should be used, enabling any config associated with it in the process.";
|
||||
description = "Defines the bootloader that should be used, enabling any config associated with it in the process.";
|
||||
default = "grub";
|
||||
};
|
||||
|
||||
timeout = lib.mkOption {
|
||||
type = lib.types.int;
|
||||
description = "This option defines the timeout length that the bootloader should use, which controls the wait time for keyboard input before selecting the default entry.";
|
||||
description = "Defines the timeout length that the bootloader should use (the wait time for keyboard input before selecting the default entry).";
|
||||
default = 5;
|
||||
};
|
||||
|
||||
maxGenerations = lib.mkOption {
|
||||
type = lib.types.int;
|
||||
description = "This option defines how many entries should be displayed in the bootloader, which can be useful when there are many NixOS generations present before garbage-collection.";
|
||||
description = "Limits how many entries should be displayed in the bootloader, which can be useful when there are many NixOS generations present before garbage-collection.";
|
||||
default = 10;
|
||||
};
|
||||
};
|
||||
|
||||
Reference in new issue
Block a user