diff --git a/nixos/maintainers/scripts/ec2/amazon-image.nix b/nixos/maintainers/scripts/ec2/amazon-image.nix
index 2d89db0a7f34..e2a05a09d0c2 100644
--- a/nixos/maintainers/scripts/ec2/amazon-image.nix
+++ b/nixos/maintainers/scripts/ec2/amazon-image.nix
@@ -23,7 +23,7 @@ in {
options.amazonImage = {
name = mkOption {
type = types.str;
- description = "The name of the generated derivation";
+ description = lib.mdDoc "The name of the generated derivation";
default = "nixos-amazon-image-${config.system.nixos.label}-${pkgs.stdenv.hostPlatform.system}";
};
@@ -35,7 +35,7 @@ in {
]
'';
default = [];
- description = ''
+ description = lib.mdDoc ''
This option lists files to be copied to fixed locations in the
generated image. Glob patterns work.
'';
@@ -45,13 +45,13 @@ in {
type = with types; either (enum [ "auto" ]) int;
default = if config.ec2.hvm then 2048 else 8192;
example = 8192;
- description = "The size in MB of the image";
+ description = lib.mdDoc "The size in MB of the image";
};
format = mkOption {
type = types.enum [ "raw" "qcow2" "vpc" ];
default = "vpc";
- description = "The image format to output";
+ description = lib.mdDoc "The image format to output";
};
};
diff --git a/nixos/modules/misc/documentation/test.nix b/nixos/modules/misc/documentation/test.nix
index 1eaa63b1fb6c..dd1588abdb43 100644
--- a/nixos/modules/misc/documentation/test.nix
+++ b/nixos/modules/misc/documentation/test.nix
@@ -30,7 +30,7 @@ let
specialArgs.someArg.myModule = { lib, ... }: {
options.foobar = lib.mkOption {
type = lib.types.str;
- description = "The foobar option was added via specialArgs";
+ description = lib.mdDoc "The foobar option was added via specialArgs";
default = "qux";
};
};
diff --git a/nixos/modules/programs/firejail.nix b/nixos/modules/programs/firejail.nix
index 1f8656b9585e..a98c15a04517 100644
--- a/nixos/modules/programs/firejail.nix
+++ b/nixos/modules/programs/firejail.nix
@@ -39,19 +39,19 @@ in {
options = {
executable = mkOption {
type = types.path;
- description = "Executable to run sandboxed";
+ description = lib.mdDoc "Executable to run sandboxed";
example = literalExpression ''"''${lib.getBin pkgs.firefox}/bin/firefox"'';
};
profile = mkOption {
type = types.nullOr types.path;
default = null;
- description = "Profile to use";
+ description = lib.mdDoc "Profile to use";
example = literalExpression ''"''${pkgs.firejail}/etc/firejail/firefox.profile"'';
};
extraArgs = mkOption {
type = types.listOf types.str;
default = [];
- description = "Extra arguments to pass to firejail";
+ description = lib.mdDoc "Extra arguments to pass to firejail";
example = [ "--private=~/.firejail_home" ];
};
};
diff --git a/nixos/modules/security/sudo.nix b/nixos/modules/security/sudo.nix
index 68ceb6c230eb..296b61fd703b 100644
--- a/nixos/modules/security/sudo.nix
+++ b/nixos/modules/security/sudo.nix
@@ -157,17 +157,17 @@ in
options = {
command = mkOption {
type = with types; str;
- description = ''
+ description = lib.mdDoc ''
A command being either just a path to a binary to allow any arguments,
- the full command with arguments pre-set or with "" used as the argument,
+ the full command with arguments pre-set or with `""` used as the argument,
not allowing arguments to the command at all.
'';
};
options = mkOption {
type = with types; listOf (enum [ "NOPASSWD" "PASSWD" "NOEXEC" "EXEC" "SETENV" "NOSETENV" "LOG_INPUT" "NOLOG_INPUT" "LOG_OUTPUT" "NOLOG_OUTPUT" ]);
- description = ''
- Options for running the command. Refer to the sudo manual.
+ description = lib.mdDoc ''
+ Options for running the command. Refer to the [sudo manual](https://www.sudo.ws/man/1.7.10/sudoers.man.html).
'';
default = [];
};
diff --git a/nixos/modules/services/hardware/sane_extra_backends/brscan4.nix b/nixos/modules/services/hardware/sane_extra_backends/brscan4.nix
index f01446c411ee..e737a4ce20de 100644
--- a/nixos/modules/services/hardware/sane_extra_backends/brscan4.nix
+++ b/nixos/modules/services/hardware/sane_extra_backends/brscan4.nix
@@ -68,8 +68,8 @@ in
options = {
hardware.sane.brscan4.enable =
- mkEnableOption "Brother's brscan4 scan backend" // {
- description = ''
+ mkEnableOption (lib.mdDoc "Brother's brscan4 scan backend") // {
+ description = lib.mdDoc ''
When enabled, will automatically register the "brscan4" sane
backend and bring configuration files to their expected location.
'';
diff --git a/nixos/modules/services/hardware/sane_extra_backends/dsseries.nix b/nixos/modules/services/hardware/sane_extra_backends/dsseries.nix
index d71a17f5ea6b..5b05694abc01 100644
--- a/nixos/modules/services/hardware/sane_extra_backends/dsseries.nix
+++ b/nixos/modules/services/hardware/sane_extra_backends/dsseries.nix
@@ -6,8 +6,8 @@ with lib;
options = {
hardware.sane.dsseries.enable =
- mkEnableOption "Brother DSSeries scan backend" // {
- description = ''
+ mkEnableOption (lib.mdDoc "Brother DSSeries scan backend") // {
+ description = lib.mdDoc ''
When enabled, will automatically register the "dsseries" SANE backend.
This supports the Brother DSmobile scanner series, including the
diff --git a/nixos/modules/services/mail/postgrey.nix b/nixos/modules/services/mail/postgrey.nix
index 301bc69e1cac..fdfa08946ddf 100644
--- a/nixos/modules/services/mail/postgrey.nix
+++ b/nixos/modules/services/mail/postgrey.nix
@@ -15,12 +15,12 @@ with lib; let
type = nullOr str;
default = null;
example = "127.0.0.1";
- description = "The address to bind to. Localhost if null";
+ description = lib.mdDoc "The address to bind to. Localhost if null";
};
port = mkOption {
type = natural';
default = 10030;
- description = "Tcp port to bind to";
+ description = lib.mdDoc "Tcp port to bind to";
};
};
};
@@ -30,13 +30,13 @@ with lib; let
path = mkOption {
type = path;
default = "/run/postgrey.sock";
- description = "Path of the unix socket";
+ description = lib.mdDoc "Path of the unix socket";
};
mode = mkOption {
type = str;
default = "0777";
- description = "Mode of the unix socket";
+ description = lib.mdDoc "Mode of the unix socket";
};
};
};
diff --git a/nixos/modules/services/mail/rspamd.nix b/nixos/modules/services/mail/rspamd.nix
index 8771b11901c7..f9be9024dd4f 100644
--- a/nixos/modules/services/mail/rspamd.nix
+++ b/nixos/modules/services/mail/rspamd.nix
@@ -13,24 +13,24 @@ let
socket = mkOption {
type = types.str;
example = "localhost:11333";
- description = ''
+ description = lib.mdDoc ''
Socket for this worker to listen on in a format acceptable by rspamd.
'';
};
mode = mkOption {
type = types.str;
default = "0644";
- description = "Mode to set on unix socket";
+ description = lib.mdDoc "Mode to set on unix socket";
};
owner = mkOption {
type = types.str;
default = "${cfg.user}";
- description = "Owner to set on unix socket";
+ description = lib.mdDoc "Owner to set on unix socket";
};
group = mkOption {
type = types.str;
default = "${cfg.group}";
- description = "Group to set on unix socket";
+ description = lib.mdDoc "Group to set on unix socket";
};
rawEntry = mkOption {
type = types.str;
diff --git a/nixos/modules/services/networking/flannel.nix b/nixos/modules/services/networking/flannel.nix
index e50b862371c4..c19e51e5aa6c 100644
--- a/nixos/modules/services/networking/flannel.nix
+++ b/nixos/modules/services/networking/flannel.nix
@@ -83,7 +83,7 @@ in {
};
network = mkOption {
- description = " IPv4 network in CIDR format to use for the entire flannel network.";
+ description = lib.mdDoc " IPv4 network in CIDR format to use for the entire flannel network.";
type = types.str;
};
diff --git a/nixos/modules/services/networking/i2pd.nix b/nixos/modules/services/networking/i2pd.nix
index 70fd4cb5fe5a..47f4a42aa5dd 100644
--- a/nixos/modules/services/networking/i2pd.nix
+++ b/nixos/modules/services/networking/i2pd.nix
@@ -247,8 +247,8 @@ in
services.i2pd = {
- enable = mkEnableOption "I2Pd daemon" // {
- description = ''
+ enable = mkEnableOption (lib.mdDoc "I2Pd daemon") // {
+ description = lib.mdDoc ''
Enables I2Pd as a running service upon activation.
Please read http://i2pd.readthedocs.io/en/latest/ for further
configuration help.
@@ -345,14 +345,14 @@ in
ntcp = mkEnableTrueOption "ntcp";
ssu = mkEnableTrueOption "ssu";
- notransit = mkEnableOption "notransit" // {
- description = ''
+ notransit = mkEnableOption (lib.mdDoc "notransit") // {
+ description = lib.mdDoc ''
Tells the router to not accept transit tunnels during startup.
'';
};
- floodfill = mkEnableOption "floodfill" // {
- description = ''
+ floodfill = mkEnableOption (lib.mdDoc "floodfill") // {
+ description = lib.mdDoc ''
If the router is declared to be unreachable and needs introduction nodes.
'';
};
diff --git a/nixos/modules/services/networking/smokeping.nix b/nixos/modules/services/networking/smokeping.nix
index 7f1abcc6824f..df4f8905ec6f 100644
--- a/nixos/modules/services/networking/smokeping.nix
+++ b/nixos/modules/services/networking/smokeping.nix
@@ -82,8 +82,10 @@ in
config = mkOption {
type = types.nullOr types.lines;
default = null;
- description = "Full smokeping config supplied by the user. Overrides " +
- "and replaces any other configuration supplied.";
+ description = lib.mdDoc ''
+ Full smokeping config supplied by the user. Overrides
+ and replaces any other configuration supplied.
+ '';
};
databaseConfig = mkOption {
type = types.lines;
diff --git a/nixos/modules/services/networking/x2goserver.nix b/nixos/modules/services/networking/x2goserver.nix
index e534a2a3dcac..1242229a0b60 100644
--- a/nixos/modules/services/networking/x2goserver.nix
+++ b/nixos/modules/services/networking/x2goserver.nix
@@ -23,15 +23,15 @@ in {
options.services.x2goserver = {
enable = mkEnableOption (lib.mdDoc "x2goserver") // {
- description = ''
+ description = lib.mdDoc ''
Enables the x2goserver module.
NOTE: This will create a good amount of symlinks in `/usr/local/bin`
'';
};
superenicer = {
- enable = mkEnableOption "superenicer" // {
- description = ''
+ enable = mkEnableOption (lib.mdDoc "superenicer") // {
+ description = lib.mdDoc ''
Enables the SupeReNicer code in x2gocleansessions, this will renice
suspended sessions to nice level 19 and renice them to level 0 if the
session becomes marked as running again
diff --git a/nixos/modules/services/security/certmgr.nix b/nixos/modules/services/security/certmgr.nix
index e2883856b6d4..ca4cf5084722 100644
--- a/nixos/modules/services/security/certmgr.nix
+++ b/nixos/modules/services/security/certmgr.nix
@@ -118,34 +118,34 @@ in
service = mkOption {
type = nullOr str;
default = null;
- description = "The service on which to perform <action> after fetching.";
+ description = lib.mdDoc "The service on which to perform \ after fetching.";
};
action = mkOption {
type = addCheck str (x: cfg.svcManager == "command" || elem x ["restart" "reload" "nop"]);
default = "nop";
- description = "The action to take after fetching.";
+ description = lib.mdDoc "The action to take after fetching.";
};
# These ought all to be specified according to certmgr spec def.
authority = mkOption {
type = attrs;
- description = "certmgr spec authority object.";
+ description = lib.mdDoc "certmgr spec authority object.";
};
certificate = mkOption {
type = nullOr attrs;
- description = "certmgr spec certificate object.";
+ description = lib.mdDoc "certmgr spec certificate object.";
};
private_key = mkOption {
type = nullOr attrs;
- description = "certmgr spec private_key object.";
+ description = lib.mdDoc "certmgr spec private_key object.";
};
request = mkOption {
type = nullOr attrs;
- description = "certmgr spec request object.";
+ description = lib.mdDoc "certmgr spec request object.";
};
};
}));
diff --git a/nixos/modules/services/security/tor.nix b/nixos/modules/services/security/tor.nix
index c5978f461a5a..de82e32f496f 100644
--- a/nixos/modules/services/security/tor.nix
+++ b/nixos/modules/services/security/tor.nix
@@ -51,14 +51,14 @@ let
type = with types; nullOr str;
default = null;
example = "0.0.0.0";
- description = ''
+ description = lib.mdDoc ''
IPv4 or IPv6 (if between brackets) address.
'';
};
optionUnix = mkOption {
type = with types; nullOr path;
default = null;
- description = ''
+ description = lib.mdDoc ''
Unix domain socket path to use.
'';
};
diff --git a/nixos/modules/services/web-apps/bookstack.nix b/nixos/modules/services/web-apps/bookstack.nix
index a20904d6af07..3fbccf540087 100644
--- a/nixos/modules/services/web-apps/bookstack.nix
+++ b/nixos/modules/services/web-apps/bookstack.nix
@@ -234,7 +234,7 @@ in {
options = {
_secret = mkOption {
type = nullOr str;
- description = ''
+ description = lib.mdDoc ''
The path to a file containing the value the
option should be set to in the final
configuration file.
diff --git a/nixos/modules/services/web-apps/healthchecks.nix b/nixos/modules/services/web-apps/healthchecks.nix
index e58cc6f202be..b3380b88f613 100644
--- a/nixos/modules/services/web-apps/healthchecks.nix
+++ b/nixos/modules/services/web-apps/healthchecks.nix
@@ -26,8 +26,8 @@ let
in
{
options.services.healthchecks = {
- enable = mkEnableOption "healthchecks" // {
- description = ''
+ enable = mkEnableOption (lib.mdDoc "healthchecks") // {
+ description = lib.mdDoc ''
Enable healthchecks.
It is expected to be run behind a HTTP reverse proxy.
'';
diff --git a/nixos/modules/services/web-apps/snipe-it.nix b/nixos/modules/services/web-apps/snipe-it.nix
index a97d6be69d96..264b72fe837b 100644
--- a/nixos/modules/services/web-apps/snipe-it.nix
+++ b/nixos/modules/services/web-apps/snipe-it.nix
@@ -250,7 +250,7 @@ in {
options = {
_secret = mkOption {
type = nullOr (oneOf [ str path ]);
- description = ''
+ description = lib.mdDoc ''
The path to a file containing the value the
option should be set to in the final
configuration file.
diff --git a/nixos/modules/services/x11/desktop-managers/phosh.nix b/nixos/modules/services/x11/desktop-managers/phosh.nix
index 2f670d3492e9..e889c0e34e7d 100644
--- a/nixos/modules/services/x11/desktop-managers/phosh.nix
+++ b/nixos/modules/services/x11/desktop-managers/phosh.nix
@@ -33,14 +33,14 @@ let
default = "false";
};
cursorTheme = mkOption {
- description = ''
+ description = lib.mdDoc ''
Cursor theme to use in Phosh.
'';
type = types.str;
default = "default";
};
outputs = mkOption {
- description = ''
+ description = lib.mdDoc ''
Output configurations.
'';
type = types.attrsOf phocOutputType;
@@ -56,7 +56,7 @@ let
phocOutputType = types.submodule {
options = {
modeline = mkOption {
- description = ''
+ description = lib.mdDoc ''
One or more modelines.
'';
type = types.either types.str (types.listOf types.str);
@@ -67,7 +67,7 @@ let
];
};
mode = mkOption {
- description = ''
+ description = lib.mdDoc ''
Default video mode.
'';
type = types.nullOr types.str;
@@ -75,7 +75,7 @@ let
example = "768x1024";
};
scale = mkOption {
- description = ''
+ description = lib.mdDoc ''
Display scaling factor.
'';
type = types.nullOr (
@@ -89,7 +89,7 @@ let
example = 2;
};
rotate = mkOption {
- description = ''
+ description = lib.mdDoc ''
Screen transformation.
'';
type = types.enum [
diff --git a/nixos/modules/services/x11/display-managers/sx.nix b/nixos/modules/services/x11/display-managers/sx.nix
index e30977364300..6a7fc1a040e7 100644
--- a/nixos/modules/services/x11/display-managers/sx.nix
+++ b/nixos/modules/services/x11/display-managers/sx.nix
@@ -7,8 +7,8 @@ let cfg = config.services.xserver.displayManager.sx;
in {
options = {
services.xserver.displayManager.sx = {
- enable = mkEnableOption "sx pseudo-display manager" // {
- description = ''
+ enable = mkEnableOption (lib.mdDoc "sx pseudo-display manager") // {
+ description = lib.mdDoc ''
Whether to enable the "sx" pseudo-display manager, which allows users
to start manually via the "sx" command from a vt shell. The X server
runs under the user's id, not as root. The user must provide a
diff --git a/nixos/modules/services/x11/xautolock.nix b/nixos/modules/services/x11/xautolock.nix
index b8ebd1a000e2..8200057660e5 100644
--- a/nixos/modules/services/x11/xautolock.nix
+++ b/nixos/modules/services/x11/xautolock.nix
@@ -9,8 +9,8 @@ in
options = {
services.xserver.xautolock = {
enable = mkEnableOption (lib.mdDoc "xautolock");
- enableNotifier = mkEnableOption "xautolock.notify" // {
- description = ''
+ enableNotifier = mkEnableOption (lib.mdDoc "xautolock.notify") // {
+ description = lib.mdDoc ''
Whether to enable the notifier feature of xautolock.
This publishes a notification before the autolock.
'';
diff --git a/nixos/modules/system/activation/activation-script.nix b/nixos/modules/system/activation/activation-script.nix
index f26b02b9324e..f2c5775eeafc 100644
--- a/nixos/modules/system/activation/activation-script.nix
+++ b/nixos/modules/system/activation/activation-script.nix
@@ -78,11 +78,11 @@ let
{ deps = mkOption
{ type = types.listOf types.str;
default = [ ];
- description = "List of dependencies. The script will run after these.";
+ description = lib.mdDoc "List of dependencies. The script will run after these.";
};
text = mkOption
{ type = types.lines;
- description = "The content of the script.";
+ description = lib.mdDoc "The content of the script.";
};
} // optionalAttrs withDry {
supportsDryActivation = mkOption
diff --git a/nixos/modules/tasks/bcache.nix b/nixos/modules/tasks/bcache.nix
index 0a13522de11f..408ddc02373f 100644
--- a/nixos/modules/tasks/bcache.nix
+++ b/nixos/modules/tasks/bcache.nix
@@ -1,7 +1,7 @@
{ config, lib, pkgs, ... }:
{
- options.boot.initrd.services.bcache.enable = (lib.mkEnableOption "bcache support in the initrd") // {
+ options.boot.initrd.services.bcache.enable = (lib.mkEnableOption (lib.mdDoc "bcache support in the initrd")) // {
visible = false; # only works with systemd stage 1
};
diff --git a/nixos/modules/tasks/lvm.nix b/nixos/modules/tasks/lvm.nix
index 405cae15b2ea..760133fafa29 100644
--- a/nixos/modules/tasks/lvm.nix
+++ b/nixos/modules/tasks/lvm.nix
@@ -21,7 +21,7 @@ in {
boot.vdo.enable = mkEnableOption (lib.mdDoc "support for booting from VDOLVs");
};
- options.boot.initrd.services.lvm.enable = (mkEnableOption "enable booting from LVM2 in the initrd") // {
+ options.boot.initrd.services.lvm.enable = (mkEnableOption (lib.mdDoc "enable booting from LVM2 in the initrd")) // {
visible = false;
};
diff --git a/nixos/modules/tasks/swraid.nix b/nixos/modules/tasks/swraid.nix
index 26d6bd914d5e..7832bbf92016 100644
--- a/nixos/modules/tasks/swraid.nix
+++ b/nixos/modules/tasks/swraid.nix
@@ -5,7 +5,7 @@
in {
options.boot.initrd.services.swraid = {
- enable = (lib.mkEnableOption "swraid support using mdadm") // {
+ enable = (lib.mkEnableOption (lib.mdDoc "swraid support using mdadm")) // {
visible = false; # only has effect when the new stage 1 is in place
};
diff --git a/nixos/modules/virtualisation/lxc-container.nix b/nixos/modules/virtualisation/lxc-container.nix
index d3a2e0ed151d..f05f04baa35d 100644
--- a/nixos/modules/virtualisation/lxc-container.nix
+++ b/nixos/modules/virtualisation/lxc-container.nix
@@ -5,22 +5,22 @@ with lib;
let
templateSubmodule = { ... }: {
options = {
- enable = mkEnableOption "this template";
+ enable = mkEnableOption (lib.mdDoc "this template");
target = mkOption {
- description = "Path in the container";
+ description = lib.mdDoc "Path in the container";
type = types.path;
};
template = mkOption {
- description = ".tpl file for rendering the target";
+ description = lib.mdDoc ".tpl file for rendering the target";
type = types.path;
};
when = mkOption {
- description = "Events which trigger a rewrite (create, copy)";
+ description = lib.mdDoc "Events which trigger a rewrite (create, copy)";
type = types.listOf (types.str);
};
properties = mkOption {
- description = "Additional properties";
+ description = lib.mdDoc "Additional properties";
type = types.attrs;
default = {};
};
@@ -58,7 +58,7 @@ in
options = {
virtualisation.lxc = {
templates = mkOption {
- description = "Templates for LXD";
+ description = lib.mdDoc "Templates for LXD";
type = types.attrsOf (types.submodule (templateSubmodule));
default = {};
example = literalExpression ''
diff --git a/nixos/modules/virtualisation/proxmox-lxc.nix b/nixos/modules/virtualisation/proxmox-lxc.nix
index 9b9f99e5b817..3d966d725a9a 100644
--- a/nixos/modules/virtualisation/proxmox-lxc.nix
+++ b/nixos/modules/virtualisation/proxmox-lxc.nix
@@ -7,14 +7,14 @@ with lib;
privileged = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Whether to enable privileged mounts
'';
};
manageNetwork = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Whether to manage network interfaces through nix options
When false, systemd-networkd is enabled to accept network
configuration from proxmox.
@@ -23,7 +23,7 @@ with lib;
manageHostName = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Whether to manage hostname through nix options
When false, the hostname is picked up from /etc/hostname
populated by proxmox.
diff --git a/nixos/tests/systemd-confinement.nix b/nixos/tests/systemd-confinement.nix
index bde5b770ea50..428888d41a20 100644
--- a/nixos/tests/systemd-confinement.nix
+++ b/nixos/tests/systemd-confinement.nix
@@ -153,7 +153,7 @@ import ./make-test-python.nix {
options.__testSteps = lib.mkOption {
type = lib.types.lines;
- description = "All of the test steps combined as a single script.";
+ description = lib.mdDoc "All of the test steps combined as a single script.";
};
config.environment.systemPackages = lib.singleton testClient;