movefasta/nixpkgs
0
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-07-13 21:50:33 +03:00
Code Activity

nixos/programs: invariant option docs MD conversions

Browse source
This commit is contained in:
pennae 2022-07-20 12:32:04 +02:00
parent 4f91838584
commit da37ca6760
9 changed files with 74 additions and 74 deletions
Download patch file Download diff file Expand all files Collapse all files

20
nixos/modules/programs/atop.nix
View file

@ -20,7 +20,7 @@ in
type = types.package; type = types.package;
default = pkgs.atop; default = pkgs.atop;
defaultText = literalExpression "pkgs.atop"; defaultText = literalExpression "pkgs.atop";
description = '' description = lib.mdDoc ''
Which package to use for Atop. Which package to use for Atop.
''; '';
}; };
@ -29,7 +29,7 @@ in
enable = mkOption { enable = mkOption {
type = types.bool; type = types.bool;
default = false; default = false;
description = '' description = lib.mdDoc ''
Whether to install and enable the netatop kernel module. Whether to install and enable the netatop kernel module.
Note: this sets the kernel taint flag "O" for loading out-of-tree modules. Note: this sets the kernel taint flag "O" for loading out-of-tree modules.
''; '';
@ -38,7 +38,7 @@ in
type = types.package; type = types.package;
default = config.boot.kernelPackages.netatop; default = config.boot.kernelPackages.netatop;
defaultText = literalExpression "config.boot.kernelPackages.netatop"; defaultText = literalExpression "config.boot.kernelPackages.netatop";
description = '' description = lib.mdDoc ''
Which package to use for netatop. Which package to use for netatop.
''; '';
}; };
@ -47,7 +47,7 @@ in
atopgpu.enable = mkOption { atopgpu.enable = mkOption {
type = types.bool; type = types.bool;
default = false; default = false;
description = '' description = lib.mdDoc ''
Whether to install and enable the atopgpud daemon to get information about Whether to install and enable the atopgpud daemon to get information about
NVIDIA gpus. NVIDIA gpus.
''; '';
@ -56,7 +56,7 @@ in
setuidWrapper.enable = mkOption { setuidWrapper.enable = mkOption {
type = types.bool; type = types.bool;
default = false; default = false;
description = '' description = lib.mdDoc ''
Whether to install a setuid wrapper for Atop. This is required to use some of Whether to install a setuid wrapper for Atop. This is required to use some of
the features as non-root user (e.g.: ipc information, netatop, atopgpu). the features as non-root user (e.g.: ipc information, netatop, atopgpu).
Atop tries to drop the root privileges shortly after starting. Atop tries to drop the root privileges shortly after starting.
@ -66,7 +66,7 @@ in
atopService.enable = mkOption { atopService.enable = mkOption {
type = types.bool; type = types.bool;
default = true; default = true;
description = '' description = lib.mdDoc ''
Whether to enable the atop service responsible for storing statistics for Whether to enable the atop service responsible for storing statistics for
long-term analysis. long-term analysis.
''; '';
@ -74,7 +74,7 @@ in
atopRotateTimer.enable = mkOption { atopRotateTimer.enable = mkOption {
type = types.bool; type = types.bool;
default = true; default = true;
description = '' description = lib.mdDoc ''
Whether to enable the atop-rotate timer, which restarts the atop service Whether to enable the atop-rotate timer, which restarts the atop service
daily to make sure the data files are rotate. daily to make sure the data files are rotate.
''; '';
@ -82,7 +82,7 @@ in
atopacctService.enable = mkOption { atopacctService.enable = mkOption {
type = types.bool; type = types.bool;
default = true; default = true;
description = '' description = lib.mdDoc ''
Whether to enable the atopacct service which manages process accounting. Whether to enable the atopacct service which manages process accounting.
This allows Atop to gather data about processes that disappeared in between This allows Atop to gather data about processes that disappeared in between
two refresh intervals. two refresh intervals.
@ -95,8 +95,8 @@ in
flags = "a1f"; flags = "a1f";
interval = 5; interval = 5;
}; };
description = '' description = lib.mdDoc ''
Parameters to be written to <filename>/etc/atoprc</filename>. Parameters to be written to {file}`/etc/atoprc`.
''; '';
}; };
}; };

20
nixos/modules/programs/bash/bash.nix
View file

@ -30,10 +30,10 @@ in
/* /*
enable = mkOption { enable = mkOption {
default = true; default = true;
description = '' description = lib.mdDoc ''
Whenever to configure Bash as an interactive shell. Whenever to configure Bash as an interactive shell.
Note that this tries to make Bash the default Note that this tries to make Bash the default
<option>users.defaultUserShell</option>, {option}`users.defaultUserShell`,
which in turn means that you might need to explicitly which in turn means that you might need to explicitly
set this variable if you have another shell configured set this variable if you have another shell configured
with NixOS. with NixOS.
@ -44,16 +44,16 @@ in
shellAliases = mkOption { shellAliases = mkOption {
default = {}; default = {};
description = '' description = lib.mdDoc ''
Set of aliases for bash shell, which overrides <option>environment.shellAliases</option>. Set of aliases for bash shell, which overrides {option}`environment.shellAliases`.
See <option>environment.shellAliases</option> for an option format description. See {option}`environment.shellAliases` for an option format description.
''; '';
type = with types; attrsOf (nullOr (either str path)); type = with types; attrsOf (nullOr (either str path));
}; };
shellInit = mkOption { shellInit = mkOption {
default = ""; default = "";
description = '' description = lib.mdDoc ''
Shell script code called during bash shell initialisation. Shell script code called during bash shell initialisation.
''; '';
type = types.lines; type = types.lines;
@ -61,7 +61,7 @@ in
loginShellInit = mkOption { loginShellInit = mkOption {
default = ""; default = "";
description = '' description = lib.mdDoc ''
Shell script code called during login bash shell initialisation. Shell script code called during login bash shell initialisation.
''; '';
type = types.lines; type = types.lines;
@ -69,7 +69,7 @@ in
interactiveShellInit = mkOption { interactiveShellInit = mkOption {
default = ""; default = "";
description = '' description = lib.mdDoc ''
Shell script code called during interactive bash shell initialisation. Shell script code called during interactive bash shell initialisation.
''; '';
type = types.lines; type = types.lines;
@ -92,7 +92,7 @@ in
fi fi
fi fi
''; '';
description = '' description = lib.mdDoc ''
Shell script code used to initialise the bash prompt. Shell script code used to initialise the bash prompt.
''; '';
type = types.lines; type = types.lines;
@ -100,7 +100,7 @@ in
promptPluginInit = mkOption { promptPluginInit = mkOption {
default = ""; default = "";
description = '' description = lib.mdDoc ''
Shell script code used to initialise bash prompt plugins. Shell script code used to initialise bash prompt plugins.
''; '';
type = types.lines; type = types.lines;

4
nixos/modules/programs/dconf.nix
View file

@ -33,14 +33,14 @@ in
profiles = mkOption { profiles = mkOption {
type = types.attrsOf types.path; type = types.attrsOf types.path;
default = {}; default = {};
description = "Set of dconf profile files, installed at <filename>/etc/dconf/profiles/<replaceable>name</replaceable></filename>."; description = lib.mdDoc "Set of dconf profile files, installed at {file}`/etc/dconf/profiles/«name»`.";
internal = true; internal = true;
}; };
packages = mkOption { packages = mkOption {
type = types.listOf types.package; type = types.listOf types.package;
default = []; default = [];
description = "A list of packages which provide dconf profiles and databases in <filename>/etc/dconf</filename>."; description = lib.mdDoc "A list of packages which provide dconf profiles and databases in {file}`/etc/dconf`.";
}; };
}; };
}; };

30
nixos/modules/programs/fish.nix
View file

@ -49,7 +49,7 @@ in
enable = mkOption { enable = mkOption {
default = false; default = false;
description = '' description = lib.mdDoc ''
Whether to configure fish as an interactive shell. Whether to configure fish as an interactive shell.
''; '';
type = types.bool; type = types.bool;
@ -58,16 +58,16 @@ in
useBabelfish = mkOption { useBabelfish = mkOption {
type = types.bool; type = types.bool;
default = false; default = false;
description = '' description = lib.mdDoc ''
If enabled, the configured environment will be translated to native fish using <link xlink:href="https://github.com/bouk/babelfish">babelfish</link>. If enabled, the configured environment will be translated to native fish using [babelfish](https://github.com/bouk/babelfish).
Otherwise, <link xlink:href="https://github.com/oh-my-fish/plugin-foreign-env">foreign-env</link> will be used. Otherwise, [foreign-env](https://github.com/oh-my-fish/plugin-foreign-env) will be used.
''; '';
}; };
vendor.config.enable = mkOption { vendor.config.enable = mkOption {
type = types.bool; type = types.bool;
default = true; default = true;
description = '' description = lib.mdDoc ''
Whether fish should source configuration snippets provided by other packages. Whether fish should source configuration snippets provided by other packages.
''; '';
}; };
@ -75,7 +75,7 @@ in
vendor.completions.enable = mkOption { vendor.completions.enable = mkOption {
type = types.bool; type = types.bool;
default = true; default = true;
description = '' description = lib.mdDoc ''
Whether fish should use completion files provided by other packages. Whether fish should use completion files provided by other packages.
''; '';
}; };
@ -83,7 +83,7 @@ in
vendor.functions.enable = mkOption { vendor.functions.enable = mkOption {
type = types.bool; type = types.bool;
default = true; default = true;
description = '' description = lib.mdDoc ''
Whether fish should autoload fish functions provided by other packages. Whether fish should autoload fish functions provided by other packages.
''; '';
}; };
@ -94,7 +94,7 @@ in
gco = "git checkout"; gco = "git checkout";
npu = "nix-prefetch-url"; npu = "nix-prefetch-url";
}; };
description = '' description = lib.mdDoc ''
Set of fish abbreviations. Set of fish abbreviations.
''; '';
type = with types; attrsOf str; type = with types; attrsOf str;
@ -102,16 +102,16 @@ in
shellAliases = mkOption { shellAliases = mkOption {
default = {}; default = {};
description = '' description = lib.mdDoc ''
Set of aliases for fish shell, which overrides <option>environment.shellAliases</option>. Set of aliases for fish shell, which overrides {option}`environment.shellAliases`.
See <option>environment.shellAliases</option> for an option format description. See {option}`environment.shellAliases` for an option format description.
''; '';
type = with types; attrsOf (nullOr (either str path)); type = with types; attrsOf (nullOr (either str path));
}; };
shellInit = mkOption { shellInit = mkOption {
default = ""; default = "";
description = '' description = lib.mdDoc ''
Shell script code called during fish shell initialisation. Shell script code called during fish shell initialisation.
''; '';
type = types.lines; type = types.lines;
@ -119,7 +119,7 @@ in
loginShellInit = mkOption { loginShellInit = mkOption {
default = ""; default = "";
description = '' description = lib.mdDoc ''
Shell script code called during fish login shell initialisation. Shell script code called during fish login shell initialisation.
''; '';
type = types.lines; type = types.lines;
@ -127,7 +127,7 @@ in
interactiveShellInit = mkOption { interactiveShellInit = mkOption {
default = ""; default = "";
description = '' description = lib.mdDoc ''
Shell script code called during interactive fish shell initialisation. Shell script code called during interactive fish shell initialisation.
''; '';
type = types.lines; type = types.lines;
@ -135,7 +135,7 @@ in
promptInit = mkOption { promptInit = mkOption {
default = ""; default = "";
description = '' description = lib.mdDoc ''
Shell script code used to initialise fish prompt. Shell script code used to initialise fish prompt.
''; '';
type = types.lines; type = types.lines;

20
nixos/modules/programs/less.nix
View file

@ -41,12 +41,12 @@ in
type = types.nullOr types.path; type = types.nullOr types.path;
default = null; default = null;
example = literalExpression ''"''${pkgs.my-configs}/lesskey"''; example = literalExpression ''"''${pkgs.my-configs}/lesskey"'';
description = '' description = lib.mdDoc ''
Path to lesskey configuration file. Path to lesskey configuration file.
<option>configFile</option> takes precedence over <option>commands</option>, {option}`configFile` takes precedence over {option}`commands`,
<option>clearDefaultCommands</option>, <option>lineEditingKeys</option>, and {option}`clearDefaultCommands`, {option}`lineEditingKeys`, and
<option>envVariables</option>. {option}`envVariables`.
''; '';
}; };
@ -57,13 +57,13 @@ in
h = "noaction 5\\e("; h = "noaction 5\\e(";
l = "noaction 5\\e)"; l = "noaction 5\\e)";
}; };
description = "Defines new command keys."; description = lib.mdDoc "Defines new command keys.";
}; };
clearDefaultCommands = mkOption { clearDefaultCommands = mkOption {
type = types.bool; type = types.bool;
default = false; default = false;
description = '' description = lib.mdDoc ''
Clear all default commands. Clear all default commands.
You should remember to set the quit key. You should remember to set the quit key.
Otherwise you will not be able to leave less without killing it. Otherwise you will not be able to leave less without killing it.
@ -76,7 +76,7 @@ in
example = { example = {
e = "abort"; e = "abort";
}; };
description = "Defines new line-editing keys."; description = lib.mdDoc "Defines new line-editing keys.";
}; };
envVariables = mkOption { envVariables = mkOption {
@ -87,14 +87,14 @@ in
example = { example = {
LESS = "--quit-if-one-screen"; LESS = "--quit-if-one-screen";
}; };
description = "Defines environment variables."; description = lib.mdDoc "Defines environment variables.";
}; };
lessopen = mkOption { lessopen = mkOption {
type = types.nullOr types.str; type = types.nullOr types.str;
default = "|${pkgs.lesspipe}/bin/lesspipe.sh %s"; default = "|${pkgs.lesspipe}/bin/lesspipe.sh %s";
defaultText = literalExpression ''"|''${pkgs.lesspipe}/bin/lesspipe.sh %s"''; defaultText = literalExpression ''"|''${pkgs.lesspipe}/bin/lesspipe.sh %s"'';
description = '' description = lib.mdDoc ''
Before less opens a file, it first gives your input preprocessor a chance to modify the way the contents of the file are displayed. Before less opens a file, it first gives your input preprocessor a chance to modify the way the contents of the file are displayed.
''; '';
}; };
@ -102,7 +102,7 @@ in
lessclose = mkOption { lessclose = mkOption {
type = types.nullOr types.str; type = types.nullOr types.str;
default = null; default = null;
description = '' description = lib.mdDoc ''
When less closes a file opened in such a way, it will call another program, called the input postprocessor, which may perform any desired clean-up action (such as deleting the replacement file created by LESSOPEN). When less closes a file opened in such a way, it will call another program, called the input postprocessor, which may perform any desired clean-up action (such as deleting the replacement file created by LESSOPEN).
''; '';
}; };

6
nixos/modules/programs/nano.nix
View file

@ -14,9 +14,9 @@ in
nanorc = lib.mkOption { nanorc = lib.mkOption {
type = lib.types.lines; type = lib.types.lines;
default = ""; default = "";
description = '' description = lib.mdDoc ''
The system-wide nano configuration. The system-wide nano configuration.
See <citerefentry><refentrytitle>nanorc</refentrytitle><manvolnum>5</manvolnum></citerefentry>. See {manpage}`nanorc(5)`.
''; '';
example = '' example = ''
set nowrap set nowrap
@ -27,7 +27,7 @@ in
syntaxHighlight = lib.mkOption { syntaxHighlight = lib.mkOption {
type = lib.types.bool; type = lib.types.bool;
default = true; default = true;
description = "Whether to enable syntax highlight for various languages."; description = lib.mdDoc "Whether to enable syntax highlight for various languages.";
}; };
}; };
}; };

34
nixos/modules/programs/proxychains.nix
View file

@ -26,17 +26,17 @@ let
type = mkOption { type = mkOption {
type = types.enum [ "http" "socks4" "socks5" ]; type = types.enum [ "http" "socks4" "socks5" ];
description = "Proxy type."; description = lib.mdDoc "Proxy type.";
}; };
host = mkOption { host = mkOption {
type = types.str; type = types.str;
description = "Proxy host or IP address."; description = lib.mdDoc "Proxy host or IP address.";
}; };
port = mkOption { port = mkOption {
type = types.port; type = types.port;
description = "Proxy port"; description = lib.mdDoc "Proxy port";
}; };
}; };
}; };
@ -55,26 +55,26 @@ in {
type = mkOption { type = mkOption {
type = types.enum [ "dynamic" "strict" "random" ]; type = types.enum [ "dynamic" "strict" "random" ];
default = "strict"; default = "strict";
description = '' description = lib.mdDoc ''
<literal>dynamic</literal> - Each connection will be done via chained proxies `dynamic` - Each connection will be done via chained proxies
all proxies chained in the order as they appear in the list all proxies chained in the order as they appear in the list
at least one proxy must be online to play in chain at least one proxy must be online to play in chain
(dead proxies are skipped) (dead proxies are skipped)
otherwise <literal>EINTR</literal> is returned to the app. otherwise `EINTR` is returned to the app.
<literal>strict</literal> - Each connection will be done via chained proxies `strict` - Each connection will be done via chained proxies
all proxies chained in the order as they appear in the list all proxies chained in the order as they appear in the list
all proxies must be online to play in chain all proxies must be online to play in chain
otherwise <literal>EINTR</literal> is returned to the app. otherwise `EINTR` is returned to the app.
<literal>random</literal> - Each connection will be done via random proxy `random` - Each connection will be done via random proxy
(or proxy chain, see <option>programs.proxychains.chain.length</option>) from the list. (or proxy chain, see {option}`programs.proxychains.chain.length`) from the list.
''; '';
}; };
length = mkOption { length = mkOption {
type = types.nullOr types.int; type = types.nullOr types.int;
default = null; default = null;
description = '' description = lib.mdDoc ''
Chain length for random chain. Chain length for random chain.
''; '';
}; };
@ -83,7 +83,7 @@ in {
proxyDNS = mkOption { proxyDNS = mkOption {
type = types.bool; type = types.bool;
default = true; default = true;
description = "Proxy DNS requests - no leak for DNS data."; description = lib.mdDoc "Proxy DNS requests - no leak for DNS data.";
}; };
quietMode = mkEnableOption "Quiet mode (no output from the library)."; quietMode = mkEnableOption "Quiet mode (no output from the library).";
@ -91,7 +91,7 @@ in {
remoteDNSSubnet = mkOption { remoteDNSSubnet = mkOption {
type = types.enum [ 10 127 224 ]; type = types.enum [ 10 127 224 ];
default = 224; default = 224;
description = '' description = lib.mdDoc ''
Set the class A subnet number to use for the internal remote DNS mapping, uses the reserved 224.x.x.x range by default. Set the class A subnet number to use for the internal remote DNS mapping, uses the reserved 224.x.x.x range by default.
''; '';
}; };
@ -99,24 +99,24 @@ in {
tcpReadTimeOut = mkOption { tcpReadTimeOut = mkOption {
type = types.int; type = types.int;
default = 15000; default = 15000;
description = "Connection read time-out in milliseconds."; description = lib.mdDoc "Connection read time-out in milliseconds.";
}; };
tcpConnectTimeOut = mkOption { tcpConnectTimeOut = mkOption {
type = types.int; type = types.int;
default = 8000; default = 8000;
description = "Connection time-out in milliseconds."; description = lib.mdDoc "Connection time-out in milliseconds.";
}; };
localnet = mkOption { localnet = mkOption {
type = types.str; type = types.str;
default = "127.0.0.0/255.0.0.0"; default = "127.0.0.0/255.0.0.0";
description = "By default enable localnet for loopback address ranges."; description = lib.mdDoc "By default enable localnet for loopback address ranges.";
}; };
proxies = mkOption { proxies = mkOption {
type = types.attrsOf (types.submodule proxyOptions); type = types.attrsOf (types.submodule proxyOptions);
description = '' description = lib.mdDoc ''
Proxies to be used by proxychains. Proxies to be used by proxychains.
''; '';

10
nixos/modules/programs/spacefm.nix
View file

@ -17,8 +17,8 @@ in
enable = mkOption { enable = mkOption {
type = types.bool; type = types.bool;
default = false; default = false;
description = '' description = lib.mdDoc ''
Whether to install SpaceFM and create <filename>/etc/spacefm/spacefm.conf</filename>. Whether to install SpaceFM and create {file}`/etc/spacefm/spacefm.conf`.
''; '';
}; };
@ -34,10 +34,10 @@ in
terminal_su = "''${pkgs.sudo}/bin/sudo"; terminal_su = "''${pkgs.sudo}/bin/sudo";
} }
''; '';
description = '' description = lib.mdDoc ''
The system-wide spacefm configuration. The system-wide spacefm configuration.
Parameters to be written to <filename>/etc/spacefm/spacefm.conf</filename>. Parameters to be written to {file}`/etc/spacefm/spacefm.conf`.
Refer to the <link xlink:href="https://ignorantguru.github.io/spacefm/spacefm-manual-en.html#programfiles-etc">relevant entry</link> in the SpaceFM manual. Refer to the [relevant entry](https://ignorantguru.github.io/spacefm/spacefm-manual-en.html#programfiles-etc) in the SpaceFM manual.
''; '';
}; };

4
nixos/modules/programs/starship.nix
View file

@ -16,8 +16,8 @@ in {
settings = mkOption { settings = mkOption {
inherit (settingsFormat) type; inherit (settingsFormat) type;
default = { }; default = { };
description = '' description = lib.mdDoc ''
Configuration included in <literal>starship.toml</literal>. Configuration included in `starship.toml`.
See https://starship.rs/config/#prompt for documentation. See https://starship.rs/config/#prompt for documentation.
''; '';