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

Merge pull request #182685 from pennae/invariant-option-conversions

Browse source 
treewide: invariant option conversions to MD
This commit is contained in:
pennae 2022-07-27 15:39:47 +02:00 • committed by GitHub
commit a16b25432e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
46 changed files with 334 additions and 335 deletions
Download patch file Download diff file Expand all files Collapse all files

4
nixos/modules/config/appstream.nix
View file

@ -6,9 +6,9 @@ with lib;
appstream.enable = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether to install files to support the
<link xlink:href="https://www.freedesktop.org/software/appstream/docs/index.html">AppStream metadata specification</link>.
[AppStream metadata specification](https://www.freedesktop.org/software/appstream/docs/index.html).
'';
};
};

8
nixos/modules/config/fonts/fontdir.nix
View file

@ -30,9 +30,9 @@ in
enable = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Whether to create a directory with links to all fonts in
<filename>/run/current-system/sw/share/X11/fonts</filename>.
{file}`/run/current-system/sw/share/X11/fonts`.
'';
};
@ -40,9 +40,9 @@ in
type = types.bool;
default = config.programs.xwayland.enable;
defaultText = literalExpression "config.programs.xwayland.enable";
description = ''
description = lib.mdDoc ''
Whether to decompress fonts in
<filename>/run/current-system/sw/share/X11/fonts</filename>.
{file}`/run/current-system/sw/share/X11/fonts`.
'';
};

19
nixos/modules/config/locale.nix
View file

@ -22,9 +22,8 @@ in
default = null;
type = timezone;
example = "America/New_York";
description = ''
The time zone used when displaying times and dates. See <link
xlink:href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones"/>
description = lib.mdDoc ''
The time zone used when displaying times and dates. See <https://en.wikipedia.org/wiki/List_of_tz_database_time_zones>
for a comprehensive list of possible values for this setting.
If null, the timezone will default to UTC and can be set imperatively
@ -35,7 +34,7 @@ in
hardwareClockInLocalTime = mkOption {
default = false;
type = types.bool;
description = "If set, keep the hardware clock in local time instead of UTC.";
description = lib.mdDoc "If set, keep the hardware clock in local time instead of UTC.";
};
};
@ -44,18 +43,18 @@ in
latitude = mkOption {
type = types.float;
description = ''
description = lib.mdDoc ''
Your current latitude, between
<literal>-90.0</literal> and <literal>90.0</literal>. Must be provided
`-90.0` and `90.0`. Must be provided
along with longitude.
'';
};
longitude = mkOption {
type = types.float;
description = ''
description = lib.mdDoc ''
Your current longitude, between
between <literal>-180.0</literal> and <literal>180.0</literal>. Must be
between `-180.0` and `180.0`. Must be
provided along with latitude.
'';
};
@ -63,9 +62,9 @@ in
provider = mkOption {
type = types.enum [ "manual" "geoclue2" ];
default = "manual";
description = ''
description = lib.mdDoc ''
The location provider to use for determining your location. If set to
<literal>manual</literal> you must also provide latitude/longitude.
`manual` you must also provide latitude/longitude.
'';
};

24
nixos/modules/config/nsswitch.nix
View file

@ -13,10 +13,10 @@ with lib;
type = types.listOf types.path;
internal = true;
default = [];
description = ''
description = lib.mdDoc ''
Search path for NSS (Name Service Switch) modules. This allows
several DNS resolution methods to be specified via
<filename>/etc/nsswitch.conf</filename>.
{file}`/etc/nsswitch.conf`.
'';
apply = list:
{
@ -28,8 +28,8 @@ with lib;
system.nssDatabases = {
passwd = mkOption {
type = types.listOf types.str;
description = ''
List of passwd entries to configure in <filename>/etc/nsswitch.conf</filename>.
description = lib.mdDoc ''
List of passwd entries to configure in {file}`/etc/nsswitch.conf`.
Note that "files" is always prepended while "systemd" is appended if nscd is enabled.
@ -40,8 +40,8 @@ with lib;
group = mkOption {
type = types.listOf types.str;
description = ''
List of group entries to configure in <filename>/etc/nsswitch.conf</filename>.
description = lib.mdDoc ''
List of group entries to configure in {file}`/etc/nsswitch.conf`.
Note that "files" is always prepended while "systemd" is appended if nscd is enabled.
@ -52,8 +52,8 @@ with lib;
shadow = mkOption {
type = types.listOf types.str;
description = ''
List of shadow entries to configure in <filename>/etc/nsswitch.conf</filename>.
description = lib.mdDoc ''
List of shadow entries to configure in {file}`/etc/nsswitch.conf`.
Note that "files" is always prepended.
@ -64,8 +64,8 @@ with lib;
hosts = mkOption {
type = types.listOf types.str;
description = ''
List of hosts entries to configure in <filename>/etc/nsswitch.conf</filename>.
description = lib.mdDoc ''
List of hosts entries to configure in {file}`/etc/nsswitch.conf`.
Note that "files" is always prepended, and "dns" and "myhostname" are always appended.
@ -76,8 +76,8 @@ with lib;
services = mkOption {
type = types.listOf types.str;
description = ''
List of services entries to configure in <filename>/etc/nsswitch.conf</filename>.
description = lib.mdDoc ''
List of services entries to configure in {file}`/etc/nsswitch.conf`.
Note that "files" is always prepended.

26
nixos/modules/config/pulseaudio.nix
View file

@ -89,7 +89,7 @@ in {
enable = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Whether to enable the PulseAudio sound server.
'';
};
@ -97,7 +97,7 @@ in {
systemWide = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
If false, a PulseAudio server is launched automatically for
each user that tries to use the sound system. The server runs
with user privileges. If true, one system-wide PulseAudio
@ -112,7 +112,7 @@ in {
support32Bit = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Whether to include the 32-bit pulseaudio libraries in the system or not.
This is only useful on 64-bit systems and currently limited to x86_64-linux.
'';
@ -120,7 +120,7 @@ in {
configFile = mkOption {
type = types.nullOr types.path;
description = ''
description = lib.mdDoc ''
The path to the default configuration options the PulseAudio server
should use. By default, the "default.pa" configuration
from the PulseAudio distribution is used.
@ -130,8 +130,8 @@ in {
extraConfig = mkOption {
type = types.lines;
default = "";
description = ''
Literal string to append to <literal>configFile</literal>
description = lib.mdDoc ''
Literal string to append to `configFile`
and the config file generated by the pulseaudio module.
'';
};
@ -139,7 +139,7 @@ in {
extraClientConf = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Extra configuration appended to pulse/client.conf file.
'';
};
@ -151,10 +151,10 @@ in {
else pkgs.pulseaudio;
defaultText = literalExpression "pkgs.pulseaudio";
example = literalExpression "pkgs.pulseaudioFull";
description = ''
description = lib.mdDoc ''
The PulseAudio derivation to use. This can be used to enable
features (such as JACK support, Bluetooth) via the
<literal>pulseaudioFull</literal> package.
`pulseaudioFull` package.
'';
};
@ -162,7 +162,7 @@ in {
type = types.listOf types.package;
default = [];
example = literalExpression "[ pkgs.pulseaudio-modules-bt ]";
description = ''
description = lib.mdDoc ''
Extra pulseaudio modules to use. This is intended for out-of-tree
pulseaudio modules like extra bluetooth codecs.
@ -174,7 +174,7 @@ in {
logLevel = mkOption {
type = types.str;
default = "notice";
description = ''
description = lib.mdDoc ''
The log level that the system-wide pulseaudio daemon should use,
if activated.
'';
@ -183,7 +183,7 @@ in {
config = mkOption {
type = types.attrsOf types.unspecified;
default = {};
description = "Config of the pulse daemon. See <literal>man pulse-daemon.conf</literal>.";
description = lib.mdDoc "Config of the pulse daemon. See `man pulse-daemon.conf`.";
example = literalExpression ''{ realtime-scheduling = "yes"; }'';
};
};
@ -205,7 +205,7 @@ in {
type = types.listOf types.str;
default = [];
example = literalExpression ''[ "127.0.0.1" "192.168.1.0/24" ]'';
description = ''
description = lib.mdDoc ''
A list of IP subnets that are allowed to stream to the server.
'';
};

6
nixos/modules/config/unix-odbc-drivers.nix
View file

@ -20,10 +20,10 @@ in {
type = types.listOf types.package;
default = [];
example = literalExpression "with pkgs.unixODBCDrivers; [ sqlite psql ]";
description = ''
description = lib.mdDoc ''
Specifies Unix ODBC drivers to be registered in
<filename>/etc/odbcinst.ini</filename>. You may also want to
add <literal>pkgs.unixODBC</literal> to the system path to get
{file}`/etc/odbcinst.ini`. You may also want to
add `pkgs.unixODBC` to the system path to get
a command line client to connect to ODBC databases.
'';
};

4
nixos/modules/config/xdg/autostart.nix
View file

@ -10,9 +10,9 @@ with lib;
xdg.autostart.enable = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether to install files to support the
<link xlink:href="https://specifications.freedesktop.org/autostart-spec/autostart-spec-latest.html">XDG Autostart specification</link>.
[XDG Autostart specification](https://specifications.freedesktop.org/autostart-spec/autostart-spec-latest.html).
'';
};
};

4
nixos/modules/config/xdg/icons.nix
View file

@ -10,9 +10,9 @@ with lib;
xdg.icons.enable = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether to install files to support the
<link xlink:href="https://specifications.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html">XDG Icon Theme specification</link>.
[XDG Icon Theme specification](https://specifications.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html).
'';
};
};

4
nixos/modules/config/xdg/menus.nix
View file

@ -10,9 +10,9 @@ with lib;
xdg.menus.enable = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether to install files to support the
<link xlink:href="https://specifications.freedesktop.org/menu-spec/menu-spec-latest.html">XDG Desktop Menu specification</link>.
[XDG Desktop Menu specification](https://specifications.freedesktop.org/menu-spec/menu-spec-latest.html).
'';
};
};

4
nixos/modules/config/xdg/sounds.nix
View file

@ -10,9 +10,9 @@ with lib;
xdg.sounds.enable = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether to install files to support the
<link xlink:href="https://www.freedesktop.org/wiki/Specifications/sound-theme-spec/">XDG Sound Theme specification</link>.
[XDG Sound Theme specification](https://www.freedesktop.org/wiki/Specifications/sound-theme-spec/).
'';
};
};

14
nixos/modules/hardware/cpu/intel-sgx.nix
View file

@ -6,13 +6,13 @@ let
in
{
options.hardware.cpu.intel.sgx.enableDcapCompat = mkOption {
description = ''
description = lib.mdDoc ''
Whether to enable backward compatibility for SGX software build for the
out-of-tree Intel SGX DCAP driver.
Creates symbolic links for the SGX devices <literal>/dev/sgx_enclave</literal>
and <literal>/dev/sgx_provision</literal> to make them available as
<literal>/dev/sgx/enclave</literal> and <literal>/dev/sgx/provision</literal>,
Creates symbolic links for the SGX devices `/dev/sgx_enclave`
and `/dev/sgx_provision` to make them available as
`/dev/sgx/enclave` and `/dev/sgx/provision`,
respectively.
'';
type = types.bool;
@ -22,17 +22,17 @@ in
options.hardware.cpu.intel.sgx.provision = {
enable = mkEnableOption "access to the Intel SGX provisioning device";
user = mkOption {
description = "Owner to assign to the SGX provisioning device.";
description = lib.mdDoc "Owner to assign to the SGX provisioning device.";
type = types.str;
default = "root";
};
group = mkOption {
description = "Group to assign to the SGX provisioning device.";
description = lib.mdDoc "Group to assign to the SGX provisioning device.";
type = types.str;
default = defaultPrvGroup;
};
mode = mkOption {
description = "Mode to set for the SGX provisioning device.";
description = lib.mdDoc "Mode to set for the SGX provisioning device.";
type = types.str;
default = "0660";
};

4
nixos/modules/hardware/ksm.nix
View file

@ -15,9 +15,9 @@ in {
sleep = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
How many milliseconds ksmd should sleep between scans.
Setting it to <literal>null</literal> uses the kernel's default time.
Setting it to `null` uses the kernel's default time.
'';
};
};

4
nixos/modules/i18n/input-method/fcitx.nix
View file

@ -22,9 +22,9 @@ in
let
enginesDrv = filterAttrs (const isDerivation) pkgs.fcitx-engines;
engines = concatStringsSep ", "
(map (name: "<literal>${name}</literal>") (attrNames enginesDrv));
(map (name: "`${name}`") (attrNames enginesDrv));
in
"Enabled Fcitx engines. Available engines are: ${engines}.";
lib.mdDoc "Enabled Fcitx engines. Available engines are: ${engines}.";
};
};

6
nixos/modules/i18n/input-method/ibus.nix
View file

@ -43,15 +43,15 @@ in
let
enginesDrv = filterAttrs (const isDerivation) pkgs.ibus-engines;
engines = concatStringsSep ", "
(map (name: "<literal>${name}</literal>") (attrNames enginesDrv));
(map (name: "`${name}`") (attrNames enginesDrv));
in
"Enabled IBus engines. Available engines are: ${engines}.";
lib.mdDoc "Enabled IBus engines. Available engines are: ${engines}.";
};
panel = mkOption {
type = with types; nullOr path;
default = null;
example = literalExpression ''"''${pkgs.plasma5Packages.plasma-desktop}/lib/libexec/kimpanel-ibus-panel"'';
description = "Replace the IBus panel with another panel.";
description = lib.mdDoc "Replace the IBus panel with another panel.";
};
};
};

18
nixos/modules/installer/tools/tools.nix
View file

@ -75,15 +75,15 @@ in
configuration = mkOption {
internal = true;
type = types.str;
description = ''
The NixOS module that <literal>nixos-generate-config</literal>
saves to <literal>/etc/nixos/configuration.nix</literal>.
description = lib.mdDoc ''
The NixOS module that `nixos-generate-config`
saves to `/etc/nixos/configuration.nix`.
This is an internal option. No backward compatibility is guaranteed.
Use at your own risk!
Note that this string gets spliced into a Perl script. The perl
variable <literal>$bootLoaderConfig</literal> can be used to
variable `$bootLoaderConfig` can be used to
splice in the boot loader configuration.
'';
};
@ -92,15 +92,15 @@ in
internal = true;
type = types.listOf types.lines;
default = [];
description = ''
Text to preseed the desktop configuration that <literal>nixos-generate-config</literal>
saves to <literal>/etc/nixos/configuration.nix</literal>.
description = lib.mdDoc ''
Text to preseed the desktop configuration that `nixos-generate-config`
saves to `/etc/nixos/configuration.nix`.
This is an internal option. No backward compatibility is guaranteed.
Use at your own risk!
Note that this string gets spliced into a Perl script. The perl
variable <literal>$bootLoaderConfig</literal> can be used to
variable `$bootLoaderConfig` can be used to
splice in the boot loader configuration.
'';
};
@ -110,7 +110,7 @@ in
internal = true;
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Disable nixos-rebuild, nixos-generate-config, nixos-installer
and other NixOS tools. This is useful to shrink embedded,
read-only systems which are not expected to be rebuild or

4
nixos/modules/misc/man-db.nix
View file

@ -36,8 +36,8 @@ in
type = lib.types.package;
default = pkgs.man-db;
defaultText = lib.literalExpression "pkgs.man-db";
description = ''
The <literal>man-db</literal> derivation to use. Useful to override
description = lib.mdDoc ''
The `man-db` derivation to use. Useful to override
configuration options used for the package.
'';
};

8
nixos/modules/misc/mandoc.nix
View file

@ -16,9 +16,9 @@ in {
type = with lib.types; listOf str;
default = [ "share/man" ];
example = lib.literalExpression "[ \"share/man\" \"share/man/fr\" ]";
description = ''
description = lib.mdDoc ''
Change the manpath, i. e. the directories where
<citerefentry><refentrytitle>man</refentrytitle><manvolnum>1</manvolnum></citerefentry>
{manpage}`man(1)`
looks for section-specific directories of man pages.
You only need to change this setting if you want extra man pages
(e. g. in non-english languages). All values must be strings that
@ -31,8 +31,8 @@ in {
type = lib.types.package;
default = pkgs.mandoc;
defaultText = lib.literalExpression "pkgs.mandoc";
description = ''
The <literal>mandoc</literal> derivation to use. Useful to override
description = lib.mdDoc ''
The `mandoc` derivation to use. Useful to override
configuration options used for the package.
'';
};

16
nixos/modules/misc/version.nix
View file

@ -49,42 +49,42 @@ in
nixos.version = mkOption {
internal = true;
type = types.str;
description = "The full NixOS version (e.g. <literal>16.03.1160.f2d4ee1</literal>).";
description = lib.mdDoc "The full NixOS version (e.g. `16.03.1160.f2d4ee1`).";
};
nixos.release = mkOption {
readOnly = true;
type = types.str;
default = trivial.release;
description = "The NixOS release (e.g. <literal>16.03</literal>).";
description = lib.mdDoc "The NixOS release (e.g. `16.03`).";
};
nixos.versionSuffix = mkOption {
internal = true;
type = types.str;
default = trivial.versionSuffix;
description = "The NixOS version suffix (e.g. <literal>1160.f2d4ee1</literal>).";
description = lib.mdDoc "The NixOS version suffix (e.g. `1160.f2d4ee1`).";
};
nixos.revision = mkOption {
internal = true;
type = types.nullOr types.str;
default = trivial.revisionWithDefault null;
description = "The Git revision from which this NixOS configuration was built.";
description = lib.mdDoc "The Git revision from which this NixOS configuration was built.";
};
nixos.codeName = mkOption {
readOnly = true;
type = types.str;
default = trivial.codeName;
description = "The NixOS release code name (e.g. <literal>Emu</literal>).";
description = lib.mdDoc "The NixOS release code name (e.g. `Emu`).";
};
stateVersion = mkOption {
type = types.str;
default = cfg.release;
defaultText = literalExpression "config.${opt.release}";
description = ''
description = lib.mdDoc ''
Every once in a while, a new NixOS release may change
configuration defaults in a way incompatible with stateful
data. For instance, if the default version of PostgreSQL
@ -108,13 +108,13 @@ in
internal = true;
type = types.str;
default = "https://nixos.org/channels/nixos-unstable";
description = "Default NixOS channel to which the root user is subscribed.";
description = lib.mdDoc "Default NixOS channel to which the root user is subscribed.";
};
configurationRevision = mkOption {
type = types.nullOr types.str;
default = null;
description = "The Git revision of the top-level flake from which this configuration was built.";
description = lib.mdDoc "The Git revision of the top-level flake from which this configuration was built.";
};
};

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

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

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

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

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

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

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

@ -41,12 +41,12 @@ in
type = types.nullOr types.path;
default = null;
example = literalExpression ''"''${pkgs.my-configs}/lesskey"'';
description = ''
description = lib.mdDoc ''
Path to lesskey configuration file.
<option>configFile</option> takes precedence over <option>commands</option>,
<option>clearDefaultCommands</option>, <option>lineEditingKeys</option>, and
<option>envVariables</option>.
{option}`configFile` takes precedence over {option}`commands`,
{option}`clearDefaultCommands`, {option}`lineEditingKeys`, and
{option}`envVariables`.
'';
};
@ -57,13 +57,13 @@ in
h = "noaction 5\\e(";
l = "noaction 5\\e)";
};
description = "Defines new command keys.";
description = lib.mdDoc "Defines new command keys.";
};
clearDefaultCommands = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Clear all default commands.
You should remember to set the quit key.
Otherwise you will not be able to leave less without killing it.
@ -76,7 +76,7 @@ in
example = {
e = "abort";
};
description = "Defines new line-editing keys.";
description = lib.mdDoc "Defines new line-editing keys.";
};
envVariables = mkOption {
@ -87,14 +87,14 @@ in
example = {
LESS = "--quit-if-one-screen";
};
description = "Defines environment variables.";
description = lib.mdDoc "Defines environment variables.";
};
lessopen = mkOption {
type = types.nullOr types.str;
default = "|${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.
'';
};
@ -102,7 +102,7 @@ in
lessclose = mkOption {
type = types.nullOr types.str;
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).
'';
};

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

@ -14,9 +14,9 @@ in
nanorc = lib.mkOption {
type = lib.types.lines;
default = "";
description = ''
description = lib.mdDoc ''
The system-wide nano configuration.
See <citerefentry><refentrytitle>nanorc</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
See {manpage}`nanorc(5)`.
'';
example = ''
set nowrap
@ -27,7 +27,7 @@ in
syntaxHighlight = lib.mkOption {
type = lib.types.bool;
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 = types.enum [ "http" "socks4" "socks5" ];
description = "Proxy type.";
description = lib.mdDoc "Proxy type.";
};
host = mkOption {
type = types.str;
description = "Proxy host or IP address.";
description = lib.mdDoc "Proxy host or IP address.";
};
port = mkOption {
type = types.port;
description = "Proxy port";
description = lib.mdDoc "Proxy port";
};
};
};
@ -55,26 +55,26 @@ in {
type = mkOption {
type = types.enum [ "dynamic" "strict" "random" ];
default = "strict";
description = ''
<literal>dynamic</literal> - Each connection will be done via chained proxies
description = lib.mdDoc ''
`dynamic` - Each connection will be done via chained proxies
all proxies chained in the order as they appear in the list
at least one proxy must be online to play in chain
(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 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
(or proxy chain, see <option>programs.proxychains.chain.length</option>) from the list.
`random` - Each connection will be done via random proxy
(or proxy chain, see {option}`programs.proxychains.chain.length`) from the list.
'';
};
length = mkOption {
type = types.nullOr types.int;
default = null;
description = ''
description = lib.mdDoc ''
Chain length for random chain.
'';
};
@ -83,7 +83,7 @@ in {
proxyDNS = mkOption {
type = types.bool;
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).";
@ -91,7 +91,7 @@ in {
remoteDNSSubnet = mkOption {
type = types.enum [ 10 127 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.
'';
};
@ -99,24 +99,24 @@ in {
tcpReadTimeOut = mkOption {
type = types.int;
default = 15000;
description = "Connection read time-out in milliseconds.";
description = lib.mdDoc "Connection read time-out in milliseconds.";
};
tcpConnectTimeOut = mkOption {
type = types.int;
default = 8000;
description = "Connection time-out in milliseconds.";
description = lib.mdDoc "Connection time-out in milliseconds.";
};
localnet = mkOption {
type = types.str;
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 {
type = types.attrsOf (types.submodule proxyOptions);
description = ''
description = lib.mdDoc ''
Proxies to be used by proxychains.
'';

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

@ -17,8 +17,8 @@ in
enable = mkOption {
type = types.bool;
default = false;
description = ''
Whether to install SpaceFM and create <filename>/etc/spacefm/spacefm.conf</filename>.
description = lib.mdDoc ''
Whether to install SpaceFM and create {file}`/etc/spacefm/spacefm.conf`.
'';
};
@ -34,10 +34,10 @@ in
terminal_su = "''${pkgs.sudo}/bin/sudo";
}
'';
description = ''
description = lib.mdDoc ''
The system-wide spacefm configuration.
Parameters to be written to <filename>/etc/spacefm/spacefm.conf</filename>.
Refer to the <link xlink:href="https://ignorantguru.github.io/spacefm/spacefm-manual-en.html#programfiles-etc">relevant entry</link> in the SpaceFM manual.
Parameters to be written to {file}`/etc/spacefm/spacefm.conf`.
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 {
inherit (settingsFormat) type;
default = { };
description = ''
Configuration included in <literal>starship.toml</literal>.
description = lib.mdDoc ''
Configuration included in `starship.toml`.
See https://starship.rs/config/#prompt for documentation.
'';

4
nixos/modules/security/lock-kernel-modules.nix
View file

@ -11,11 +11,11 @@ with lib;
security.lockKernelModules = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Disable kernel module loading once the system is fully initialised.
Module loading is disabled until the next reboot. Problems caused
by delayed module loading can be fixed by adding the module(s) in
question to <option>boot.kernelModules</option>.
question to {option}`boot.kernelModules`.
'';
};
};

8
nixos/modules/security/polkit.nix
View file

@ -29,7 +29,7 @@ in
if (subject.local) return "yes";
});
'';
description =
description = lib.mdDoc
''
Any polkit rules to be added to config (in JavaScript ;-). See:
http://www.freedesktop.org/software/polkit/docs/latest/polkit.8.html#polkit-rules
@ -40,12 +40,12 @@ in
type = types.listOf types.str;
default = [ "unix-group:wheel" ];
example = [ "unix-user:alice" "unix-group:admin" ];
description =
description = lib.mdDoc
''
Specifies which users are considered “administrators”, for those
actions that require the user to authenticate as an
administrator (i.e. have an <literal>auth_admin</literal>
value). By default, this is all users in the <literal>wheel</literal> group.
administrator (i.e. have an `auth_admin`
value). By default, this is all users in the `wheel` group.
'';
};

10
nixos/modules/system/boot/loader/generations-dir/generations-dir.nix
View file

@ -22,11 +22,11 @@ in
enable = mkOption {
default = false;
type = types.bool;
description = ''
description = lib.mdDoc ''
Whether to create symlinks to the system generations under
<literal>/boot</literal>. When enabled,
<literal>/boot/default/kernel</literal>,
<literal>/boot/default/initrd</literal>, etc., are updated to
`/boot`. When enabled,
`/boot/default/kernel`,
`/boot/default/initrd`, etc., are updated to
point to the current generation's kernel image, initial RAM
disk, and other bootstrap files.
@ -41,7 +41,7 @@ in
copyKernels = mkOption {
default = false;
type = types.bool;
description = ''
description = lib.mdDoc ''
Whether copy the necessary boot files into /boot, so
/nix/store is not needed by the boot loader.
'';

70
nixos/modules/system/boot/systemd.nix
View file

@ -177,11 +177,11 @@ in
default = pkgs.systemd;
defaultText = literalExpression "pkgs.systemd";
type = types.package;
description = "The systemd package.";
description = lib.mdDoc "The systemd package.";
};
systemd.units = mkOption {
description = "Definition of systemd units.";
description = lib.mdDoc "Definition of systemd units.";
default = {};
type = systemdUtils.types.units;
};
@ -190,43 +190,43 @@ in
default = [];
type = types.listOf types.package;
example = literalExpression "[ pkgs.systemd-cryptsetup-generator ]";
description = "Packages providing systemd units and hooks.";
description = lib.mdDoc "Packages providing systemd units and hooks.";
};
systemd.targets = mkOption {
default = {};
type = systemdUtils.types.targets;
description = "Definition of systemd target units.";
description = lib.mdDoc "Definition of systemd target units.";
};
systemd.services = mkOption {
default = {};
type = systemdUtils.types.services;
description = "Definition of systemd service units.";
description = lib.mdDoc "Definition of systemd service units.";
};
systemd.sockets = mkOption {
default = {};
type = systemdUtils.types.sockets;
description = "Definition of systemd socket units.";
description = lib.mdDoc "Definition of systemd socket units.";
};
systemd.timers = mkOption {
default = {};
type = systemdUtils.types.timers;
description = "Definition of systemd timer units.";
description = lib.mdDoc "Definition of systemd timer units.";
};
systemd.paths = mkOption {
default = {};
type = systemdUtils.types.paths;
description = "Definition of systemd path units.";
description = lib.mdDoc "Definition of systemd path units.";
};
systemd.mounts = mkOption {
default = [];
type = systemdUtils.types.mounts;
description = ''
description = lib.mdDoc ''
Definition of systemd mount units.
This is a list instead of an attrSet, because systemd mandates the names to be derived from
the 'where' attribute.
@ -236,7 +236,7 @@ in
systemd.automounts = mkOption {
default = [];
type = systemdUtils.types.automounts;
description = ''
description = lib.mdDoc ''
Definition of systemd automount units.
This is a list instead of an attrSet, because systemd mandates the names to be derived from
the 'where' attribute.
@ -246,41 +246,41 @@ in
systemd.slices = mkOption {
default = {};
type = systemdUtils.types.slices;
description = "Definition of slice configurations.";
description = lib.mdDoc "Definition of slice configurations.";
};
systemd.generators = mkOption {
type = types.attrsOf types.path;
default = {};
example = { systemd-gpt-auto-generator = "/dev/null"; };
description = ''
description = lib.mdDoc ''
Definition of systemd generators.
For each <literal>NAME = VALUE</literal> pair of the attrSet, a link is generated from
<literal>/etc/systemd/system-generators/NAME</literal> to <literal>VALUE</literal>.
For each `NAME = VALUE` pair of the attrSet, a link is generated from
`/etc/systemd/system-generators/NAME` to `VALUE`.
'';
};
systemd.shutdown = mkOption {
type = types.attrsOf types.path;
default = {};
description = ''
description = lib.mdDoc ''
Definition of systemd shutdown executables.
For each <literal>NAME = VALUE</literal> pair of the attrSet, a link is generated from
<literal>/etc/systemd/system-shutdown/NAME</literal> to <literal>VALUE</literal>.
For each `NAME = VALUE` pair of the attrSet, a link is generated from
`/etc/systemd/system-shutdown/NAME` to `VALUE`.
'';
};
systemd.defaultUnit = mkOption {
default = "multi-user.target";
type = types.str;
description = "Default unit started when the system boots.";
description = lib.mdDoc "Default unit started when the system boots.";
};
systemd.ctrlAltDelUnit = mkOption {
default = "reboot.target";
type = types.str;
example = "poweroff.target";
description = ''
description = lib.mdDoc ''
Target that should be started when Ctrl-Alt-Delete is pressed.
'';
};
@ -289,8 +289,8 @@ in
type = with types; attrsOf (nullOr (oneOf [ str path package ]));
default = {};
example = { TZ = "CET"; };
description = ''
Environment variables passed to <emphasis>all</emphasis> systemd units.
description = lib.mdDoc ''
Environment variables passed to *all* systemd units.
'';
};
@ -298,16 +298,16 @@ in
type = with types; attrsOf (nullOr (oneOf [ str path package ]));
default = {};
example = { SYSTEMD_LOG_LEVEL = "debug"; };
description = ''
description = lib.mdDoc ''
Environment variables of PID 1. These variables are
<emphasis>not</emphasis> passed to started units.
*not* passed to started units.
'';
};
systemd.enableCgroupAccounting = mkOption {
default = true;
type = types.bool;
description = ''
description = lib.mdDoc ''
Whether to enable cgroup accounting.
'';
};
@ -315,7 +315,7 @@ in
systemd.enableUnifiedCgroupHierarchy = mkOption {
default = true;
type = types.bool;
description = ''
description = lib.mdDoc ''
Whether to enable the unified cgroup hierarchy (cgroupsv2).
'';
};
@ -324,7 +324,7 @@ in
default = "";
type = types.lines;
example = "DefaultLimitCORE=infinity";
description = ''
description = lib.mdDoc ''
Extra config options for systemd. See man systemd-system.conf for
available options.
'';
@ -334,7 +334,7 @@ in
default = "";
type = types.lines;
example = "HibernateDelaySec=1h";
description = ''
description = lib.mdDoc ''
Extra config options for systemd sleep state logic.
See sleep.conf.d(5) man page for available options.
'';
@ -344,7 +344,7 @@ in
default = [ ];
type = types.listOf types.str;
example = [ "debug-shell.service" "systemd-quotacheck.service" ];
description = ''
description = lib.mdDoc ''
Additional units shipped with systemd that shall be enabled.
'';
};
@ -353,10 +353,10 @@ in
default = [ ];
type = types.listOf types.str;
example = [ "systemd-backlight@.service" ];
description = ''
description = lib.mdDoc ''
A list of units to skip when generating system systemd configuration directory. This has
priority over upstream units, <option>systemd.units</option>, and
<option>systemd.additionalUpstreamSystemUnits</option>. The main purpose of this is to
priority over upstream units, {option}`systemd.units`, and
{option}`systemd.additionalUpstreamSystemUnits`. The main purpose of this is to
prevent a upstream systemd unit from being added to the initrd with any modifications made to it
by other NixOS modules.
'';
@ -366,7 +366,7 @@ in
type = types.nullOr types.path;
default = null;
example = "/dev/watchdog";
description = ''
description = lib.mdDoc ''
The path to a hardware watchdog device which will be managed by systemd.
If not specified, systemd will default to /dev/watchdog.
'';
@ -376,7 +376,7 @@ in
type = types.nullOr types.str;
default = null;
example = "30s";
description = ''
description = lib.mdDoc ''
The amount of time which can elapse before a watchdog hardware device
will automatically reboot the system. Valid time units include "ms",
"s", "min", "h", "d", and "w".
@ -387,7 +387,7 @@ in
type = types.nullOr types.str;
default = null;
example = "10m";
description = ''
description = lib.mdDoc ''
The amount of time which can elapse after a reboot has been triggered
before a watchdog hardware device will automatically reboot the system.
Valid time units include "ms", "s", "min", "h", "d", and "w".
@ -398,7 +398,7 @@ in
type = types.nullOr types.str;
default = null;
example = "10m";
description = ''
description = lib.mdDoc ''
The amount of time which can elapse when kexec is being executed before
a watchdog hardware device will automatically reboot the system. This
option should only be enabled if reloadTime is also enabled. Valid

40
nixos/modules/system/boot/systemd/initrd.nix
View file

@ -150,7 +150,7 @@ in {
};
contents = mkOption {
description = "Set of files that have to be linked into the initrd";
description = lib.mdDoc "Set of files that have to be linked into the initrd";
example = literalExpression ''
{
"/etc/hostname".text = "mymachine";
@ -162,7 +162,7 @@ in {
};
storePaths = mkOption {
description = ''
description = lib.mdDoc ''
Store paths to copy into the initrd as well.
'';
type = with types; listOf (oneOf [ singleLineStr package ]);
@ -170,7 +170,7 @@ in {
};
extraBin = mkOption {
description = ''
description = lib.mdDoc ''
Tools to add to /bin
'';
example = literalExpression ''
@ -183,7 +183,7 @@ in {
};
suppressedStorePaths = mkOption {
description = ''
description = lib.mdDoc ''
Store paths specified in the storePaths option that
should not be copied.
'';
@ -194,7 +194,7 @@ in {
emergencyAccess = mkOption {
type = with types; oneOf [ bool (nullOr (passwdEntry str)) ];
visible = false;
description = ''
description = lib.mdDoc ''
Set to true for unauthenticated emergency access, and false for
no emergency access.
@ -208,7 +208,7 @@ in {
type = types.listOf types.package;
default = [];
visible = false;
description = ''
description = lib.mdDoc ''
Packages to include in /bin for the stage 1 emergency shell.
'';
};
@ -218,7 +218,7 @@ in {
type = types.listOf types.str;
visible = false;
example = [ "debug-shell.service" "systemd-quotacheck.service" ];
description = ''
description = lib.mdDoc ''
Additional units shipped with systemd that shall be enabled.
'';
};
@ -228,17 +228,17 @@ in {
type = types.listOf types.str;
example = [ "systemd-backlight@.service" ];
visible = false;
description = ''
description = lib.mdDoc ''
A list of units to skip when generating system systemd configuration directory. This has
priority over upstream units, <option>boot.initrd.systemd.units</option>, and
<option>boot.initrd.systemd.additionalUpstreamUnits</option>. The main purpose of this is to
priority over upstream units, {option}`boot.initrd.systemd.units`, and
{option}`boot.initrd.systemd.additionalUpstreamUnits`. The main purpose of this is to
prevent a upstream systemd unit from being added to the initrd with any modifications made to it
by other NixOS modules.
'';
};
units = mkOption {
description = "Definition of systemd units.";
description = lib.mdDoc "Definition of systemd units.";
default = {};
visible = false;
type = systemdUtils.types.units;
@ -249,49 +249,49 @@ in {
visible = false;
type = types.listOf types.package;
example = literalExpression "[ pkgs.systemd-cryptsetup-generator ]";
description = "Packages providing systemd units and hooks.";
description = lib.mdDoc "Packages providing systemd units and hooks.";
};
targets = mkOption {
default = {};
visible = false;
type = systemdUtils.types.initrdTargets;
description = "Definition of systemd target units.";
description = lib.mdDoc "Definition of systemd target units.";
};
services = mkOption {
default = {};
type = systemdUtils.types.initrdServices;
visible = false;
description = "Definition of systemd service units.";
description = lib.mdDoc "Definition of systemd service units.";
};
sockets = mkOption {
default = {};
type = systemdUtils.types.initrdSockets;
visible = false;
description = "Definition of systemd socket units.";
description = lib.mdDoc "Definition of systemd socket units.";
};
timers = mkOption {
default = {};
type = systemdUtils.types.initrdTimers;
visible = false;
description = "Definition of systemd timer units.";
description = lib.mdDoc "Definition of systemd timer units.";
};
paths = mkOption {
default = {};
type = systemdUtils.types.initrdPaths;
visible = false;
description = "Definition of systemd path units.";
description = lib.mdDoc "Definition of systemd path units.";
};
mounts = mkOption {
default = [];
type = systemdUtils.types.initrdMounts;
visible = false;
description = ''
description = lib.mdDoc ''
Definition of systemd mount units.
This is a list instead of an attrSet, because systemd mandates the names to be derived from
the 'where' attribute.
@ -302,7 +302,7 @@ in {
default = [];
type = systemdUtils.types.automounts;
visible = false;
description = ''
description = lib.mdDoc ''
Definition of systemd automount units.
This is a list instead of an attrSet, because systemd mandates the names to be derived from
the 'where' attribute.
@ -313,7 +313,7 @@ in {
default = {};
type = systemdUtils.types.slices;
visible = false;
description = "Definition of slice configurations.";
description = lib.mdDoc "Definition of slice configurations.";
};
};

10
nixos/modules/system/boot/tmp.nix
View file

@ -14,23 +14,23 @@ in
boot.cleanTmpDir = mkOption {
type = types.bool;
default = false;
description = ''
Whether to delete all files in <filename>/tmp</filename> during boot.
description = lib.mdDoc ''
Whether to delete all files in {file}`/tmp` during boot.
'';
};
boot.tmpOnTmpfs = mkOption {
type = types.bool;
default = false;
description = ''
Whether to mount a tmpfs on <filename>/tmp</filename> during boot.
description = lib.mdDoc ''
Whether to mount a tmpfs on {file}`/tmp` during boot.
'';
};
boot.tmpOnTmpfsSize = mkOption {
type = types.oneOf [ types.str types.types.ints.positive ];
default = "50%";
description = ''
description = lib.mdDoc ''
Size of tmpfs in percentage.
Percentage is defined by systemd.
'';

30
nixos/modules/system/etc/etc.nix
View file

@ -82,8 +82,8 @@ in
"default/useradd".text = "GROUP=100 ...";
}
'';
description = ''
Set of files that have to be linked in <filename>/etc</filename>.
description = lib.mdDoc ''
Set of files that have to be linked in {file}`/etc`.
'';
type = with types; attrsOf (submodule (
@ -93,7 +93,7 @@ in
enable = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether this /etc file should be generated. This
option allows specific /etc files to be disabled.
'';
@ -101,9 +101,9 @@ in
target = mkOption {
type = types.str;
description = ''
description = lib.mdDoc ''
Name of symlink (relative to
<filename>/etc</filename>). Defaults to the attribute
{file}`/etc`). Defaults to the attribute
name.
'';
};
@ -111,20 +111,20 @@ in
text = mkOption {
default = null;
type = types.nullOr types.lines;
description = "Text of the file.";
description = lib.mdDoc "Text of the file.";
};
source = mkOption {
type = types.path;
description = "Path of the source file.";
description = lib.mdDoc "Path of the source file.";
};
mode = mkOption {
type = types.str;
default = "symlink";
example = "0600";
description = ''
If set to something else than <literal>symlink</literal>,
description = lib.mdDoc ''
If set to something else than `symlink`,
the file is copied instead of symlinked, with the given
file mode.
'';
@ -133,7 +133,7 @@ in
uid = mkOption {
default = 0;
type = types.int;
description = ''
description = lib.mdDoc ''
UID of created file. Only takes effect when the file is
copied (that is, the mode is not 'symlink').
'';
@ -142,7 +142,7 @@ in
gid = mkOption {
default = 0;
type = types.int;
description = ''
description = lib.mdDoc ''
GID of created file. Only takes effect when the file is
copied (that is, the mode is not 'symlink').
'';
@ -151,20 +151,20 @@ in
user = mkOption {
default = "+${toString config.uid}";
type = types.str;
description = ''
description = lib.mdDoc ''
User name of created file.
Only takes effect when the file is copied (that is, the mode is not 'symlink').
Changing this option takes precedence over <literal>uid</literal>.
Changing this option takes precedence over `uid`.
'';
};
group = mkOption {
default = "+${toString config.gid}";
type = types.str;
description = ''
description = lib.mdDoc ''
Group name of created file.
Only takes effect when the file is copied (that is, the mode is not 'symlink').
Changing this option takes precedence over <literal>gid</literal>.
Changing this option takes precedence over `gid`.
'';
};

14
nixos/modules/tasks/encrypted-devices.nix
View file

@ -16,33 +16,33 @@ let
enable = mkOption {
default = false;
type = types.bool;
description = "The block device is backed by an encrypted one, adds this device as a initrd luks entry.";
description = lib.mdDoc "The block device is backed by an encrypted one, adds this device as a initrd luks entry.";
};
blkDev = mkOption {
default = null;
example = "/dev/sda1";
type = types.nullOr types.str;
description = "Location of the backing encrypted device.";
description = lib.mdDoc "Location of the backing encrypted device.";
};
label = mkOption {
default = null;
example = "rootfs";
type = types.nullOr types.str;
description = "Label of the unlocked encrypted device. Set <literal>fileSystems.&lt;name?&gt;.device</literal> to <literal>/dev/mapper/&lt;label&gt;</literal> to mount the unlocked device.";
description = lib.mdDoc "Label of the unlocked encrypted device. Set `fileSystems.<name?>.device` to `/dev/mapper/<label>` to mount the unlocked device.";
};
keyFile = mkOption {
default = null;
example = "/mnt-root/root/.swapkey";
type = types.nullOr types.str;
description = ''
description = lib.mdDoc ''
Path to a keyfile used to unlock the backing encrypted
device. At the time this keyfile is accessed, the
<literal>neededForBoot</literal> filesystems (see
<literal>fileSystems.&lt;name?&gt;.neededForBoot</literal>)
will have been mounted under <literal>/mnt-root</literal>,
`neededForBoot` filesystems (see
`fileSystems.<name?>.neededForBoot`)
will have been mounted under `/mnt-root`,
so the keyfile path should usually start with "/mnt-root/".
'';
};

24
nixos/modules/tasks/snapraid.nix
View file

@ -14,7 +14,7 @@ in
d2 = "/mnt/disk2/";
d3 = "/mnt/disk3/";
};
description = "SnapRAID data disks.";
description = lib.mdDoc "SnapRAID data disks.";
type = attrsOf str;
};
parityFiles = mkOption {
@ -27,7 +27,7 @@ in
"/mnt/diskt/snapraid.5-parity"
"/mnt/disku/snapraid.6-parity"
];
description = "SnapRAID parity files.";
description = lib.mdDoc "SnapRAID parity files.";
type = listOf str;
};
contentFiles = mkOption {
@ -37,46 +37,46 @@ in
"/mnt/disk1/snapraid.content"
"/mnt/disk2/snapraid.content"
];
description = "SnapRAID content list files.";
description = lib.mdDoc "SnapRAID content list files.";
type = listOf str;
};
exclude = mkOption {
default = [ ];
example = [ "*.unrecoverable" "/tmp/" "/lost+found/" ];
description = "SnapRAID exclude directives.";
description = lib.mdDoc "SnapRAID exclude directives.";
type = listOf str;
};
touchBeforeSync = mkOption {
default = true;
example = false;
description =
"Whether <command>snapraid touch</command> should be run before <command>snapraid sync</command>.";
description = lib.mdDoc
"Whether {command}`snapraid touch` should be run before {command}`snapraid sync`.";
type = bool;
};
sync.interval = mkOption {
default = "01:00";
example = "daily";
description = "How often to run <command>snapraid sync</command>.";
description = lib.mdDoc "How often to run {command}`snapraid sync`.";
type = str;
};
scrub = {
interval = mkOption {
default = "Mon *-*-* 02:00:00";
example = "weekly";
description = "How often to run <command>snapraid scrub</command>.";
description = lib.mdDoc "How often to run {command}`snapraid scrub`.";
type = str;
};
plan = mkOption {
default = 8;
example = 5;
description =
"Percent of the array that should be checked by <command>snapraid scrub</command>.";
description = lib.mdDoc
"Percent of the array that should be checked by {command}`snapraid scrub`.";
type = int;
};
olderThan = mkOption {
default = 10;
example = 20;
description =
description = lib.mdDoc
"Number of days since data was last scrubbed before it can be scrubbed again.";
type = int;
};
@ -90,7 +90,7 @@ in
autosave 500
pool /pool
'';
description = "Extra config options for SnapRAID.";
description = lib.mdDoc "Extra config options for SnapRAID.";
type = lines;
};
};

2
nixos/modules/tasks/swraid.nix
View file

@ -10,7 +10,7 @@ in {
};
mdadmConf = lib.mkOption {
description = "Contents of <filename>/etc/mdadm.conf</filename> in initrd.";
description = lib.mdDoc "Contents of {file}`/etc/mdadm.conf` in initrd.";
type = lib.types.lines;
default = "";
};

12
nixos/modules/virtualisation/anbox.nix
View file

@ -10,7 +10,7 @@ let
address = mkOption {
default = addr;
type = types.str;
description = ''
description = lib.mdDoc ''
IPv${toString v} ${name} address.
'';
};
@ -18,9 +18,9 @@ let
prefixLength = mkOption {
default = pref;
type = types.addCheck types.int (n: n >= 0 && n <= (if v == 4 then 32 else 128));
description = ''
description = lib.mdDoc ''
Subnet mask of the ${name} address, specified as the number of
bits in the prefix (<literal>${if v == 4 then "24" else "64"}</literal>).
bits in the prefix (`${if v == 4 then "24" else "64"}`).
'';
};
};
@ -37,7 +37,7 @@ in
default = pkgs.anbox.image;
defaultText = literalExpression "pkgs.anbox.image";
type = types.package;
description = ''
description = lib.mdDoc ''
Base android image for Anbox.
'';
};
@ -45,7 +45,7 @@ in
extraInit = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Extra shell commands to be run inside the container image during init.
'';
};
@ -57,7 +57,7 @@ in
dns = mkOption {
default = "1.1.1.1";
type = types.str;
description = ''
description = lib.mdDoc ''
Container DNS server.
'';
};

8
nixos/modules/virtualisation/build-vm.nix
View file

@ -25,8 +25,8 @@ in
options = {
virtualisation.vmVariant = mkOption {
description = ''
Machine configuration to be added for the vm script produced by <literal>nixos-rebuild build-vm</literal>.
description = lib.mdDoc ''
Machine configuration to be added for the vm script produced by `nixos-rebuild build-vm`.
'';
inherit (vmVariant) type;
default = {};
@ -34,8 +34,8 @@ in
};
virtualisation.vmVariantWithBootLoader = mkOption {
description = ''
Machine configuration to be added for the vm script produced by <literal>nixos-rebuild build-vm-with-bootloader</literal>.
description = lib.mdDoc ''
Machine configuration to be added for the vm script produced by `nixos-rebuild build-vm-with-bootloader`.
'';
inherit (vmVariantWithBootLoader) type;
default = {};

20
nixos/modules/virtualisation/containers.nix
View file

@ -31,7 +31,7 @@ in
mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
This option enables the common /etc/containers configuration module.
'';
};
@ -39,13 +39,13 @@ in
ociSeccompBpfHook.enable = mkOption {
type = types.bool;
default = false;
description = "Enable the OCI seccomp BPF hook";
description = lib.mdDoc "Enable the OCI seccomp BPF hook";
};
containersConf.settings = mkOption {
type = toml.type;
default = { };
description = "containers.conf configuration";
description = lib.mdDoc "containers.conf configuration";
};
containersConf.cniPlugins = mkOption {
@ -60,7 +60,7 @@ in
pkgs.cniPlugins.dnsname
]
'';
description = ''
description = lib.mdDoc ''
CNI plugins to install on the system.
'';
};
@ -74,14 +74,14 @@ in
runroot = "/run/containers/storage";
};
};
description = "storage.conf configuration";
description = lib.mdDoc "storage.conf configuration";
};
registries = {
search = mkOption {
type = types.listOf types.str;
default = [ "docker.io" "quay.io" ];
description = ''
description = lib.mdDoc ''
List of repositories to search.
'';
};
@ -89,7 +89,7 @@ in
insecure = mkOption {
default = [];
type = types.listOf types.str;
description = ''
description = lib.mdDoc ''
List of insecure repositories.
'';
};
@ -97,7 +97,7 @@ in
block = mkOption {
default = [];
type = types.listOf types.str;
description = ''
description = lib.mdDoc ''
List of blocked repositories.
'';
};
@ -116,10 +116,10 @@ in
};
}
'';
description = ''
description = lib.mdDoc ''
Signature verification policy file.
If this option is empty the default policy file from
<literal>skopeo</literal> will be used.
`skopeo` will be used.
'';
};

12
nixos/modules/virtualisation/digital-ocean-image.nix
View file

@ -13,7 +13,7 @@ in
type = with types; either (enum [ "auto" ]) int;
default = "auto";
example = 4096;
description = ''
description = lib.mdDoc ''
Size of disk image. Unit is MB.
'';
};
@ -21,12 +21,12 @@ in
virtualisation.digitalOceanImage.configFile = mkOption {
type = with types; nullOr path;
default = null;
description = ''
description = lib.mdDoc ''
A path to a configuration file which will be placed at
<literal>/etc/nixos/configuration.nix</literal> and be used when switching
to a new configuration. If set to <literal>null</literal>, a default
`/etc/nixos/configuration.nix` and be used when switching
to a new configuration. If set to `null`, a default
configuration is used that imports
<literal>(modulesPath + "/virtualisation/digital-ocean-config.nix")</literal>.
`(modulesPath + "/virtualisation/digital-ocean-config.nix")`.
'';
};
@ -34,7 +34,7 @@ in
type = types.enum [ "gzip" "bzip2" ];
default = "gzip";
example = "bzip2";
description = ''
description = lib.mdDoc ''
Disk image compression method. Choose bzip2 to generate smaller images that
take longer to generate but will consume less metered storage space on your
Digital Ocean account.

8
nixos/modules/virtualisation/digital-ocean-init.nix
View file

@ -15,18 +15,18 @@ in {
type = types.bool;
default = true;
example = true;
description = "Whether to reconfigure the system from Digital Ocean user data";
description = lib.mdDoc "Whether to reconfigure the system from Digital Ocean user data";
};
options.virtualisation.digitalOcean.defaultConfigFile = mkOption {
type = types.path;
default = defaultConfigFile;
defaultText = literalDocBook ''
The default configuration imports user-data if applicable and
<literal>(modulesPath + "/virtualisation/digital-ocean-config.nix")</literal>.
`(modulesPath + "/virtualisation/digital-ocean-config.nix")`.
'';
description = ''
description = lib.mdDoc ''
A path to a configuration file which will be placed at
<literal>/etc/nixos/configuration.nix</literal> and be used when switching to
`/etc/nixos/configuration.nix` and be used when switching to
a new configuration.
'';
};

12
nixos/modules/virtualisation/docker-rootless.nix
View file

@ -18,18 +18,18 @@ in
enable = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
This option enables docker in a rootless mode, a daemon that manages
linux containers. To interact with the daemon, one needs to set
<command>DOCKER_HOST=unix://$XDG_RUNTIME_DIR/docker.sock</command>.
{command}`DOCKER_HOST=unix://$XDG_RUNTIME_DIR/docker.sock`.
'';
};
setSocketVariable = mkOption {
type = types.bool;
default = false;
description = ''
Point <command>DOCKER_HOST</command> to rootless Docker instance for
description = lib.mdDoc ''
Point {command}`DOCKER_HOST` to rootless Docker instance for
normal users by default.
'';
};
@ -41,7 +41,7 @@ in
ipv6 = true;
"fixed-cidr-v6" = "fd00::/80";
};
description = ''
description = lib.mdDoc ''
Configuration for docker daemon. The attributes are serialized to JSON used as daemon.conf.
See https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file
'';
@ -51,7 +51,7 @@ in
default = pkgs.docker;
defaultText = literalExpression "pkgs.docker";
type = types.package;
description = ''
description = lib.mdDoc ''
Docker package to be used in the module.
'';
};

8
nixos/modules/virtualisation/openvswitch.nix
View file

@ -13,7 +13,7 @@ in {
enable = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Whether to enable Open vSwitch. A configuration daemon (ovs-server)
will be started.
'';
@ -22,9 +22,9 @@ in {
resetOnStart = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Whether to reset the Open vSwitch configuration database to a default
configuration on every start of the systemd <literal>ovsdb.service</literal>.
configuration on every start of the systemd `ovsdb.service`.
'';
};
@ -32,7 +32,7 @@ in {
type = types.package;
default = pkgs.openvswitch;
defaultText = literalExpression "pkgs.openvswitch";
description = ''
description = lib.mdDoc ''
Open vSwitch package to use.
'';
};

28
nixos/modules/virtualisation/virtualbox-image.nix
View file

@ -14,42 +14,42 @@ in {
type = with types; either (enum [ "auto" ]) int;
default = "auto";
example = 50 * 1024;
description = ''
description = lib.mdDoc ''
The size of the VirtualBox base image in MiB.
'';
};
baseImageFreeSpace = mkOption {
type = with types; int;
default = 30 * 1024;
description = ''
description = lib.mdDoc ''
Free space in the VirtualBox base image in MiB.
'';
};
memorySize = mkOption {
type = types.int;
default = 1536;
description = ''
description = lib.mdDoc ''
The amount of RAM the VirtualBox appliance can use in MiB.
'';
};
vmDerivationName = mkOption {
type = types.str;
default = "nixos-ova-${config.system.nixos.label}-${pkgs.stdenv.hostPlatform.system}";
description = ''
description = lib.mdDoc ''
The name of the derivation for the VirtualBox appliance.
'';
};
vmName = mkOption {
type = types.str;
default = "NixOS ${config.system.nixos.label} (${pkgs.stdenv.hostPlatform.system})";
description = ''
description = lib.mdDoc ''
The name of the VirtualBox appliance.
'';
};
vmFileName = mkOption {
type = types.str;
default = "nixos-${config.system.nixos.label}-${pkgs.stdenv.hostPlatform.system}.ova";
description = ''
description = lib.mdDoc ''
The file name of the VirtualBox appliance.
'';
};
@ -60,10 +60,10 @@ in {
rtcuseutc = "on";
usb = "off";
};
description = ''
description = lib.mdDoc ''
Parameters passed to the Virtualbox appliance.
Run <literal>VBoxManage modifyvm --help</literal> to see more options.
Run `VBoxManage modifyvm --help` to see more options.
'';
};
exportParams = mkOption {
@ -72,14 +72,14 @@ in {
"--vsys" "0" "--vendor" "ACME Inc."
];
default = [];
description = ''
description = lib.mdDoc ''
Parameters passed to the Virtualbox export command.
Run <literal>VBoxManage export --help</literal> to see more options.
Run `VBoxManage export --help` to see more options.
'';
};
extraDisk = mkOption {
description = ''
description = lib.mdDoc ''
Optional extra disk/hdd configuration.
The disk will be an 'ext4' partition on a separate VMDK file.
'';
@ -93,16 +93,16 @@ in {
options = {
size = mkOption {
type = types.int;
description = "Size in MiB";
description = lib.mdDoc "Size in MiB";
};
label = mkOption {
type = types.str;
default = "vm-extra-storage";
description = "Label for the disk partition";
description = lib.mdDoc "Label for the disk partition";
};
mountPoint = mkOption {
type = types.str;
description = "Path where to mount this disk.";
description = lib.mdDoc "Path where to mount this disk.";
};
};
});

24
nixos/modules/virtualisation/xen-dom0.nix
View file

@ -37,7 +37,7 @@ in
type = types.package;
defaultText = literalExpression "pkgs.xen";
example = literalExpression "pkgs.xen-light";
description = ''
description = lib.mdDoc ''
The package used for Xen binary.
'';
relatedPackages = [ "xen" "xen-light" ];
@ -47,7 +47,7 @@ in
type = types.package;
defaultText = literalExpression "pkgs.xen";
example = literalExpression "pkgs.qemu_xen-light";
description = ''
description = lib.mdDoc ''
The package with qemu binaries for dom0 qemu and xendomains.
'';
relatedPackages = [ "xen"
@ -59,7 +59,7 @@ in
mkOption {
default = [];
type = types.listOf types.str;
description =
description = lib.mdDoc
''
Parameters passed to the Xen hypervisor at boot time.
'';
@ -70,7 +70,7 @@ in
default = 0;
example = 512;
type = types.addCheck types.int (n: n >= 0);
description =
description = lib.mdDoc
''
Amount of memory (in MiB) allocated to Domain 0 on boot.
If set to 0, all memory is assigned to Domain 0.
@ -81,7 +81,7 @@ in
name = mkOption {
default = "xenbr0";
type = types.str;
description = ''
description = lib.mdDoc ''
Name of bridge the Xen domUs connect to.
'';
};
@ -89,7 +89,7 @@ in
address = mkOption {
type = types.str;
default = "172.16.0.1";
description = ''
description = lib.mdDoc ''
IPv4 address of the bridge.
'';
};
@ -97,9 +97,9 @@ in
prefixLength = mkOption {
type = types.addCheck types.int (n: n >= 0 && n <= 32);
default = 16;
description = ''
description = lib.mdDoc ''
Subnet mask of the bridge interface, specified as the number of
bits in the prefix (<literal>24</literal>).
bits in the prefix (`24`).
A DHCP server will provide IP addresses for the whole, remaining
subnet.
'';
@ -108,8 +108,8 @@ in
forwardDns = mkOption {
type = types.bool;
default = false;
description = ''
If set to <literal>true</literal>, the DNS queries from the
description = lib.mdDoc ''
If set to `true`, the DNS queries from the
hosts connected to the bridge will be forwarded to the DNS
servers specified in /etc/resolv.conf .
'';
@ -120,7 +120,7 @@ in
virtualisation.xen.stored =
mkOption {
type = types.path;
description =
description = lib.mdDoc
''
Xen Store daemon to use. Defaults to oxenstored of the xen package.
'';
@ -130,7 +130,7 @@ in
extraConfig = mkOption {
type = types.lines;
default = "";
description =
description = lib.mdDoc
''
Options defined here will override the defaults for xendomains.
The default options can be seen in the file included from