greyweather/nix-flake
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update some option descriptions

Browse Source
This commit is contained in:
greyweather committed 2026-09-03 13:56:37 +01:00
1 parent 6d8673ea1e
commit a5d0f522da
8 files changed
+21 -16
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

modules/options/global.nix
+10 -6
View File
@@ -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;
};
};
modules/options/graphics.nix
+3 -3
View File
@@ -4,13 +4,13 @@
components = {
windowManagers = lib.mkOption {
type = inputs.helpers.mkOptionalListOfType (inputs.helpers.mkEnumFromDirContents "${self}/modules/components/window-managers");
description = "This option defines the window manager(s) that should be installed, enabling any config associated with it in the process. It can be either a list or just one value.";
description = "Defines the window manager(s) that should be installed, enabling any config associated with them in the process. It can be either a list or just one value.";
default = [];
};
shells = lib.mkOption {
type = inputs.helpers.mkOptionalListOfType (inputs.helpers.mkEnumFromDirContents "${self}/modules/components/shells");
description = "This option defines the graphical shell(s) that should be installed (e.g. Noctalia, DMS), enabling any config associated with it in the process. It can be either a list or just one value.";
description = "Defines the graphical shell(s) that should be installed (e.g. Noctalia, DMS), enabling any config associated with them in the process. It can be either a list or just one value.";
default = [];
};
};
@@ -20,7 +20,7 @@
flake.nixosModules.graphicsOptions = { lib, ... }: {
options.components.displayManager = lib.mkOption {
type = inputs.helpers.mkEnumFromDirContents "${self}/modules/components/display-managers";
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 = "lightdm";
};
};