diff --git a/nixos/modules/config/appstream.nix b/nixos/modules/config/appstream.nix
index a72215c2f561..5b48f6e1705d 100644
--- a/nixos/modules/config/appstream.nix
+++ b/nixos/modules/config/appstream.nix
@@ -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
- AppStream metadata specification.
+ [AppStream metadata specification](https://www.freedesktop.org/software/appstream/docs/index.html).
'';
};
};
diff --git a/nixos/modules/config/fonts/fontdir.nix b/nixos/modules/config/fonts/fontdir.nix
index 560918302ca6..30e0dfe2566a 100644
--- a/nixos/modules/config/fonts/fontdir.nix
+++ b/nixos/modules/config/fonts/fontdir.nix
@@ -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
- /run/current-system/sw/share/X11/fonts.
+ {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
- /run/current-system/sw/share/X11/fonts.
+ {file}`/run/current-system/sw/share/X11/fonts`.
'';
};
diff --git a/nixos/modules/config/locale.nix b/nixos/modules/config/locale.nix
index 6f0565881877..7716e121c712 100644
--- a/nixos/modules/config/locale.nix
+++ b/nixos/modules/config/locale.nix
@@ -22,9 +22,8 @@ in
default = null;
type = timezone;
example = "America/New_York";
- description = ''
- The time zone used when displaying times and dates. See
+ description = lib.mdDoc ''
+ The time zone used when displaying times and dates. See
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
- -90.0 and 90.0. 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 -180.0 and 180.0. 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
- manual you must also provide latitude/longitude.
+ `manual` you must also provide latitude/longitude.
'';
};
diff --git a/nixos/modules/config/nsswitch.nix b/nixos/modules/config/nsswitch.nix
index e494ff5f74d5..b004072813bd 100644
--- a/nixos/modules/config/nsswitch.nix
+++ b/nixos/modules/config/nsswitch.nix
@@ -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
- /etc/nsswitch.conf.
+ {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 /etc/nsswitch.conf.
+ 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 /etc/nsswitch.conf.
+ 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 /etc/nsswitch.conf.
+ 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 /etc/nsswitch.conf.
+ 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 /etc/nsswitch.conf.
+ description = lib.mdDoc ''
+ List of services entries to configure in {file}`/etc/nsswitch.conf`.
Note that "files" is always prepended.
diff --git a/nixos/modules/config/pulseaudio.nix b/nixos/modules/config/pulseaudio.nix
index 01555d28b73f..aa3ca549f09a 100644
--- a/nixos/modules/config/pulseaudio.nix
+++ b/nixos/modules/config/pulseaudio.nix
@@ -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 configFile
+ 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
- pulseaudioFull 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 man pulse-daemon.conf.";
+ 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.
'';
};
diff --git a/nixos/modules/config/unix-odbc-drivers.nix b/nixos/modules/config/unix-odbc-drivers.nix
index 055c3b2364e6..7bd3fa1600b0 100644
--- a/nixos/modules/config/unix-odbc-drivers.nix
+++ b/nixos/modules/config/unix-odbc-drivers.nix
@@ -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
- /etc/odbcinst.ini. You may also want to
- add pkgs.unixODBC 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.
'';
};
diff --git a/nixos/modules/config/xdg/autostart.nix b/nixos/modules/config/xdg/autostart.nix
index 40984cb5ec53..a4fdbda911a2 100644
--- a/nixos/modules/config/xdg/autostart.nix
+++ b/nixos/modules/config/xdg/autostart.nix
@@ -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
- XDG Autostart specification.
+ [XDG Autostart specification](https://specifications.freedesktop.org/autostart-spec/autostart-spec-latest.html).
'';
};
};
diff --git a/nixos/modules/config/xdg/icons.nix b/nixos/modules/config/xdg/icons.nix
index 1e91670cf03b..8d44a431445b 100644
--- a/nixos/modules/config/xdg/icons.nix
+++ b/nixos/modules/config/xdg/icons.nix
@@ -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
- XDG Icon Theme specification.
+ [XDG Icon Theme specification](https://specifications.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html).
'';
};
};
diff --git a/nixos/modules/config/xdg/menus.nix b/nixos/modules/config/xdg/menus.nix
index 6735a7a5c430..b8f829e81547 100644
--- a/nixos/modules/config/xdg/menus.nix
+++ b/nixos/modules/config/xdg/menus.nix
@@ -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
- XDG Desktop Menu specification.
+ [XDG Desktop Menu specification](https://specifications.freedesktop.org/menu-spec/menu-spec-latest.html).
'';
};
};
diff --git a/nixos/modules/config/xdg/sounds.nix b/nixos/modules/config/xdg/sounds.nix
index 0b94f550929b..713d68131fc0 100644
--- a/nixos/modules/config/xdg/sounds.nix
+++ b/nixos/modules/config/xdg/sounds.nix
@@ -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
- XDG Sound Theme specification.
+ [XDG Sound Theme specification](https://www.freedesktop.org/wiki/Specifications/sound-theme-spec/).
'';
};
};