Mirrors/home-manager
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Fix option defaultText when referencing packages

Browse source 
By using `literalExample` the documentation will show the option
default without surrounding quotes.
This commit is contained in:
Robert Helgesson 2019-08-28 00:12:28 +02:00
parent db86bd6c01
commit 55b71223d4
No known key found for this signature in database
GPG key ID: 36BDAA14C2797E89
28 changed files with 29 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
modules/programs/chromium.nix
View file

@ -21,7 +21,7 @@ let
inherit visible;
type = types.package;
default = defaultPkg;
defaultText = "pkgs.${browser}";
defaultText = literalExample "pkgs.${browser}";
description = "The ${name} package to use.";
};

2
modules/programs/emacs.nix
View file

@ -29,7 +29,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.emacs;
defaultText = "pkgs.emacs";
defaultText = literalExample "pkgs.emacs";
example = literalExample "pkgs.emacs25-nox";
description = "The Emacs package to use.";
};

2
modules/programs/firefox.nix
View file

@ -49,7 +49,7 @@ in
if versionAtLeast config.home.stateVersion "19.09"
then pkgs.firefox
else pkgs.firefox-unwrapped;
defaultText = "pkgs.firefox";
defaultText = literalExample "pkgs.firefox";
description = ''
The Firefox package to use. If state version ≥ 19.09 then
this should be a wrapped Firefox package. For earlier state

2
modules/programs/fish.nix
View file

@ -23,7 +23,7 @@ in
package = mkOption {
default = pkgs.fish;
defaultText = "pkgs.fish";
defaultText = literalExample "pkgs.fish";
description = ''
The fish package to install. May be used to change the version.
'';

2
modules/programs/git.nix
View file

@ -122,7 +122,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.git;
defaultText = "pkgs.git";
defaultText = literalExample "pkgs.git";
description = ''
Git package to install. Use <varname>pkgs.gitAndTools.gitFull</varname>
to gain access to <command>git send-email</command> for instance.

2
modules/programs/go.nix
View file

@ -18,7 +18,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.go;
defaultText = "pkgs.go";
defaultText = literalExample "pkgs.go";
description = "The Go package to use.";
};

2
modules/programs/keychain.nix
View file

@ -25,7 +25,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.keychain;
defaultText = "pkgs.keychain";
defaultText = literalExample "pkgs.keychain";
description = ''
Keychain package to install.
'';

2
modules/programs/mbsync.nix
View file

@ -112,7 +112,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.isync;
defaultText = "pkgs.isync";
defaultText = literalExample "pkgs.isync";
example = literalExample "pkgs.isync";
description = "The package to use for the mbsync binary.";
};

2
modules/programs/mercurial.nix
View file

@ -17,7 +17,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.mercurial;
defaultText = "pkgs.mercurial";
defaultText = literalExample "pkgs.mercurial";
description = "Mercurial package to install.";
};

2
modules/programs/neovim.nix
View file

@ -107,7 +107,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.neovim-unwrapped;
defaultText = "pkgs.neovim-unwrapped";
defaultText = literalExample "pkgs.neovim-unwrapped";
description = "The package to use for the neovim binary.";
};

2
modules/programs/opam.nix
View file

@ -17,7 +17,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.opam;
defaultText = "pkgs.opam";
defaultText = literalExample "pkgs.opam";
description = "Opam package to install.";
};

2
modules/programs/pidgin.nix
View file

@ -18,7 +18,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.pidgin;
defaultText = "pkgs.pidgin";
defaultText = literalExample "pkgs.pidgin";
description = "The Pidgin package to use.";
};

2
modules/programs/tmux.nix
View file

@ -169,7 +169,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.tmux;
defaultText = "pkgs.tmux";
defaultText = literalExample "pkgs.tmux";
example = literalExample "pkgs.tmux";
description = "The tmux package to install";
};

2
modules/programs/urxvt.nix
View file

@ -15,7 +15,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.rxvt_unicode;
defaultText = "pkgs.rxvt_unicode";
defaultText = literalExample "pkgs.rxvt_unicode";
description = "rxvt-unicode package to install.";
};

2
modules/services/compton.nix
View file

@ -263,7 +263,7 @@ in {
package = mkOption {
type = types.package;
default = pkgs.compton;
defaultText = "pkgs.compton";
defaultText = literalExample "pkgs.compton";
example = literalExample "pkgs.compton";
description = ''
Compton derivation to use.

2
modules/services/dwm-status.nix
View file

@ -20,7 +20,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.dwm-status;
defaultText = "pkgs.dwm-status";
defaultText = literalExample "pkgs.dwm-status";
example = "pkgs.dwm-status.override { enableAlsaUtils = false; }";
description = "Which dwm-status package to use.";
};

2
modules/services/mbsync.nix
View file

@ -22,7 +22,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.isync;
defaultText = "pkgs.isync";
defaultText = literalExample "pkgs.isync";
example = literalExample "pkgs.isync";
description = "The package to use for the mbsync binary.";
};

2
modules/services/mpdris2.nix
View file

@ -42,7 +42,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.mpdris2;
defaultText = "pkgs.mpdris2";
defaultText = literalExample "pkgs.mpdris2";
description = "The mpDris2 package to use.";
};

2
modules/services/polybar.nix
View file

@ -37,7 +37,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.polybar;
defaultText = "pkgs.polybar";
defaultText = literalExample "pkgs.polybar";
description = "Polybar package to install.";
example = literalExample ''
pkgs.polybar.override {

2
modules/services/redshift.nix
View file

@ -96,7 +96,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.redshift;
defaultText = "pkgs.redshift";
defaultText = literalExample "pkgs.redshift";
description = ''
redshift derivation to use.
'';

2
modules/services/stalonetray.nix
View file

@ -15,7 +15,7 @@ in
package = mkOption {
default = pkgs.stalonetray;
defaultText = "pkgs.stalonetray";
defaultText = literalExample "pkgs.stalonetray";
type = types.package;
example = literalExample "pkgs.stalonetray";
description = "The package to use for the Stalonetray binary.";

2
modules/services/status-notifier-watcher.nix
View file

@ -17,7 +17,7 @@ in
package = mkOption {
default = pkgs.haskellPackages.status-notifier-item;
defaultText = "pkgs.haskellPackages.status-notifier-item";
defaultText = literalExample "pkgs.haskellPackages.status-notifier-item";
type = types.package;
example = literalExample "pkgs.haskellPackages.status-notifier-item";
description = "The package to use for the status notifier watcher binary.";

2
modules/services/taffybar.nix
View file

@ -17,7 +17,7 @@ in
package = mkOption {
default = pkgs.taffybar;
defaultText = "pkgs.taffybar";
defaultText = literalExample "pkgs.taffybar";
type = types.package;
example = literalExample "pkgs.taffybar";
description = "The package to use for the Taffybar binary.";

2
modules/services/unclutter.nix
View file

@ -13,7 +13,7 @@ in {
description = "unclutter derivation to use.";
type = types.package;
default = pkgs.unclutter-xfixes;
defaultText = "pkgs.unclutter-xfixes";
defaultText = literalExample "pkgs.unclutter-xfixes";
};
timeout = mkOption {

2
modules/services/window-managers/awesome.nix
View file

@ -22,7 +22,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.awesome;
defaultText = "pkgs.awesome";
defaultText = literalExample "pkgs.awesome";
description = "Package to use for running the Awesome WM.";
};

4
modules/services/window-managers/i3.nix
View file

@ -781,8 +781,8 @@ in
package = mkOption {
type = types.package;
default = pkgs.i3;
defaultText = "pkgs.i3";
example = "pkgs.i3-gaps";
defaultText = literalExample "pkgs.i3";
example = literalExample "pkgs.i3-gaps";
description = ''
i3 package to use.
If 'i3.config.gaps' settings are specified, 'pkgs.i3-gaps' will be set as a default package.

2
modules/services/window-managers/xmonad.nix
View file

@ -24,7 +24,7 @@ in
haskellPackages = mkOption {
default = pkgs.haskellPackages;
defaultText = "pkgs.haskellPackages";
defaultText = literalExample "pkgs.haskellPackages";
example = literalExample "pkgs.haskell.packages.ghc784";
description = ''
The <varname>haskellPackages</varname> used to build xmonad

2
modules/services/xembed-sni-proxy.nix
View file

@ -18,7 +18,7 @@ in
package = mkOption {
type = types.package;
default = pkgs.plasma-workspace;
defaultText = "pkgs.plasma-workspace";
defaultText = literalExample "pkgs.plasma-workspace";
description = ''
Package containing the <command>xembedsniproxy</command>
program.