1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-11-23 11:39:46 +01:00

Fix option defaultText when referencing packages

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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