Mirrors/home-manager
2
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-11-26 06:30:28 +00:00
Code Issues Projects Releases Packages Wiki Activity

Improve a few description fields

Browse source
This commit is contained in:
Robert Helgesson 2017-01-15 20:03:55 +01:00
parent 6ec3026e51
commit 071e631648
No known key found for this signature in database
GPG key ID: C3DB11069E65DC86
6 changed files with 18 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
modules/home-environment.nix
View file

@ -100,7 +100,9 @@ in
options = { options = {
target = mkOption { target = mkOption {
type = types.str; type = types.str;
description = "Path to target file relative to $HOME."; description = ''
Path to target file relative to <envar>HOME</envar>.
'';
}; };
text = mkOption { text = mkOption {
@ -147,6 +149,7 @@ in
home.sessionVariables = mkOption { home.sessionVariables = mkOption {
default = {}; default = {};
type = types.attrs; type = types.attrs;
example = { EDITOR = "emacs"; GS_OPTIONS = "-sPAPERSIZE=a4"; };
description = "Environment variables to always set at login."; description = "Environment variables to always set at login.";
}; };

1
modules/programs/bash.nix
View file

@ -38,6 +38,7 @@ in
historyIgnore = mkOption { historyIgnore = mkOption {
type = types.listOf types.str; type = types.listOf types.str;
default = []; default = [];
example = [ "ls" "cd" "exit" ];
description = "List of commands that should not be saved to the history list."; description = "List of commands that should not be saved to the history list.";
}; };

5
modules/programs/beets.nix
View file

@ -14,7 +14,10 @@ in
settings = mkOption { settings = mkOption {
type = types.attrs; type = types.attrs;
default = {}; default = {};
description = "Configuration written to ~/.config/beets/config.yaml"; description = ''
Configuration written to
<filename>~/.config/beets/config.yaml</filename>
'';
}; };
}; };
}; };

2
modules/programs/git.nix
View file

@ -26,7 +26,7 @@ let
gpgPath = mkOption { gpgPath = mkOption {
type = types.str; type = types.str;
default = "${pkgs.gnupg}/bin/gpg2"; default = "${pkgs.gnupg}/bin/gpg2";
defaultText = "''${pkgs.gnupg}/bin/gpg2"; defaultText = "\${pkgs.gnupg}/bin/gpg2";
description = "Path to GnuPG binary to use."; description = "Path to GnuPG binary to use.";
}; };
}; };

1
modules/programs/gnome-terminal.nix
View file

@ -169,6 +169,7 @@ in
profile = mkOption { profile = mkOption {
default = {}; default = {};
type = types.loaOf profileSubModule; type = types.loaOf profileSubModule;
description = "A set of Gnome Terminal profiles.";
}; };
}; };
}; };

11
modules/xresources.nix
View file

@ -21,15 +21,14 @@ in
xresources.properties = mkOption { xresources.properties = mkOption {
type = types.nullOr types.attrs; type = types.nullOr types.attrs;
default = null; default = null;
example = '' example = {
{
"XTerm*faceName" = "dejavu sans mono"; "XTerm*faceName" = "dejavu sans mono";
"Emacs*toolBar" = 0; "Emacs*toolBar" = 0;
} };
'';
description = '' description = ''
X server resources that should be set. If null, then this X server resources that should be set. If <code>null</code>,
feature is disabled and no ~/.Xresources link is produced. then this feature is disabled and no
<filename>~/.Xresources</filename> link is produced.
''; '';
}; };
}; };