aynish/helm
1
0
Fork 0
Code Pull requests Packages Projects Releases Activity

Add descriptions to my.nix options

Browse source
This commit is contained in:
Henrik Lissner 2020-01-13 22:11:29 -05:00
parent 9b1a4956d4
commit 3e3d20661a
No known key found for this signature in database
GPG key ID: 5F6C0EA160557395
1 changed files with 21 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
options/my.nix
View file

@ -18,18 +18,24 @@ with lib;
home = mkOption { home = mkOption {
type = options.home-manager.users.type.functor.wrapped; type = options.home-manager.users.type.functor.wrapped;
default = {}; default = {};
description = "A convenience alias for home-manager.users.{my.username}."
}; };
user = mkOption { user = mkOption {
type = types.submodule; type = types.submodule;
default = {}; default = {};
description = "My users.users.NAME submodule"; description = "A convenience alias for users.users.{my.username}.";
}; };
env = mkOption { env = mkOption {
type = with types; attrsOf (either (either str path) (listOf (either str path))); type = with types; attrsOf (either (either str path) (listOf (either str path)));
default = {}; default = {};
description = "..."; description = ''
An map of environment variables that are set later than
environment.variables or environment.sessionVariables. This is insurance
that XDG variables (and other essentials) are initialized by the time
these are set.
'';
apply = mapAttrs apply = mapAttrs
(n: v: if isList v (n: v: if isList v
then concatMapStringsSep ":" (x: toString x) v then concatMapStringsSep ":" (x: toString x) v
@ -39,7 +45,7 @@ with lib;
alias = mkOption { alias = mkOption {
type = with types; nullOr (attrsOf (nullOr (either str path))); type = with types; nullOr (attrsOf (nullOr (either str path)));
default = {}; default = {};
description = "..."; description = "Shell-independent aliases for interactive shells.";
}; };
packages = mkOption { packages = mkOption {
@ -51,19 +57,28 @@ with lib;
init = mkOption { init = mkOption {
type = types.lines; type = types.lines;
default = ""; default = "";
description = "..."; description = ''
An init script that runs after the environment has been rebuilt or
booted. Anything done here should be idempotent and inexpensive.
'';
}; };
zsh = { zsh = {
rc = mkOption { rc = mkOption {
type = types.lines; type = types.lines;
default = ""; default = "";
description = "..."; description = ''
Zsh lines to be written to $XDG_CONFIG_HOME/zsh/extra.zshrc and
sourced by $XDG_CONFIG_HOME/zsh/.zshrc
'';
}; };
env = mkOption { env = mkOption {
type = types.lines; type = types.lines;
default = ""; default = "";
description = "..."; description = ''
Zsh lines to be written to $XDG_CONFIG_HOME/zsh/extra.zshenv and
sourced by $XDG_CONFIG_HOME/zsh/.zshenv
'';
}; };
}; };
}; };