From 6039648c50c7c0858b5e506c6298773a98e0f066 Mon Sep 17 00:00:00 2001
From: pennae <github@quasiparticle.net>
Date: Mon, 15 Aug 2022 07:16:25 +0200
Subject: [PATCH] nixos/*: automatically convert option docs
---
nixos/modules/config/krb5/default.nix | 8 ++--
nixos/modules/config/ldap.nix | 10 ++--
nixos/modules/config/system-path.nix | 10 ++--
nixos/modules/config/xdg/portal.nix | 6 +--
nixos/modules/config/xdg/portals/lxqt.nix | 4 +-
nixos/modules/config/xdg/portals/wlr.nix | 6 +--
nixos/modules/config/zram.nix | 10 ++--
nixos/modules/hardware/cpu/amd-sev.nix | 6 +--
nixos/modules/installer/sd-card/sd-image.nix | 26 +++++------
nixos/modules/misc/documentation.nix | 2 +-
nixos/modules/misc/nixpkgs.nix | 20 ++++----
nixos/modules/programs/captive-browser.nix | 6 +--
nixos/modules/programs/chromium.nix | 4 +-
nixos/modules/programs/k3b.nix | 14 +++---
nixos/modules/programs/ssh.nix | 8 ++--
nixos/modules/programs/tsm-client.nix | 10 ++--
nixos/modules/security/pam.nix | 6 +--
.../modules/services/cluster/hadoop/hbase.nix | 18 ++++----
.../buildbot/worker.nix | 2 +-
.../hercules-ci-agent/common.nix | 18 ++++----
.../continuous-integration/hydra/default.nix | 4 +-
.../services/databases/foundationdb.nix | 4 +-
nixos/modules/services/databases/mongodb.nix | 2 +-
nixos/modules/services/databases/mysql.nix | 2 +-
.../modules/services/databases/postgresql.nix | 6 +--
.../services/development/jupyter/default.nix | 2 +-
nixos/modules/services/games/asf.nix | 10 ++--
.../home-automation/home-assistant.nix | 4 +-
nixos/modules/services/mail/postfix.nix | 36 +++++++--------
nixos/modules/services/matrix/dendrite.nix | 18 ++++----
.../modules/services/misc/etebase-server.nix | 8 ++--
nixos/modules/services/misc/exhibitor.nix | 2 +-
nixos/modules/services/misc/freeswitch.nix | 10 ++--
nixos/modules/services/misc/geoipupdate.nix | 18 ++++----
nixos/modules/services/misc/gitea.nix | 10 ++--
nixos/modules/services/misc/gitlab.nix | 6 +--
nixos/modules/services/misc/gitolite.nix | 26 +++++------
nixos/modules/services/misc/nix-daemon.nix | 18 ++++----
.../services/monitoring/grafana-agent.nix | 4 +-
.../monitoring/grafana-image-renderer.nix | 10 ++--
.../services/monitoring/mackerel-agent.nix | 4 +-
nixos/modules/services/monitoring/nagios.nix | 10 ++--
.../monitoring/prometheus/default.nix | 10 ++--
.../monitoring/prometheus/exporters/knot.nix | 4 +-
.../prometheus/exporters/openldap.nix | 8 ++--
.../network-filesystems/yandex-disk.nix | 2 +-
nixos/modules/services/networking/bind.nix | 18 ++++----
.../modules/services/networking/create_ap.nix | 6 +--
.../networking/firefox-syncserver.nix | 46 +++++++++----------
.../services/networking/ghostunnel.nix | 6 +--
.../services/networking/hylafax/options.nix | 4 +-
.../networking/ircd-hybrid/default.nix | 16 +++----
nixos/modules/services/networking/kresd.nix | 2 +-
nixos/modules/services/networking/mxisd.nix | 4 +-
nixos/modules/services/networking/resilio.nix | 16 +++----
nixos/modules/services/networking/v2ray.nix | 6 +--
.../modules/services/networking/yggdrasil.nix | 16 +++----
nixos/modules/services/security/haka.nix | 2 +-
.../services/security/oauth2_proxy.nix | 4 +-
.../modules/services/security/privacyidea.nix | 8 ++--
nixos/modules/services/web-apps/discourse.nix | 14 +++---
nixos/modules/services/web-apps/hedgedoc.nix | 14 +++---
nixos/modules/services/web-apps/invidious.nix | 6 +--
nixos/modules/services/web-apps/isso.nix | 6 +--
nixos/modules/services/web-apps/mastodon.nix | 12 ++---
nixos/modules/services/web-apps/moodle.nix | 2 +-
nixos/modules/services/web-apps/nextcloud.nix | 6 +--
.../services/web-apps/pgpkeyserver-lite.nix | 8 ++--
nixos/modules/services/web-apps/plausible.nix | 8 ++--
.../modules/services/web-apps/rss-bridge.nix | 4 +-
nixos/modules/services/web-apps/wiki-js.nix | 6 +--
.../services/web-servers/nginx/default.nix | 34 +++++++-------
.../web-servers/nginx/vhost-options.nix | 8 ++--
nixos/modules/services/web-servers/tomcat.nix | 2 +-
.../services/web-servers/varnish/default.nix | 10 ++--
.../services/x11/desktop-managers/none.nix | 10 ++--
nixos/modules/system/boot/luksroot.nix | 4 +-
nixos/modules/tasks/auto-upgrade.nix | 4 +-
nixos/modules/tasks/filesystems.nix | 22 ++++-----
nixos/modules/virtualisation/azure-image.nix | 2 +-
.../virtualisation/google-compute-image.nix | 4 +-
nixos/modules/virtualisation/hyperv-image.nix | 6 +--
nixos/modules/virtualisation/kvmgt.nix | 8 ++--
nixos/modules/virtualisation/lxc.nix | 4 +-
.../virtualisation/nixos-containers.nix | 10 ++--
.../virtualisation/podman/network-socket.nix | 6 +--
.../modules/virtualisation/proxmox-image.nix | 26 +++++------
nixos/modules/virtualisation/qemu-vm.nix | 8 ++--
nixos/modules/virtualisation/vmware-image.nix | 10 ++--
89 files changed, 425 insertions(+), 425 deletions(-)
diff --git a/nixos/modules/config/krb5/default.nix b/nixos/modules/config/krb5/default.nix
index db5321f176c8..4c80f87a498d 100644
--- a/nixos/modules/config/krb5/default.nix
+++ b/nixos/modules/config/krb5/default.nix
@@ -204,10 +204,10 @@ in {
admin_server = SYSLOG:NOTICE
default = SYSLOG:NOTICE
'';
- description = ''
- These lines go to the end of <literal>krb5.conf</literal> verbatim.
- <literal>krb5.conf</literal> may include any of the relations that are
- valid for <literal>kdc.conf</literal> (see <literal>man kdc.conf</literal>),
+ description = lib.mdDoc ''
+ These lines go to the end of `krb5.conf` verbatim.
+ `krb5.conf` may include any of the relations that are
+ valid for `kdc.conf` (see `man kdc.conf`),
but it is not a recommended practice.
'';
};
diff --git a/nixos/modules/config/ldap.nix b/nixos/modules/config/ldap.nix
index b0d12b2f8191..799d60e0103e 100644
--- a/nixos/modules/config/ldap.nix
+++ b/nixos/modules/config/ldap.nix
@@ -186,16 +186,16 @@ in
policy = mkOption {
default = "hard_open";
type = types.enum [ "hard_open" "hard_init" "soft" ];
- description = ''
+ description = lib.mdDoc ''
Specifies the policy to use for reconnecting to an unavailable
- LDAP server. The default is <literal>hard_open</literal>, which
+ LDAP server. The default is `hard_open`, which
reconnects if opening the connection to the directory server
- failed. By contrast, <literal>hard_init</literal> reconnects if
+ failed. By contrast, `hard_init` reconnects if
initializing the connection failed. Initializing may not
actually contact the directory server, and it is possible that
a malformed configuration file will trigger reconnection. If
- <literal>soft</literal> is specified, then
- <literal>nss_ldap</literal> will return immediately on server
+ `soft` is specified, then
+ `nss_ldap` will return immediately on server
failure. All hard reconnect policies block with exponential
backoff before retrying.
'';
diff --git a/nixos/modules/config/system-path.nix b/nixos/modules/config/system-path.nix
index 6bc0f6e353ef..b2d546b721de 100644
--- a/nixos/modules/config/system-path.nix
+++ b/nixos/modules/config/system-path.nix
@@ -84,19 +84,19 @@ in
<programlisting>${defaultPackagesText}</programlisting>
'';
example = [];
- description = ''
+ description = lib.mdDoc ''
Set of default packages that aren't strictly necessary
for a running system, entries can be removed for a more
minimal NixOS installation.
- Note: If <literal>pkgs.nano</literal> is removed from this list,
+ Note: If `pkgs.nano` is removed from this list,
make sure another editor is installed and the
- <literal>EDITOR</literal> environment variable is set to it.
+ `EDITOR` environment variable is set to it.
Environment variables can be set using
- <option>environment.variables</option>.
+ {option}`environment.variables`.
Like with systemPackages, packages are installed to
- <filename>/run/current-system/sw</filename>. They are
+ {file}`/run/current-system/sw`. They are
automatically available to all users, and are
automatically updated every time you rebuild the system
configuration.
diff --git a/nixos/modules/config/xdg/portal.nix b/nixos/modules/config/xdg/portal.nix
index 132700747c37..079b3385f8f7 100644
--- a/nixos/modules/config/xdg/portal.nix
+++ b/nixos/modules/config/xdg/portal.nix
@@ -40,12 +40,12 @@ in
extraPortals = mkOption {
type = types.listOf types.package;
default = [ ];
- description = ''
+ description = lib.mdDoc ''
List of additional portals to add to path. Portals allow interaction
with system, like choosing files or taking screenshots. At minimum,
a desktop portal implementation should be listed. GNOME and KDE already
- adds <literal>xdg-desktop-portal-gtk</literal>; and
- <literal>xdg-desktop-portal-kde</literal> respectively. On other desktop
+ adds `xdg-desktop-portal-gtk`; and
+ `xdg-desktop-portal-kde` respectively. On other desktop
environments you probably want to add them yourself.
'';
};
diff --git a/nixos/modules/config/xdg/portals/lxqt.nix b/nixos/modules/config/xdg/portals/lxqt.nix
index 21b2440d3d3c..4cc6c193e7cd 100644
--- a/nixos/modules/config/xdg/portals/lxqt.nix
+++ b/nixos/modules/config/xdg/portals/lxqt.nix
@@ -29,9 +29,9 @@ in
pkgs.qtcurve
];
'';
- description = ''
+ description = lib.mdDoc ''
Extra Qt styles that will be available to the
- <literal>lxqt.xdg-desktop-portal-lxqt</literal>.
+ `lxqt.xdg-desktop-portal-lxqt`.
'';
};
};
diff --git a/nixos/modules/config/xdg/portals/wlr.nix b/nixos/modules/config/xdg/portals/wlr.nix
index 2369a1aecebe..d8cbc68b1d6e 100644
--- a/nixos/modules/config/xdg/portals/wlr.nix
+++ b/nixos/modules/config/xdg/portals/wlr.nix
@@ -23,10 +23,10 @@ in
'';
settings = mkOption {
- description = ''
- Configuration for <literal>xdg-desktop-portal-wlr</literal>.
+ description = lib.mdDoc ''
+ Configuration for `xdg-desktop-portal-wlr`.
- See <literal>xdg-desktop-portal-wlr(5)</literal> for supported
+ See `xdg-desktop-portal-wlr(5)` for supported
values.
'';
diff --git a/nixos/modules/config/zram.nix b/nixos/modules/config/zram.nix
index e8e3fff01e08..b162fbc311e3 100644
--- a/nixos/modules/config/zram.nix
+++ b/nixos/modules/config/zram.nix
@@ -103,12 +103,12 @@ in
default = "zstd";
example = "lz4";
type = with types; either (enum [ "lzo" "lz4" "zstd" ]) str;
- description = ''
- Compression algorithm. <literal>lzo</literal> has good compression,
- but is slow. <literal>lz4</literal> has bad compression, but is fast.
- <literal>zstd</literal> is both good compression and fast, but requires newer kernel.
+ description = lib.mdDoc ''
+ Compression algorithm. `lzo` has good compression,
+ but is slow. `lz4` has bad compression, but is fast.
+ `zstd` is both good compression and fast, but requires newer kernel.
You can check what other algorithms are supported by your zram device with
- <command>cat /sys/class/block/zram*/comp_algorithm</command>
+ {command}`cat /sys/class/block/zram*/comp_algorithm`
'';
};
};
diff --git a/nixos/modules/hardware/cpu/amd-sev.nix b/nixos/modules/hardware/cpu/amd-sev.nix
index 32fed2c484d4..678b98e51355 100644
--- a/nixos/modules/hardware/cpu/amd-sev.nix
+++ b/nixos/modules/hardware/cpu/amd-sev.nix
@@ -8,17 +8,17 @@ in
options.hardware.cpu.amd.sev = {
enable = mkEnableOption "access to the AMD SEV device";
user = mkOption {
- description = "Owner to assign to the SEV device.";
+ description = lib.mdDoc "Owner to assign to the SEV device.";
type = types.str;
default = "root";
};
group = mkOption {
- description = "Group to assign to the SEV device.";
+ description = lib.mdDoc "Group to assign to the SEV device.";
type = types.str;
default = defaultGroup;
};
mode = mkOption {
- description = "Mode to set for the SEV device.";
+ description = lib.mdDoc "Mode to set for the SEV device.";
type = types.str;
default = "0660";
};
diff --git a/nixos/modules/installer/sd-card/sd-image.nix b/nixos/modules/installer/sd-card/sd-image.nix
index c0335ea48759..e192312649e2 100644
--- a/nixos/modules/installer/sd-card/sd-image.nix
+++ b/nixos/modules/installer/sd-card/sd-image.nix
@@ -35,14 +35,14 @@ in
options.sdImage = {
imageName = mkOption {
default = "${config.sdImage.imageBaseName}-${config.system.nixos.label}-${pkgs.stdenv.hostPlatform.system}.img";
- description = ''
+ description = lib.mdDoc ''
Name of the generated image file.
'';
};
imageBaseName = mkOption {
default = "nixos-sd-image";
- description = ''
+ description = lib.mdDoc ''
Prefix of the name of the generated image file.
'';
};
@@ -50,7 +50,7 @@ in
storePaths = mkOption {
type = with types; listOf package;
example = literalExpression "[ pkgs.stdenv ]";
- description = ''
+ description = lib.mdDoc ''
Derivations to be included in the Nix store in the generated SD image.
'';
};
@@ -74,7 +74,7 @@ in
firmwarePartitionID = mkOption {
type = types.str;
default = "0x2178694e";
- description = ''
+ description = lib.mdDoc ''
Volume ID for the /boot/firmware partition on the SD card. This value
must be a 32-bit hexadecimal number.
'';
@@ -83,7 +83,7 @@ in
firmwarePartitionName = mkOption {
type = types.str;
default = "FIRMWARE";
- description = ''
+ description = lib.mdDoc ''
Name of the filesystem which holds the boot firmware.
'';
};
@@ -92,7 +92,7 @@ in
type = types.nullOr types.str;
default = null;
example = "14e19a7b-0ae0-484d-9d54-43bd6fdc20c7";
- description = ''
+ description = lib.mdDoc ''
UUID for the filesystem on the main NixOS partition on the SD card.
'';
};
@@ -101,14 +101,14 @@ in
type = types.int;
# As of 2019-08-18 the Raspberry pi firmware + u-boot takes ~18MiB
default = 30;
- description = ''
+ description = lib.mdDoc ''
Size of the /boot/firmware partition, in megabytes.
'';
};
populateFirmwareCommands = mkOption {
example = literalExpression "'' cp \${pkgs.myBootLoader}/u-boot.bin firmware/ ''";
- description = ''
+ description = lib.mdDoc ''
Shell commands to populate the ./firmware directory.
All files in that directory are copied to the
/boot/firmware partition on the SD image.
@@ -117,7 +117,7 @@ in
populateRootCommands = mkOption {
example = literalExpression "''\${config.boot.loader.generic-extlinux-compatible.populateCmd} -c \${config.system.build.toplevel} -d ./files/boot''";
- description = ''
+ description = lib.mdDoc ''
Shell commands to populate the ./files directory.
All files in that directory are copied to the
root (/) partition on the SD image. Use this to
@@ -128,7 +128,7 @@ in
postBuildCommands = mkOption {
example = literalExpression "'' dd if=\${pkgs.myBootLoader}/SPL of=$img bs=1024 seek=1 conv=notrunc ''";
default = "";
- description = ''
+ description = lib.mdDoc ''
Shell commands to run after the image is built.
Can be used for boards requiring to dd u-boot SPL before actual partitions.
'';
@@ -137,16 +137,16 @@ in
compressImage = mkOption {
type = types.bool;
default = true;
- description = ''
+ description = lib.mdDoc ''
Whether the SD image should be compressed using
- <command>zstd</command>.
+ {command}`zstd`.
'';
};
expandOnBoot = mkOption {
type = types.bool;
default = true;
- description = ''
+ description = lib.mdDoc ''
Whether to configure the sd image to expand it's partition on boot.
'';
};
diff --git a/nixos/modules/misc/documentation.nix b/nixos/modules/misc/documentation.nix
index 5fb1ca4c4f59..251a361a580c 100644
--- a/nixos/modules/misc/documentation.nix
+++ b/nixos/modules/misc/documentation.nix
@@ -241,7 +241,7 @@ in
nixos.extraModules = mkOption {
type = types.listOf types.raw;
default = [];
- description = ''
+ description = lib.mdDoc ''
Modules for which to show options even when not imported.
'';
};
diff --git a/nixos/modules/misc/nixpkgs.nix b/nixos/modules/misc/nixpkgs.nix
index 721a041a5830..127f37b0df04 100644
--- a/nixos/modules/misc/nixpkgs.nix
+++ b/nixos/modules/misc/nixpkgs.nix
@@ -117,13 +117,13 @@ in
'';
type = pkgsType;
example = literalExpression "import <nixpkgs> {}";
- description = ''
+ description = lib.mdDoc ''
If set, the pkgs argument to all NixOS modules is the value of
- this option, extended with <literal>nixpkgs.overlays</literal>, if
- that is also set. Either <literal>nixpkgs.crossSystem</literal> or
- <literal>nixpkgs.localSystem</literal> will be used in an assertion
+ this option, extended with `nixpkgs.overlays`, if
+ that is also set. Either `nixpkgs.crossSystem` or
+ `nixpkgs.localSystem` will be used in an assertion
to check that the NixOS and Nixpkgs architectures match. Any
- other options in <literal>nixpkgs.*</literal>, notably <literal>config</literal>,
+ other options in `nixpkgs.*`, notably `config`,
will be ignored.
If unset, the pkgs argument to all NixOS modules is determined
@@ -132,18 +132,18 @@ in
The default value imports the Nixpkgs source files
relative to the location of this NixOS module, because
NixOS and Nixpkgs are distributed together for consistency,
- so the <literal>nixos</literal> in the default value is in fact a
- relative path. The <literal>config</literal>, <literal>overlays</literal>,
- <literal>localSystem</literal>, and <literal>crossSystem</literal> come
+ so the `nixos` in the default value is in fact a
+ relative path. The `config`, `overlays`,
+ `localSystem`, and `crossSystem` come
from this option's siblings.
This option can be used by applications like NixOps to increase
the performance of evaluation, or to create packages that depend
on a container that should be built with the exact same evaluation
of Nixpkgs, for example. Applications like this should set
- their default value using <literal>lib.mkDefault</literal>, so
+ their default value using `lib.mkDefault`, so
user-provided configuration can override it without using
- <literal>lib</literal>.
+ `lib`.
Note that using a distinct version of Nixpkgs with NixOS may
be an unexpected source of problems. Use this option with care.
diff --git a/nixos/modules/programs/captive-browser.nix b/nixos/modules/programs/captive-browser.nix
index 40eb7f5d66fd..fd8400315af1 100644
--- a/nixos/modules/programs/captive-browser.nix
+++ b/nixos/modules/programs/captive-browser.nix
@@ -85,9 +85,9 @@ in
bindInterface = mkOption {
default = true;
type = types.bool;
- description = ''
- Binds <literal>captive-browser</literal> to the network interface declared in
- <literal>cfg.interface</literal>. This can be used to avoid collisions
+ description = lib.mdDoc ''
+ Binds `captive-browser` to the network interface declared in
+ `cfg.interface`. This can be used to avoid collisions
with private subnets.
'';
};
diff --git a/nixos/modules/programs/chromium.nix b/nixos/modules/programs/chromium.nix
index 5e2e0b5741b6..58ead42daf55 100644
--- a/nixos/modules/programs/chromium.nix
+++ b/nixos/modules/programs/chromium.nix
@@ -76,10 +76,10 @@ in
extraOpts = mkOption {
type = types.attrs;
- description = ''
+ description = lib.mdDoc ''
Extra chromium policy options. A list of available policies
can be found in the Chrome Enterprise documentation:
- <link xlink:href="https://cloud.google.com/docs/chrome-enterprise/policies/"/>
+ <https://cloud.google.com/docs/chrome-enterprise/policies/>
Make sure the selected policy is supported on Linux and your browser version.
'';
default = {};
diff --git a/nixos/modules/programs/k3b.nix b/nixos/modules/programs/k3b.nix
index 1ea4204a3eb3..cdaed3cf70fb 100644
--- a/nixos/modules/programs/k3b.nix
+++ b/nixos/modules/programs/k3b.nix
@@ -8,15 +8,15 @@ with lib;
enable = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Whether to enable k3b, the KDE disk burning application.
- Additionally to installing <literal>k3b</literal> enabling this will
- add <literal>setuid</literal> wrappers in <literal>/run/wrappers/bin</literal>
- for both <literal>cdrdao</literal> and <literal>cdrecord</literal>. On first
- run you must manually configure the path of <literal>cdrdae</literal> and
- <literal>cdrecord</literal> to correspond to the appropriate paths under
- <literal>/run/wrappers/bin</literal> in the "Setup External Programs" menu.
+ Additionally to installing `k3b` enabling this will
+ add `setuid` wrappers in `/run/wrappers/bin`
+ for both `cdrdao` and `cdrecord`. On first
+ run you must manually configure the path of `cdrdae` and
+ `cdrecord` to correspond to the appropriate paths under
+ `/run/wrappers/bin` in the "Setup External Programs" menu.
'';
};
};
diff --git a/nixos/modules/programs/ssh.nix b/nixos/modules/programs/ssh.nix
index 9c4a95ef22c6..865c0becdbcf 100644
--- a/nixos/modules/programs/ssh.nix
+++ b/nixos/modules/programs/ssh.nix
@@ -93,10 +93,10 @@ in
extraConfig = mkOption {
type = types.lines;
default = "";
- description = ''
- Extra configuration text prepended to <filename>ssh_config</filename>. Other generated
- options will be added after a <literal>Host *</literal> pattern.
- See <citerefentry><refentrytitle>ssh_config</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+ description = lib.mdDoc ''
+ Extra configuration text prepended to {file}`ssh_config`. Other generated
+ options will be added after a `Host *` pattern.
+ See {manpage}`ssh_config(5)`
for help.
'';
};
diff --git a/nixos/modules/programs/tsm-client.nix b/nixos/modules/programs/tsm-client.nix
index 0a3af3744a78..cdd70b7744ba 100644
--- a/nixos/modules/programs/tsm-client.nix
+++ b/nixos/modules/programs/tsm-client.nix
@@ -95,13 +95,13 @@ let
exclude.dir /nix/store
include.encrypt /home/.../*
'';
- description = ''
- <literal>include.*</literal> and
- <literal>exclude.*</literal> directives to be
+ description = lib.mdDoc ''
+ `include.*` and
+ `exclude.*` directives to be
used when sending files to the IBM TSM server.
The lines will be written into a file that the
- <literal>inclexcl</literal>
- directive in <filename>dsm.sys</filename> points to.
+ `inclexcl`
+ directive in {file}`dsm.sys` points to.
'';
};
options.extraConfig = mkOption {
diff --git a/nixos/modules/security/pam.nix b/nixos/modules/security/pam.nix
index ca71a5b9c15e..94b59c83d4a7 100644
--- a/nixos/modules/security/pam.nix
+++ b/nixos/modules/security/pam.nix
@@ -320,10 +320,10 @@ let
limits = mkOption {
default = [];
type = limitsType;
- description = ''
+ description = lib.mdDoc ''
Attribute set describing resource limits. Defaults to the
- value of <option>security.pam.loginLimits</option>.
- The meaning of the values is explained in <citerefentry><refentrytitle>limits.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+ value of {option}`security.pam.loginLimits`.
+ The meaning of the values is explained in {manpage}`limits.conf(5)`.
'';
};
diff --git a/nixos/modules/services/cluster/hadoop/hbase.nix b/nixos/modules/services/cluster/hadoop/hbase.nix
index 246775dc8987..8fd40459c19d 100644
--- a/nixos/modules/services/cluster/hadoop/hbase.nix
+++ b/nixos/modules/services/cluster/hadoop/hbase.nix
@@ -21,7 +21,7 @@ in
"hbase.cluster.distributed" = "true";
};
type = types.attrsOf types.anything;
- description = ''
+ description = lib.mdDoc ''
Default options for hbase-site.xml
'';
};
@@ -30,9 +30,9 @@ in
type = with types; attrsOf anything;
example = literalExpression ''
'';
- description = ''
+ description = lib.mdDoc ''
Additional options and overrides for hbase-site.xml
- <link xlink:href="https://github.com/apache/hbase/blob/rel/2.4.11/hbase-common/src/main/resources/hbase-default.xml"/>
+ <https://github.com/apache/hbase/blob/rel/2.4.11/hbase-common/src/main/resources/hbase-default.xml>
'';
};
hbaseSiteInternal = mkOption {
@@ -50,11 +50,11 @@ in
type = types.package;
default = pkgs.hbase;
defaultText = literalExpression "pkgs.hbase";
- description = "HBase package";
+ description = lib.mdDoc "HBase package";
};
rootdir = mkOption {
- description = ''
+ description = lib.mdDoc ''
This option will set "hbase.rootdir" in hbase-site.xml and determine
the directory shared by region servers and into which HBase persists.
The URL should be 'fully-qualified' to include the filesystem scheme.
@@ -68,7 +68,7 @@ in
default = "/hbase";
};
zookeeperQuorum = mkOption {
- description = ''
+ description = lib.mdDoc ''
This option will set "hbase.zookeeper.quorum" in hbase-site.xml.
Comma separated list of servers in the ZooKeeper ensemble.
'';
@@ -83,7 +83,7 @@ in
openFirewall = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Open firewall ports for HBase master.
'';
};
@@ -94,7 +94,7 @@ in
overrideHosts = mkOption {
type = types.bool;
default = true;
- description = ''
+ description = lib.mdDoc ''
Remove /etc/hosts entries for "127.0.0.2" and "::1" defined in nixos/modules/config/networking.nix
Regionservers must be able to resolve their hostnames to their IP addresses, through PTR records
or /etc/hosts entries.
@@ -105,7 +105,7 @@ in
openFirewall = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Open firewall ports for HBase master.
'';
};
diff --git a/nixos/modules/services/continuous-integration/buildbot/worker.nix b/nixos/modules/services/continuous-integration/buildbot/worker.nix
index 513be78d485b..52c41c4a7584 100644
--- a/nixos/modules/services/continuous-integration/buildbot/worker.nix
+++ b/nixos/modules/services/continuous-integration/buildbot/worker.nix
@@ -121,7 +121,7 @@ in {
keepalive = mkOption {
default = 600;
type = types.int;
- description = ''
+ description = lib.mdDoc ''
This is a number that indicates how frequently keepalive messages should be sent
from the worker to the buildmaster, expressed in seconds.
'';
diff --git a/nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix b/nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix
index 7437242043ea..83518344b36b 100644
--- a/nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix
+++ b/nixos/modules/services/continuous-integration/hercules-ci-agent/common.nix
@@ -103,15 +103,15 @@ let
defaultText = literalExpression ''baseDirectory + "/secrets"'';
};
clusterJoinTokenPath = mkOption {
- description = ''
+ description = lib.mdDoc ''
Location of the cluster-join-token.key file.
You can retrieve the contents of the file when creating a new agent via
- <link xlink:href="https://hercules-ci.com/dashboard"/>.
+ <https://hercules-ci.com/dashboard>.
As this value is confidential, it should not be in the store, but
installed using other means, such as agenix, NixOps
- <literal>deployment.keys</literal>, or manual installation.
+ `deployment.keys`, or manual installation.
The contents of the file are used for authentication between the agent and the API.
'';
@@ -120,28 +120,28 @@ let
defaultText = literalExpression ''staticSecretsDirectory + "/cluster-join-token.key"'';
};
binaryCachesPath = mkOption {
- description = ''
+ description = lib.mdDoc ''
Path to a JSON file containing binary cache secret keys.
As these values are confidential, they should not be in the store, but
copied over using other means, such as agenix, NixOps
- <literal>deployment.keys</literal>, or manual installation.
+ `deployment.keys`, or manual installation.
- The format is described on <link xlink:href="https://docs.hercules-ci.com/hercules-ci-agent/binary-caches-json/"/>.
+ The format is described on <https://docs.hercules-ci.com/hercules-ci-agent/binary-caches-json/>.
'';
type = types.path;
default = config.staticSecretsDirectory + "/binary-caches.json";
defaultText = literalExpression ''staticSecretsDirectory + "/binary-caches.json"'';
};
secretsJsonPath = mkOption {
- description = ''
+ description = lib.mdDoc ''
Path to a JSON file containing secrets for effects.
As these values are confidential, they should not be in the store, but
copied over using other means, such as agenix, NixOps
- <literal>deployment.keys</literal>, or manual installation.
+ `deployment.keys`, or manual installation.
- The format is described on <link xlink:href="https://docs.hercules-ci.com/hercules-ci-agent/secrets-json/"/>.
+ The format is described on <https://docs.hercules-ci.com/hercules-ci-agent/secrets-json/>.
'';
type = types.path;
default = config.staticSecretsDirectory + "/secrets.json";
diff --git a/nixos/modules/services/continuous-integration/hydra/default.nix b/nixos/modules/services/continuous-integration/hydra/default.nix
index af6d86cd96b0..8b5c1228c523 100644
--- a/nixos/modules/services/continuous-integration/hydra/default.nix
+++ b/nixos/modules/services/continuous-integration/hydra/default.nix
@@ -115,8 +115,8 @@ in
type = types.str;
default = "*";
example = "localhost";
- description = ''
- The hostname or address to listen on or <literal>*</literal> to listen
+ description = lib.mdDoc ''
+ The hostname or address to listen on or `*` to listen
on all interfaces.
'';
};
diff --git a/nixos/modules/services/databases/foundationdb.nix b/nixos/modules/services/databases/foundationdb.nix
index f71228708e42..16998b997918 100644
--- a/nixos/modules/services/databases/foundationdb.nix
+++ b/nixos/modules/services/databases/foundationdb.nix
@@ -97,9 +97,9 @@ in
openFirewall = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Open the firewall ports corresponding to FoundationDB processes and coordinators
- using <option>config.networking.firewall.*</option>.
+ using {option}`config.networking.firewall.*`.
'';
};
diff --git a/nixos/modules/services/databases/mongodb.nix b/nixos/modules/services/databases/mongodb.nix
index 97713b5d6e1b..5a52eb98b917 100644
--- a/nixos/modules/services/databases/mongodb.nix
+++ b/nixos/modules/services/databases/mongodb.nix
@@ -35,7 +35,7 @@ in
default = pkgs.mongodb;
defaultText = literalExpression "pkgs.mongodb";
type = types.package;
- description = ''
+ description = lib.mdDoc ''
Which MongoDB derivation to use.
'';
};
diff --git a/nixos/modules/services/databases/mysql.nix b/nixos/modules/services/databases/mysql.nix
index a42926a542f2..ddb4eceb317e 100644
--- a/nixos/modules/services/databases/mysql.nix
+++ b/nixos/modules/services/databases/mysql.nix
@@ -36,7 +36,7 @@ in
package = mkOption {
type = types.package;
example = literalExpression "pkgs.mariadb";
- description = ''
+ description = lib.mdDoc ''
Which MySQL derivation to use. MariaDB packages are supported too.
'';
};
diff --git a/nixos/modules/services/databases/postgresql.nix b/nixos/modules/services/databases/postgresql.nix
index 1a57ecbe8ef3..36de8b9e874a 100644
--- a/nixos/modules/services/databases/postgresql.nix
+++ b/nixos/modules/services/databases/postgresql.nix
@@ -79,15 +79,15 @@ in
authentication = mkOption {
type = types.lines;
default = "";
- description = ''
+ description = lib.mdDoc ''
Defines how users authenticate themselves to the server. See the
- <link xlink:href="https://www.postgresql.org/docs/current/auth-pg-hba-conf.html">PostgreSQL documentation for pg_hba.conf</link>
+ [PostgreSQL documentation for pg_hba.conf](https://www.postgresql.org/docs/current/auth-pg-hba-conf.html)
for details on the expected format of this option. By default,
peer based authentication will be used for users connecting
via the Unix socket, and md5 password authentication will be
used for users connecting via TCP. Any added rules will be
inserted above the default rules. If you'd like to replace the
- default rules entirely, you can use <literal>lib.mkForce</literal> in your
+ default rules entirely, you can use `lib.mkForce` in your
module.
'';
};
diff --git a/nixos/modules/services/development/jupyter/default.nix b/nixos/modules/services/development/jupyter/default.nix
index edcc6b7c6c0c..66113ce09409 100644
--- a/nixos/modules/services/development/jupyter/default.nix
+++ b/nixos/modules/services/development/jupyter/default.nix
@@ -149,7 +149,7 @@ in {
};
}
'';
- description = ''
+ description = lib.mdDoc ''
Declarative kernel config.
Kernels can be declared in any language that supports and has the required
diff --git a/nixos/modules/services/games/asf.nix b/nixos/modules/services/games/asf.nix
index 129a2849102f..592ab4bedcfe 100644
--- a/nixos/modules/services/games/asf.nix
+++ b/nixos/modules/services/games/asf.nix
@@ -81,11 +81,11 @@ in
settings = mkOption {
type = format.type;
- description = ''
- The ASF.json file, all the options are documented <link xlink:href="https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Configuration#global-config">here</link>.
- Do note that <literal>AutoRestart</literal> and <literal>UpdateChannel</literal> is always to <literal>false</literal> respectively <literal>0</literal> because NixOS takes care of updating everything.
- <literal>Headless</literal> is also always set to <literal>true</literal> because there is no way to provide inputs via a systemd service.
- You should try to keep ASF up to date since upstream does not provide support for anything but the latest version and you're exposing yourself to all kinds of issues - as is outlined <link xlink:href="https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Configuration#updateperiod">here</link>.
+ description = lib.mdDoc ''
+ The ASF.json file, all the options are documented [here](https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Configuration#global-config).
+ Do note that `AutoRestart` and `UpdateChannel` is always to `false` respectively `0` because NixOS takes care of updating everything.
+ `Headless` is also always set to `true` because there is no way to provide inputs via a systemd service.
+ You should try to keep ASF up to date since upstream does not provide support for anything but the latest version and you're exposing yourself to all kinds of issues - as is outlined [here](https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Configuration#updateperiod).
'';
example = {
Statistics = false;
diff --git a/nixos/modules/services/home-automation/home-assistant.nix b/nixos/modules/services/home-automation/home-assistant.nix
index 07c2a26df2cd..c435491e71a9 100644
--- a/nixos/modules/services/home-automation/home-assistant.nix
+++ b/nixos/modules/services/home-automation/home-assistant.nix
@@ -126,10 +126,10 @@ in {
psycopg2
];
'';
- description = ''
+ description = lib.mdDoc ''
List of packages to add to propagatedBuildInputs.
- A popular example is <literal>python3Packages.psycopg2</literal>
+ A popular example is `python3Packages.psycopg2`
for PostgreSQL support in the recorder component.
'';
};
diff --git a/nixos/modules/services/mail/postfix.nix b/nixos/modules/services/mail/postfix.nix
index 42344041842f..3dc54038661d 100644
--- a/nixos/modules/services/mail/postfix.nix
+++ b/nixos/modules/services/mail/postfix.nix
@@ -355,7 +355,7 @@ in
setgidGroup = mkOption {
type = types.str;
default = "postdrop";
- description = ''
+ description = lib.mdDoc ''
How to call postfix setgid group (for postdrop). Should
be uniquely used group.
'';
@@ -365,7 +365,7 @@ in
type = types.nullOr (types.listOf types.str);
default = null;
example = ["192.168.0.1/24"];
- description = ''
+ description = lib.mdDoc ''
Net masks for trusted - allowed to relay mail to third parties -
hosts. Leave empty to use mynetworks_style configuration or use
default (localhost-only).
@@ -375,7 +375,7 @@ in
networksStyle = mkOption {
type = types.str;
default = "";
- description = ''
+ description = lib.mdDoc ''
Name of standard way of trusted network specification to use,
leave blank if you specify it explicitly or if you want to use
default (localhost-only).
@@ -385,7 +385,7 @@ in
hostname = mkOption {
type = types.str;
default = "";
- description = ''
+ description = lib.mdDoc ''
Hostname to use. Leave blank to use just the hostname of machine.
It should be FQDN.
'';
@@ -394,7 +394,7 @@ in
domain = mkOption {
type = types.str;
default = "";
- description = ''
+ description = lib.mdDoc ''
Domain to use. Leave blank to use hostname minus first component.
'';
};
@@ -402,7 +402,7 @@ in
origin = mkOption {
type = types.str;
default = "";
- description = ''
+ description = lib.mdDoc ''
Origin to use in outgoing e-mail. Leave blank to use hostname.
'';
};
@@ -411,7 +411,7 @@ in
type = types.nullOr (types.listOf types.str);
default = null;
example = ["localhost"];
- description = ''
+ description = lib.mdDoc ''
Full (!) list of domains we deliver locally. Leave blank for
acceptable Postfix default.
'';
@@ -421,7 +421,7 @@ in
type = types.nullOr (types.listOf types.str);
default = null;
example = ["localdomain"];
- description = ''
+ description = lib.mdDoc ''
List of domains we agree to relay to. Default is empty.
'';
};
@@ -429,7 +429,7 @@ in
relayHost = mkOption {
type = types.str;
default = "";
- description = ''
+ description = lib.mdDoc ''
Mail relay for outbound mail.
'';
};
@@ -437,7 +437,7 @@ in
relayPort = mkOption {
type = types.int;
default = 25;
- description = ''
+ description = lib.mdDoc ''
SMTP port for relay mail relay.
'';
};
@@ -445,7 +445,7 @@ in
lookupMX = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Whether relay specified is just domain whose MX must be used.
'';
};
@@ -453,7 +453,7 @@ in
postmasterAlias = mkOption {
type = types.str;
default = "root";
- description = ''
+ description = lib.mdDoc ''
Who should receive postmaster e-mail. Multiple values can be added by
separating values with comma.
'';
@@ -462,7 +462,7 @@ in
rootAlias = mkOption {
type = types.str;
default = "";
- description = ''
+ description = lib.mdDoc ''
Who should receive root e-mail. Blank for no redirection.
Multiple values can be added by separating values with comma.
'';
@@ -471,7 +471,7 @@ in
extraAliases = mkOption {
type = types.lines;
default = "";
- description = ''
+ description = lib.mdDoc ''
Additional entries to put verbatim into aliases file, cf. man-page aliases(8).
'';
};
@@ -497,7 +497,7 @@ in
extraConfig = mkOption {
type = types.lines;
default = "";
- description = ''
+ description = lib.mdDoc ''
Extra lines to be added verbatim to the main.cf configuration file.
'';
};
@@ -527,7 +527,7 @@ in
type = types.str;
default = "";
example = "+";
- description = ''
+ description = lib.mdDoc ''
Delimiter for address extension: so mail to user+test can be handled by ~user/.forward+test
'';
};
@@ -543,7 +543,7 @@ in
virtual = mkOption {
type = types.lines;
default = "";
- description = ''
+ description = lib.mdDoc ''
Entries for the virtual alias map, cf. man-page virtual(5).
'';
};
@@ -572,7 +572,7 @@ in
transport = mkOption {
default = "";
type = types.lines;
- description = ''
+ description = lib.mdDoc ''
Entries for the transport map, cf. man-page transport(8).
'';
};
diff --git a/nixos/modules/services/matrix/dendrite.nix b/nixos/modules/services/matrix/dendrite.nix
index ecb7c4876e13..b336c5fd0f96 100644
--- a/nixos/modules/services/matrix/dendrite.nix
+++ b/nixos/modules/services/matrix/dendrite.nix
@@ -26,24 +26,24 @@ in
type = lib.types.nullOr lib.types.path;
example = "/var/lib/dendrite/server.cert";
default = null;
- description = ''
+ description = lib.mdDoc ''
The path to the TLS certificate.
- <programlisting>
+ ```
nix-shell -p dendrite --command "generate-keys --tls-cert server.crt --tls-key server.key"
- </programlisting>
+ ```
'';
};
tlsKey = lib.mkOption {
type = lib.types.nullOr lib.types.path;
example = "/var/lib/dendrite/server.key";
default = null;
- description = ''
+ description = lib.mdDoc ''
The path to the TLS key.
- <programlisting>
+ ```
nix-shell -p dendrite --command "generate-keys --tls-cert server.crt --tls-key server.key"
- </programlisting>
+ ```
'';
};
environmentFile = lib.mkOption {
@@ -102,13 +102,13 @@ in
lib.types.path
(lib.types.strMatching "^\\$CREDENTIALS_DIRECTORY/.+");
example = "$CREDENTIALS_DIRECTORY/private_key";
- description = ''
+ description = lib.mdDoc ''
The path to the signing private key file, used to sign
requests and events.
- <programlisting>
+ ```
nix-shell -p dendrite --command "generate-keys --private-key matrix_key.pem"
- </programlisting>
+ ```
'';
};
trusted_third_party_id_servers = lib.mkOption {
diff --git a/nixos/modules/services/misc/etebase-server.nix b/nixos/modules/services/misc/etebase-server.nix
index 15a5f126729c..76c7c6596c85 100644
--- a/nixos/modules/services/misc/etebase-server.nix
+++ b/nixos/modules/services/misc/etebase-server.nix
@@ -133,10 +133,10 @@ in
};
};
default = {};
- description = ''
- Configuration for <literal>etebase-server</literal>. Refer to
- <link xlink:href="https://github.com/etesync/server/blob/master/etebase-server.ini.example"/>
- and <link xlink:href="https://github.com/etesync/server/wiki"/>
+ description = lib.mdDoc ''
+ Configuration for `etebase-server`. Refer to
+ <https://github.com/etesync/server/blob/master/etebase-server.ini.example>
+ and <https://github.com/etesync/server/wiki>
for details on supported values.
'';
example = {
diff --git a/nixos/modules/services/misc/exhibitor.nix b/nixos/modules/services/misc/exhibitor.nix
index 4e9e1077f528..d804b21fd4f9 100644
--- a/nixos/modules/services/misc/exhibitor.nix
+++ b/nixos/modules/services/misc/exhibitor.nix
@@ -71,7 +71,7 @@ in
enable = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Whether to enable the exhibitor server.
'';
};
diff --git a/nixos/modules/services/misc/freeswitch.nix b/nixos/modules/services/misc/freeswitch.nix
index 8a74b229ce34..88949bf98002 100644
--- a/nixos/modules/services/misc/freeswitch.nix
+++ b/nixos/modules/services/misc/freeswitch.nix
@@ -22,11 +22,11 @@ in {
enableReload = mkOption {
default = false;
type = types.bool;
- description = ''
- Issue the <literal>reloadxml</literal> command to FreeSWITCH when configuration directory changes (instead of restart).
- See <link xlink:href="https://freeswitch.org/confluence/display/FREESWITCH/Reloading">FreeSWITCH documentation</link> for more info.
- The configuration directory is exposed at <filename>/etc/freeswitch</filename>.
- See also <literal>systemd.services.*.restartIfChanged</literal>.
+ description = lib.mdDoc ''
+ Issue the `reloadxml` command to FreeSWITCH when configuration directory changes (instead of restart).
+ See [FreeSWITCH documentation](https://freeswitch.org/confluence/display/FREESWITCH/Reloading) for more info.
+ The configuration directory is exposed at {file}`/etc/freeswitch`.
+ See also `systemd.services.*.restartIfChanged`.
'';
};
configTemplate = mkOption {
diff --git a/nixos/modules/services/misc/geoipupdate.nix b/nixos/modules/services/misc/geoipupdate.nix
index 041099ce5106..444bd57893b3 100644
--- a/nixos/modules/services/misc/geoipupdate.nix
+++ b/nixos/modules/services/misc/geoipupdate.nix
@@ -35,20 +35,20 @@ in
ProxyUserPassword = { _secret = "/run/keys/proxy_pass"; };
}
'';
- description = ''
+ description = lib.mdDoc ''
geoipupdate configuration options. See
- <link xlink:href="https://github.com/maxmind/geoipupdate/blob/main/doc/GeoIP.conf.md"/>
+ <https://github.com/maxmind/geoipupdate/blob/main/doc/GeoIP.conf.md>
for a full list of available options.
Settings containing secret data should be set to an
attribute set containing the attribute
- <literal>_secret</literal> - a string pointing to a file
+ `_secret` - a string pointing to a file
containing the value the option should be set to. See the
example to get a better picture of this: in the resulting
- <filename>GeoIP.conf</filename> file, the
- <literal>ProxyUserPassword</literal> key will be set to the
+ {file}`GeoIP.conf` file, the
+ `ProxyUserPassword` key will be set to the
contents of the
- <filename>/run/keys/proxy_pass</filename> file.
+ {file}`/run/keys/proxy_pass` file.
'';
type = lib.types.submodule {
freeformType =
@@ -83,12 +83,12 @@ in
LicenseKey = lib.mkOption {
type = with lib.types; either path (attrsOf path);
- description = ''
+ description = lib.mdDoc ''
A file containing the MaxMind license key.
Always handled as a secret whether the value is
- wrapped in a <literal>{ _secret = ...; }</literal>
- attrset or not (refer to <xref linkend="opt-services.geoipupdate.settings"/> for
+ wrapped in a `{ _secret = ...; }`
+ attrset or not (refer to [](#opt-services.geoipupdate.settings) for
details).
'';
apply = x: if isAttrs x then x else { _secret = x; };
diff --git a/nixos/modules/services/misc/gitea.nix b/nixos/modules/services/misc/gitea.nix
index 5bcc0fbc7e19..f96b4fb6dd55 100644
--- a/nixos/modules/services/misc/gitea.nix
+++ b/nixos/modules/services/misc/gitea.nix
@@ -293,12 +293,12 @@ in
default = "${cfg.stateDir}/log";
defaultText = literalExpression ''"''${config.${opt.stateDir}}/log"'';
type = types.str;
- description = "Root path for log files.";
+ description = lib.mdDoc "Root path for log files.";
};
LEVEL = mkOption {
default = "Info";
type = types.enum [ "Trace" "Debug" "Info" "Warn" "Error" "Critical" ];
- description = "General log level.";
+ description = lib.mdDoc "General log level.";
};
};
@@ -306,14 +306,14 @@ in
DISABLE_SSH = mkOption {
type = types.bool;
default = false;
- description = "Disable external SSH feature.";
+ description = lib.mdDoc "Disable external SSH feature.";
};
SSH_PORT = mkOption {
type = types.int;
default = 22;
example = 2222;
- description = ''
+ description = lib.mdDoc ''
SSH port displayed in clone URL.
The option is required to configure a service when the external visible port
differs from the local listening port i.e. if port forwarding is used.
@@ -339,7 +339,7 @@ in
COOKIE_SECURE = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Marks session cookies as "secure" as a hint for browsers to only send
them via HTTPS. This option is recommend, if gitea is being served over HTTPS.
'';
diff --git a/nixos/modules/services/misc/gitlab.nix b/nixos/modules/services/misc/gitlab.nix
index 2a823c766225..aa2a05900f87 100644
--- a/nixos/modules/services/misc/gitlab.nix
+++ b/nixos/modules/services/misc/gitlab.nix
@@ -338,9 +338,9 @@ in {
default = 0;
example = 48;
apply = x: x * 60 * 60;
- description = ''
+ description = lib.mdDoc ''
How long to keep the backups around, in
- hours. <literal>0</literal> means “keep forever”.
+ hours. `0` means “keep forever”.
'';
};
@@ -414,7 +414,7 @@ in {
databaseHost = mkOption {
type = types.str;
default = "";
- description = ''
+ description = lib.mdDoc ''
GitLab database hostname. An empty string means
“use local unix socket connection”.
'';
diff --git a/nixos/modules/services/misc/gitolite.nix b/nixos/modules/services/misc/gitolite.nix
index 0a1ca262e6e3..88b9ac4a0a33 100644
--- a/nixos/modules/services/misc/gitolite.nix
+++ b/nixos/modules/services/misc/gitolite.nix
@@ -14,11 +14,11 @@ in
enable = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Enable gitolite management under the
- <literal>gitolite</literal> user. After
+ `gitolite` user. After
switching to a configuration with Gitolite enabled, you can
- then run <literal>git clone gitolite@host:gitolite-admin.git</literal> to manage it further.
+ then run `git clone gitolite@host:gitolite-admin.git` to manage it further.
'';
};
@@ -71,25 +71,25 @@ in
@{$RC{ENABLE}} = grep { $_ ne 'desc' } @{$RC{ENABLE}}; # disable the command/feature
'''
'';
- description = ''
- Extra configuration to append to the default <literal>~/.gitolite.rc</literal>.
+ description = lib.mdDoc ''
+ Extra configuration to append to the default `~/.gitolite.rc`.
- This should be Perl code that modifies the <literal>%RC</literal>
- configuration variable. The default <literal>~/.gitolite.rc</literal>
- content is generated by invoking <literal>gitolite print-default-rc</literal>,
+ This should be Perl code that modifies the `%RC`
+ configuration variable. The default `~/.gitolite.rc`
+ content is generated by invoking `gitolite print-default-rc`,
and extra configuration from this option is appended to it. The result
- is placed to Nix store, and the <literal>~/.gitolite.rc</literal> file
+ is placed to Nix store, and the `~/.gitolite.rc` file
becomes a symlink to it.
If you already have a customized (or otherwise changed)
- <literal>~/.gitolite.rc</literal> file, NixOS will refuse to replace
- it with a symlink, and the <literal>gitolite-init</literal> initialization service
+ `~/.gitolite.rc` file, NixOS will refuse to replace
+ it with a symlink, and the `gitolite-init` initialization service
will fail. In this situation, in order to use this option, you
will need to take any customizations you may have in
- <literal>~/.gitolite.rc</literal>, convert them to appropriate Perl
+ `~/.gitolite.rc`, convert them to appropriate Perl
statements, add them to this option, and remove the file.
- See also the <literal>enableGitAnnex</literal> option.
+ See also the `enableGitAnnex` option.
'';
};
diff --git a/nixos/modules/services/misc/nix-daemon.nix b/nixos/modules/services/misc/nix-daemon.nix
index 4022c7ebbc2f..2738d2ee6cd0 100644
--- a/nixos/modules/services/misc/nix-daemon.nix
+++ b/nixos/modules/services/misc/nix-daemon.nix
@@ -562,13 +562,13 @@ in
trusted-public-keys = mkOption {
type = types.listOf types.str;
example = [ "hydra.nixos.org-1:CNHJZBh9K4tP3EKF6FkkgeVYsS3ohTl+oS0Qa8bezVs=" ];
- description = ''
+ description = lib.mdDoc ''
List of public keys used to sign binary caches. If
- <option>nix.settings.trusted-public-keys</option> is enabled,
+ {option}`nix.settings.trusted-public-keys` is enabled,
then Nix will use a binary from a binary cache if and only
- if it is signed by <emphasis>any</emphasis> of the keys
+ if it is signed by *any* of the keys
listed here. By default, only the key for
- <literal>cache.nixos.org</literal> is included.
+ `cache.nixos.org` is included.
'';
};
@@ -605,13 +605,13 @@ in
type = types.listOf types.str;
default = [ "*" ];
example = [ "@wheel" "@builders" "alice" "bob" ];
- description = ''
+ description = lib.mdDoc ''
A list of names of users (separated by whitespace) that are
allowed to connect to the Nix daemon. As with
- <option>nix.settings.trusted-users</option>, you can specify groups by
- prefixing them with <literal>@</literal>. Also, you can
- allow all users by specifying <literal>*</literal>. The
- default is <literal>*</literal>. Note that trusted users are
+ {option}`nix.settings.trusted-users`, you can specify groups by
+ prefixing them with `@`. Also, you can
+ allow all users by specifying `*`. The
+ default is `*`. Note that trusted users are
always allowed to connect.
'';
};
diff --git a/nixos/modules/services/monitoring/grafana-agent.nix b/nixos/modules/services/monitoring/grafana-agent.nix
index d71361b94ed6..45b62d140c16 100644
--- a/nixos/modules/services/monitoring/grafana-agent.nix
+++ b/nixos/modules/services/monitoring/grafana-agent.nix
@@ -38,8 +38,8 @@ in
};
settings = mkOption {
- description = ''
- Configuration for <literal>grafana-agent</literal>.
+ description = lib.mdDoc ''
+ Configuration for `grafana-agent`.
See https://grafana.com/docs/agent/latest/configuration/
'';
diff --git a/nixos/modules/services/monitoring/grafana-image-renderer.nix b/nixos/modules/services/monitoring/grafana-image-renderer.nix
index 8ec5b689a24d..d92ce5e1eefc 100644
--- a/nixos/modules/services/monitoring/grafana-image-renderer.nix
+++ b/nixos/modules/services/monitoring/grafana-image-renderer.nix
@@ -79,8 +79,8 @@ in {
args = mkOption {
type = types.listOf types.str;
default = [ "--no-sandbox" ];
- description = ''
- List of CLI flags passed to <literal>chromium</literal>.
+ description = lib.mdDoc ''
+ List of CLI flags passed to `chromium`.
'';
};
};
@@ -89,10 +89,10 @@ in {
default = {};
- description = ''
- Configuration attributes for <literal>grafana-image-renderer</literal>.
+ description = lib.mdDoc ''
+ Configuration attributes for `grafana-image-renderer`.
- See <link xlink:href="https://github.com/grafana/grafana-image-renderer/blob/ce1f81438e5f69c7fd7c73ce08bab624c4c92e25/default.json"/>
+ See <https://github.com/grafana/grafana-image-renderer/blob/ce1f81438e5f69c7fd7c73ce08bab624c4c92e25/default.json>
for supported values.
'';
};
diff --git a/nixos/modules/services/monitoring/mackerel-agent.nix b/nixos/modules/services/monitoring/mackerel-agent.nix
index 3d09df6f8f71..9182739ee1cc 100644
--- a/nixos/modules/services/monitoring/mackerel-agent.nix
+++ b/nixos/modules/services/monitoring/mackerel-agent.nix
@@ -20,11 +20,11 @@ in {
apiKeyFile = mkOption {
type = types.path;
example = "/run/keys/mackerel-api-key";
- description = ''
+ description = lib.mdDoc ''
Path to file containing the Mackerel API key. The file should contain a
single line of the following form:
- <literal>apikey = "EXAMPLE_API_KEY"</literal>
+ `apikey = "EXAMPLE_API_KEY"`
'';
};
diff --git a/nixos/modules/services/monitoring/nagios.nix b/nixos/modules/services/monitoring/nagios.nix
index fe217be915aa..14dbc5fdb44f 100644
--- a/nixos/modules/services/monitoring/nagios.nix
+++ b/nixos/modules/services/monitoring/nagios.nix
@@ -91,7 +91,7 @@ in
enable = mkEnableOption ''<link xlink:href="http://www.nagios.org/">Nagios</link> to monitor your system or network.'';
objectDefs = mkOption {
- description = ''
+ description = lib.mdDoc ''
A list of Nagios object configuration files that must define
the hosts, host groups, services and contacts for the
network that you want Nagios to monitor.
@@ -113,7 +113,7 @@ in
mainConfigFile = mkOption {
type = types.nullOr types.package;
default = null;
- description = ''
+ description = lib.mdDoc ''
If non-null, overrides the main configuration file of Nagios.
'';
};
@@ -139,7 +139,7 @@ in
type = types.package;
default = nagiosCGICfgFile;
defaultText = literalExpression "nagiosCGICfgFile";
- description = ''
+ description = lib.mdDoc ''
Derivation for the configuration file of Nagios CGI scripts
that can be used in web servers for running the Nagios web interface.
'';
@@ -148,9 +148,9 @@ in
enableWebInterface = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Whether to enable the Nagios web interface. You should also
- enable Apache (<option>services.httpd.enable</option>).
+ enable Apache ({option}`services.httpd.enable`).
'';
};
diff --git a/nixos/modules/services/monitoring/prometheus/default.nix b/nixos/modules/services/monitoring/prometheus/default.nix
index bb79a8feb97d..ada66fe24646 100644
--- a/nixos/modules/services/monitoring/prometheus/default.nix
+++ b/nixos/modules/services/monitoring/prometheus/default.nix
@@ -1729,15 +1729,15 @@ in
type = with types; either bool (enum [ "syntax-only" ]);
default = true;
example = "syntax-only";
- description = ''
- Check configuration with <literal>promtool check</literal>. The call to <literal>promtool</literal> is
+ description = lib.mdDoc ''
+ Check configuration with `promtool check`. The call to `promtool` is
subject to sandboxing by Nix.
If you use credentials stored in external files
- (<literal>password_file</literal>, <literal>bearer_token_file</literal>, etc),
- they will not be visible to <literal>promtool</literal>
+ (`password_file`, `bearer_token_file`, etc),
+ they will not be visible to `promtool`
and it will report errors, despite a correct configuration.
- To resolve this, you may set this option to <literal>"syntax-only"</literal>
+ To resolve this, you may set this option to `"syntax-only"`
in order to only syntax check the Prometheus configuration.
'';
};
diff --git a/nixos/modules/services/monitoring/prometheus/exporters/knot.nix b/nixos/modules/services/monitoring/prometheus/exporters/knot.nix
index 44be9641c0ae..a73425b37da7 100644
--- a/nixos/modules/services/monitoring/prometheus/exporters/knot.nix
+++ b/nixos/modules/services/monitoring/prometheus/exporters/knot.nix
@@ -11,8 +11,8 @@ in {
type = types.str;
default = "${pkgs.knot-dns.out}/lib/libknot.so";
defaultText = literalExpression ''"''${pkgs.knot-dns.out}/lib/libknot.so"'';
- description = ''
- Path to the library of <literal>knot-dns</literal>.
+ description = lib.mdDoc ''
+ Path to the library of `knot-dns`.
'';
};
diff --git a/nixos/modules/services/monitoring/prometheus/exporters/openldap.nix b/nixos/modules/services/monitoring/prometheus/exporters/openldap.nix
index b89ec99c68e8..6f77c05562d7 100644
--- a/nixos/modules/services/monitoring/prometheus/exporters/openldap.nix
+++ b/nixos/modules/services/monitoring/prometheus/exporters/openldap.nix
@@ -26,15 +26,15 @@ in {
default = "tcp";
example = "udp";
type = types.str;
- description = ''
- Which protocol to use to connect against <literal>openldap</literal>.
+ description = lib.mdDoc ''
+ Which protocol to use to connect against `openldap`.
'';
};
ldapAddr = mkOption {
default = "localhost:389";
type = types.str;
- description = ''
- Address of the <literal>openldap</literal>-instance.
+ description = lib.mdDoc ''
+ Address of the `openldap`-instance.
'';
};
metricsPath = mkOption {
diff --git a/nixos/modules/services/network-filesystems/yandex-disk.nix b/nixos/modules/services/network-filesystems/yandex-disk.nix
index d66e481a9690..1078df0bed25 100644
--- a/nixos/modules/services/network-filesystems/yandex-disk.nix
+++ b/nixos/modules/services/network-filesystems/yandex-disk.nix
@@ -23,7 +23,7 @@ in
enable = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Whether to enable Yandex-disk client. See https://disk.yandex.ru/
'';
};
diff --git a/nixos/modules/services/networking/bind.nix b/nixos/modules/services/networking/bind.nix
index aaa1cc2f1000..630d1b20733b 100644
--- a/nixos/modules/services/networking/bind.nix
+++ b/nixos/modules/services/networking/bind.nix
@@ -129,7 +129,7 @@ in
blockedNetworks = mkOption {
default = [ ];
type = types.listOf types.str;
- description = ''
+ description = lib.mdDoc ''
What networks are just blocked.
'';
};
@@ -137,7 +137,7 @@ in
ipv4Only = mkOption {
default = false;
type = types.bool;
- description = ''
+ description = lib.mdDoc ''
Only use ipv4, even if the host supports ipv6.
'';
};
@@ -146,7 +146,7 @@ in
default = config.networking.nameservers;
defaultText = literalExpression "config.networking.nameservers";
type = types.listOf types.str;
- description = ''
+ description = lib.mdDoc ''
List of servers we should forward requests to.
'';
};
@@ -154,7 +154,7 @@ in
forward = mkOption {
default = "first";
type = types.enum ["first" "only"];
- description = ''
+ description = lib.mdDoc ''
Whether to forward 'first' (try forwarding but lookup directly if forwarding fails) or 'only'.
'';
};
@@ -162,7 +162,7 @@ in
listenOn = mkOption {
default = [ "any" ];
type = types.listOf types.str;
- description = ''
+ description = lib.mdDoc ''
Interfaces to listen on.
'';
};
@@ -170,7 +170,7 @@ in
listenOnIpv6 = mkOption {
default = [ "any" ];
type = types.listOf types.str;
- description = ''
+ description = lib.mdDoc ''
Ipv6 interfaces to listen on.
'';
};
@@ -184,7 +184,7 @@ in
zones = mkOption {
default = [ ];
type = with types; coercedTo (listOf attrs) bindZoneCoerce (attrsOf (types.submodule bindZoneOptions));
- description = ''
+ description = lib.mdDoc ''
List of zones we claim authority over.
'';
example = {
@@ -201,7 +201,7 @@ in
extraConfig = mkOption {
type = types.lines;
default = "";
- description = ''
+ description = lib.mdDoc ''
Extra lines to be added verbatim to the generated named configuration file.
'';
};
@@ -219,7 +219,7 @@ in
type = types.path;
default = confFile;
defaultText = literalExpression "confFile";
- description = ''
+ description = lib.mdDoc ''
Overridable config file to use for named. By default, that
generated by nixos.
'';
diff --git a/nixos/modules/services/networking/create_ap.nix b/nixos/modules/services/networking/create_ap.nix
index 258ce9501a54..2fcf9b8a5419 100644
--- a/nixos/modules/services/networking/create_ap.nix
+++ b/nixos/modules/services/networking/create_ap.nix
@@ -12,9 +12,9 @@ in {
settings = mkOption {
type = with types; attrsOf (oneOf [ int bool str ]);
default = {};
- description = ''
- Configuration for <literal>create_ap</literal>.
- See <link xlink:href="https://raw.githubusercontent.com/lakinduakash/linux-wifi-hotspot/master/src/scripts/create_ap.conf">upstream example configuration</link>
+ description = lib.mdDoc ''
+ Configuration for `create_ap`.
+ See [upstream example configuration](https://raw.githubusercontent.com/lakinduakash/linux-wifi-hotspot/master/src/scripts/create_ap.conf)
for supported values.
'';
example = {
diff --git a/nixos/modules/services/networking/firefox-syncserver.nix b/nixos/modules/services/networking/firefox-syncserver.nix
index 254d5c1dc670..2944124b1043 100644
--- a/nixos/modules/services/networking/firefox-syncserver.nix
+++ b/nixos/modules/services/networking/firefox-syncserver.nix
@@ -55,7 +55,7 @@ in
type = lib.types.package;
default = pkgs.syncstorage-rs;
defaultText = lib.literalExpression "pkgs.syncstorage-rs";
- description = ''
+ description = lib.mdDoc ''
Package to use.
'';
};
@@ -66,16 +66,16 @@ in
# behavior ever change.
type = lib.types.strMatching "[a-z_][a-z0-9_]*";
default = defaultDatabase;
- description = ''
+ description = lib.mdDoc ''
Database to use for storage. Will be created automatically if it does not exist
- and <literal>config.${opt.database.createLocally}</literal> is set.
+ and `config.${opt.database.createLocally}` is set.
'';
};
database.user = lib.mkOption {
type = lib.types.str;
default = defaultUser;
- description = ''
+ description = lib.mdDoc ''
Username for database connections.
'';
};
@@ -83,8 +83,8 @@ in
database.host = lib.mkOption {
type = lib.types.str;
default = "localhost";
- description = ''
- Database host name. <literal>localhost</literal> is treated specially and inserts
+ description = lib.mdDoc ''
+ Database host name. `localhost` is treated specially and inserts
systemd dependencies, other hostnames or IP addresses of the local machine do not.
'';
};
@@ -92,7 +92,7 @@ in
database.createLocally = lib.mkOption {
type = lib.types.bool;
default = true;
- description = ''
+ description = lib.mdDoc ''
Whether to create database and user on the local machine if they do not exist.
This includes enabling unix domain socket authentication for the configured user.
'';
@@ -101,19 +101,19 @@ in
logLevel = lib.mkOption {
type = lib.types.str;
default = "error";
- description = ''
- Log level to run with. This can be a simple log level like <literal>error</literal>
- or <literal>trace</literal>, or a more complicated logging expression.
+ description = lib.mdDoc ''
+ Log level to run with. This can be a simple log level like `error`
+ or `trace`, or a more complicated logging expression.
'';
};
secrets = lib.mkOption {
type = lib.types.path;
- description = ''
+ description = lib.mdDoc ''
A file containing the various secrets. Should be in the format expected by systemd's
- <literal>EnvironmentFile</literal> directory. Two secrets are currently available:
- <literal>SYNC_MASTER_SECRET</literal> and
- <literal>SYNC_TOKENSERVER__FXA_METRICS_HASH_SECRET</literal>.
+ `EnvironmentFile` directory. Two secrets are currently available:
+ `SYNC_MASTER_SECRET` and
+ `SYNC_TOKENSERVER__FXA_METRICS_HASH_SECRET`.
'';
};
@@ -126,7 +126,7 @@ in
hostname = lib.mkOption {
type = lib.types.str;
- description = ''
+ description = lib.mdDoc ''
Host name to use for this service.
'';
};
@@ -134,7 +134,7 @@ in
capacity = lib.mkOption {
type = lib.types.ints.unsigned;
default = 10;
- description = ''
+ description = lib.mdDoc ''
How many sync accounts are allowed on this server. Setting this value
equal to or less than the number of currently active accounts will
effectively deny service to accounts not yet registered here.
@@ -147,7 +147,7 @@ in
defaultText = lib.literalExpression ''
''${if cfg.singleNode.enableTLS then "https" else "http"}://''${config.${opt.singleNode.hostname}}
'';
- description = ''
+ description = lib.mdDoc ''
URL of the host. If you are not using the automatic webserver proxy setup you will have
to change this setting or your sync server may not be functional.
'';
@@ -162,7 +162,7 @@ in
port = lib.mkOption {
type = lib.types.port;
default = 5000;
- description = ''
+ description = lib.mdDoc ''
Port to bind to.
'';
};
@@ -170,21 +170,21 @@ in
tokenserver.enabled = lib.mkOption {
type = lib.types.bool;
default = true;
- description = ''
+ description = lib.mdDoc ''
Whether to enable the token service as well.
'';
};
};
};
default = { };
- description = ''
+ description = lib.mdDoc ''
Settings for the sync server. These take priority over values computed
from NixOS options.
- See the doc comments on the <literal>Settings</literal> structs in
- <link xlink:href="https://github.com/mozilla-services/syncstorage-rs/blob/master/syncstorage/src/settings.rs" />
+ See the doc comments on the `Settings` structs in
+ <https://github.com/mozilla-services/syncstorage-rs/blob/master/syncstorage/src/settings.rs>
and
- <link xlink:href="https://github.com/mozilla-services/syncstorage-rs/blob/master/syncstorage/src/tokenserver/settings.rs" />
+ <https://github.com/mozilla-services/syncstorage-rs/blob/master/syncstorage/src/tokenserver/settings.rs>
for available options.
'';
};
diff --git a/nixos/modules/services/networking/ghostunnel.nix b/nixos/modules/services/networking/ghostunnel.nix
index 79cf80e57bef..4b9620cea214 100644
--- a/nixos/modules/services/networking/ghostunnel.nix
+++ b/nixos/modules/services/networking/ghostunnel.nix
@@ -37,12 +37,12 @@ let
};
keystore = mkOption {
- description = ''
+ description = lib.mdDoc ''
Path to keystore (combined PEM with cert/key, or PKCS12 keystore).
- NB: storepass is not supported because it would expose credentials via <literal>/proc/*/cmdline</literal>.
+ NB: storepass is not supported because it would expose credentials via `/proc/*/cmdline`.
- Specify this or <literal>cert</literal> and <literal>key</literal>.
+ Specify this or `cert` and `key`.
'';
type = types.nullOr types.str;
default = null;
diff --git a/nixos/modules/services/networking/hylafax/options.nix b/nixos/modules/services/networking/hylafax/options.nix
index bc289132a760..79275d628b60 100644
--- a/nixos/modules/services/networking/hylafax/options.nix
+++ b/nixos/modules/services/networking/hylafax/options.nix
@@ -235,9 +235,9 @@ in
InternationalPrefix = "00";
LongDistancePrefix = "0";
};
- description = ''
+ description = lib.mdDoc ''
Attribute set of default values for
- modem config files <filename>etc/config.*</filename>.
+ modem config files {file}`etc/config.*`.
${commonDescr}
Think twice before changing
paths of fax-processing scripts.
diff --git a/nixos/modules/services/networking/ircd-hybrid/default.nix b/nixos/modules/services/networking/ircd-hybrid/default.nix
index 53357abce949..44fadde1fbb7 100644
--- a/nixos/modules/services/networking/ircd-hybrid/default.nix
+++ b/nixos/modules/services/networking/ircd-hybrid/default.nix
@@ -41,7 +41,7 @@ in
serverName = mkOption {
default = "hades.arpa";
type = types.str;
- description = ''
+ description = lib.mdDoc ''
IRCD server name.
'';
};
@@ -49,7 +49,7 @@ in
sid = mkOption {
default = "0NL";
type = types.str;
- description = ''
+ description = lib.mdDoc ''
IRCD server unique ID in a net of servers.
'';
};
@@ -57,7 +57,7 @@ in
description = mkOption {
default = "Hybrid-7 IRC server.";
type = types.str;
- description = ''
+ description = lib.mdDoc ''
IRCD server description.
'';
};
@@ -66,7 +66,7 @@ in
default = null;
example = literalExpression "/root/certificates/irc.key";
type = types.nullOr types.path;
- description = ''
+ description = lib.mdDoc ''
IRCD server RSA key.
'';
};
@@ -75,7 +75,7 @@ in
default = null;
example = literalExpression "/root/certificates/irc.pem";
type = types.nullOr types.path;
- description = ''
+ description = lib.mdDoc ''
IRCD server SSL certificate. There are some limitations - read manual.
'';
};
@@ -84,7 +84,7 @@ in
default = "<bit-bucket@example.com>";
type = types.str;
example = "<name@domain.tld>";
- description = ''
+ description = lib.mdDoc ''
IRCD server administrator e-mail.
'';
};
@@ -93,7 +93,7 @@ in
default = [];
example = ["127.0.0.1"];
type = types.listOf types.str;
- description = ''
+ description = lib.mdDoc ''
Extra IP's to bind.
'';
};
@@ -101,7 +101,7 @@ in
extraPort = mkOption {
default = "7117";
type = types.str;
- description = ''
+ description = lib.mdDoc ''
Extra port to avoid filtering.
'';
};
diff --git a/nixos/modules/services/networking/kresd.nix b/nixos/modules/services/networking/kresd.nix
index 601a88176ec2..55af6abd5e01 100644
--- a/nixos/modules/services/networking/kresd.nix
+++ b/nixos/modules/services/networking/kresd.nix
@@ -59,7 +59,7 @@ in {
};
package = mkOption {
type = types.package;
- description = ''
+ description = lib.mdDoc ''
knot-resolver package to use.
'';
default = pkgs.knot-resolver;
diff --git a/nixos/modules/services/networking/mxisd.nix b/nixos/modules/services/networking/mxisd.nix
index dc0196360c3b..571326c5aced 100644
--- a/nixos/modules/services/networking/mxisd.nix
+++ b/nixos/modules/services/networking/mxisd.nix
@@ -49,9 +49,9 @@ in {
environmentFile = mkOption {
type = types.nullOr types.str;
default = null;
- description = ''
+ description = lib.mdDoc ''
Path to an environment-file which may contain secrets to be
- substituted via <literal>envsubst</literal>.
+ substituted via `envsubst`.
'';
};
diff --git a/nixos/modules/services/networking/resilio.nix b/nixos/modules/services/networking/resilio.nix
index eca5f5ccfe93..d21f108024e5 100644
--- a/nixos/modules/services/networking/resilio.nix
+++ b/nixos/modules/services/networking/resilio.nix
@@ -199,25 +199,25 @@ in
];
}
];
- description = ''
+ description = lib.mdDoc ''
Shared folder list. If enabled, web UI must be
- disabled. Secrets can be generated using <literal>rslsync --generate-secret</literal>.
+ disabled. Secrets can be generated using `rslsync --generate-secret`.
Note that this secret will be
put inside the Nix store, so it is realistically not very
secret.
If you would like to be able to modify the contents of this
directories, it is recommended that you make your user a
- member of the <literal>rslsync</literal> group.
+ member of the `rslsync` group.
Directories in this list should be in the
- <literal>rslsync</literal> group, and that group must have
+ `rslsync` group, and that group must have
write access to the directory. It is also recommended that
- <literal>chmod g+s</literal> is applied to the directory
+ `chmod g+s` is applied to the directory
so that any sub directories created will also belong to
- the <literal>rslsync</literal> group. Also,
- <literal>setfacl -d -m group:rslsync:rwx</literal> and
- <literal>setfacl -m group:rslsync:rwx</literal> should also
+ the `rslsync` group. Also,
+ `setfacl -d -m group:rslsync:rwx` and
+ `setfacl -m group:rslsync:rwx` should also
be applied so that the sub directories are writable by
the group.
'';
diff --git a/nixos/modules/services/networking/v2ray.nix b/nixos/modules/services/networking/v2ray.nix
index df4b41eecbd4..1ff1feed8f47 100644
--- a/nixos/modules/services/networking/v2ray.nix
+++ b/nixos/modules/services/networking/v2ray.nix
@@ -51,12 +51,12 @@ with lib;
protocol = "freedom";
}];
};
- description = ''
+ description = lib.mdDoc ''
The configuration object.
- Either <literal>configFile</literal> or <literal>config</literal> must be specified.
+ Either `configFile` or `config` must be specified.
- See <link xlink:href="https://www.v2fly.org/en_US/config/overview.html"/>.
+ See <https://www.v2fly.org/en_US/config/overview.html>.
'';
};
};
diff --git a/nixos/modules/services/networking/yggdrasil.nix b/nixos/modules/services/networking/yggdrasil.nix
index d29ec55807bd..e7513c5627c8 100644
--- a/nixos/modules/services/networking/yggdrasil.nix
+++ b/nixos/modules/services/networking/yggdrasil.nix
@@ -31,27 +31,27 @@ in {
"tcp://0.0.0.0:xxxxx"
];
};
- description = ''
+ description = lib.mdDoc ''
Configuration for yggdrasil, as a Nix attribute set.
Warning: this is stored in the WORLD-READABLE Nix store!
Therefore, it is not appropriate for private keys. If you
- wish to specify the keys, use <option>configFile</option>.
+ wish to specify the keys, use {option}`configFile`.
- If the <option>persistentKeys</option> is enabled then the
+ If the {option}`persistentKeys` is enabled then the
keys that are generated during activation will override
- those in <option>config</option> or
- <option>configFile</option>.
+ those in {option}`config` or
+ {option}`configFile`.
If no keys are specified then ephemeral keys are generated
and the Yggdrasil interface will have a random IPv6 address
each time the service is started, this is the default.
- If both <option>configFile</option> and <option>config</option>
+ If both {option}`configFile` and {option}`config`
are supplied, they will be combined, with values from
- <option>configFile</option> taking precedence.
+ {option}`configFile` taking precedence.
- You can use the command <literal>nix-shell -p yggdrasil --run "yggdrasil -genconf"</literal>
+ You can use the command `nix-shell -p yggdrasil --run "yggdrasil -genconf"`
to generate default configuration values with documentation.
'';
};
diff --git a/nixos/modules/services/security/haka.nix b/nixos/modules/services/security/haka.nix
index cbc2ce24ac6a..893ab89d2a86 100644
--- a/nixos/modules/services/security/haka.nix
+++ b/nixos/modules/services/security/haka.nix
@@ -61,7 +61,7 @@ in
default = pkgs.haka;
defaultText = literalExpression "pkgs.haka";
type = types.package;
- description = ''
+ description = lib.mdDoc ''
Which Haka derivation to use.
'';
};
diff --git a/nixos/modules/services/security/oauth2_proxy.nix b/nixos/modules/services/security/oauth2_proxy.nix
index e22c3a52f8db..e0b22d3f38eb 100644
--- a/nixos/modules/services/security/oauth2_proxy.nix
+++ b/nixos/modules/services/security/oauth2_proxy.nix
@@ -160,9 +160,9 @@ in
domains = mkOption {
type = types.listOf types.str;
default = [];
- description = ''
+ description = lib.mdDoc ''
Authenticate emails with the specified domains. Use
- <literal>*</literal> to authenticate any email.
+ `*` to authenticate any email.
'';
};
diff --git a/nixos/modules/services/security/privacyidea.nix b/nixos/modules/services/security/privacyidea.nix
index 3edec20515eb..ce98b0393ee7 100644
--- a/nixos/modules/services/security/privacyidea.nix
+++ b/nixos/modules/services/security/privacyidea.nix
@@ -204,11 +204,11 @@ in
settings = mkOption {
type = with types; attrsOf (attrsOf (oneOf [ str bool int (listOf str) ]));
default = {};
- description = ''
- Attribute-set containing the settings for <literal>privacyidea-ldap-proxy</literal>.
+ description = lib.mdDoc ''
+ Attribute-set containing the settings for `privacyidea-ldap-proxy`.
It's possible to pass secrets using env-vars as substitutes and
- use the option <xref linkend="opt-services.privacyidea.ldap-proxy.environmentFile"/>
- to inject them via <literal>envsubst</literal>.
+ use the option [](#opt-services.privacyidea.ldap-proxy.environmentFile)
+ to inject them via `envsubst`.
'';
};
diff --git a/nixos/modules/services/web-apps/discourse.nix b/nixos/modules/services/web-apps/discourse.nix
index c815e60b756b..0ebc6f5399c0 100644
--- a/nixos/modules/services/web-apps/discourse.nix
+++ b/nixos/modules/services/web-apps/discourse.nix
@@ -121,15 +121,15 @@ in
max_reqs_per_ip_mode = "warn+block";
};
'';
- description = ''
+ description = lib.mdDoc ''
Additional settings to put in the
- <filename>discourse.conf</filename> file.
+ {file}`discourse.conf` file.
Look in the
- <link xlink:href="https://github.com/discourse/discourse/blob/master/config/discourse_defaults.conf">discourse_defaults.conf</link>
+ [discourse_defaults.conf](https://github.com/discourse/discourse/blob/master/config/discourse_defaults.conf)
file in the upstream distribution to find available options.
- Setting an option to <literal>null</literal> means
+ Setting an option to `null` means
“define variable, but leave right-hand side empty”.
'';
};
@@ -240,8 +240,8 @@ in
host = lib.mkOption {
type = with lib.types; nullOr str;
default = null;
- description = ''
- Discourse database hostname. <literal>null</literal> means
+ description = lib.mdDoc ''
+ Discourse database hostname. `null` means
“prefer local unix socket connection”.
'';
};
@@ -493,7 +493,7 @@ in
discourse-github
];
'';
- description = ''
+ description = lib.mdDoc ''
Plugins to install as part of Discourse, expressed as a list of derivations.
'';
};
diff --git a/nixos/modules/services/web-apps/hedgedoc.nix b/nixos/modules/services/web-apps/hedgedoc.nix
index 97ed4c90c780..f1c450005ac0 100644
--- a/nixos/modules/services/web-apps/hedgedoc.nix
+++ b/nixos/modules/services/web-apps/hedgedoc.nix
@@ -189,9 +189,9 @@ in
allowAnonymousEdits = mkOption {
type = types.bool;
default = false;
- description = ''
- Whether to allow guests to edit existing notes with the <literal>freely</literal> permission,
- when <option>allowAnonymous</option> is enabled.
+ description = lib.mdDoc ''
+ Whether to allow guests to edit existing notes with the `freely` permission,
+ when {option}`allowAnonymous` is enabled.
'';
};
allowFreeURL = mkOption {
@@ -953,10 +953,10 @@ in
email = mkOption {
type = types.str;
default = "";
- description = ''
- Attribute map for <literal>email</literal>.
- Defaults to <literal>NameID</literal> of SAML response if
- <option>identifierFormat</option> has
+ description = lib.mdDoc ''
+ Attribute map for `email`.
+ Defaults to `NameID` of SAML response if
+ {option}`identifierFormat` has
the default value.
'';
};
diff --git a/nixos/modules/services/web-apps/invidious.nix b/nixos/modules/services/web-apps/invidious.nix
index 0b9d9b03c6ae..cf6e7f92f071 100644
--- a/nixos/modules/services/web-apps/invidious.nix
+++ b/nixos/modules/services/web-apps/invidious.nix
@@ -246,11 +246,11 @@ in
nginx.enable = lib.mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Whether to configure nginx as a reverse proxy for Invidious.
- It serves it under the domain specified in <option>services.invidious.settings.domain</option> with enabled TLS and ACME.
- Further configuration can be done through <option>services.nginx.virtualHosts.''${config.services.invidious.settings.domain}.*</option>,
+ It serves it under the domain specified in {option}`services.invidious.settings.domain` with enabled TLS and ACME.
+ Further configuration can be done through {option}`services.nginx.virtualHosts.''${config.services.invidious.settings.domain}.*`,
which can also be used to disable AMCE and TLS.
'';
};
diff --git a/nixos/modules/services/web-apps/isso.nix b/nixos/modules/services/web-apps/isso.nix
index 37fa2f6a8b21..a5d3d8bd7305 100644
--- a/nixos/modules/services/web-apps/isso.nix
+++ b/nixos/modules/services/web-apps/isso.nix
@@ -20,10 +20,10 @@ in {
'';
settings = mkOption {
- description = ''
- Configuration for <literal>isso</literal>.
+ description = lib.mdDoc ''
+ Configuration for `isso`.
- See <link xlink:href="https://posativ.org/isso/docs/configuration/server/">Isso Server Configuration</link>
+ See [Isso Server Configuration](https://posativ.org/isso/docs/configuration/server/)
for supported values.
'';
diff --git a/nixos/modules/services/web-apps/mastodon.nix b/nixos/modules/services/web-apps/mastodon.nix
index 7fb904f77f40..5abaad85b4f3 100644
--- a/nixos/modules/services/web-apps/mastodon.nix
+++ b/nixos/modules/services/web-apps/mastodon.nix
@@ -130,18 +130,18 @@ in {
};
user = lib.mkOption {
- description = ''
+ description = lib.mdDoc ''
User under which mastodon runs. If it is set to "mastodon",
that user will be created, otherwise it should be set to the
name of a user created elsewhere. In both cases,
- <literal>mastodon</literal> and a package containing only
- the shell script <literal>mastodon-env</literal> will be added to
+ `mastodon` and a package containing only
+ the shell script `mastodon-env` will be added to
the user's package set. To run a command from
- <literal>mastodon</literal> such as <literal>tootctl</literal>
+ `mastodon` such as `tootctl`
with the environment configured by this module use
- <literal>mastodon-env</literal>, as in:
+ `mastodon-env`, as in:
- <literal>mastodon-env tootctl accounts create newuser --email newuser@example.com</literal>
+ `mastodon-env tootctl accounts create newuser --email newuser@example.com`
'';
type = lib.types.str;
default = "mastodon";
diff --git a/nixos/modules/services/web-apps/moodle.nix b/nixos/modules/services/web-apps/moodle.nix
index 6d1a9839ca1f..03dd57753acc 100644
--- a/nixos/modules/services/web-apps/moodle.nix
+++ b/nixos/modules/services/web-apps/moodle.nix
@@ -138,7 +138,7 @@ in
createLocally = mkOption {
type = types.bool;
default = true;
- description = "Create the database and database user locally.";
+ description = lib.mdDoc "Create the database and database user locally.";
};
};
diff --git a/nixos/modules/services/web-apps/nextcloud.nix b/nixos/modules/services/web-apps/nextcloud.nix
index 1e80eb0044be..b286b1a64c3e 100644
--- a/nixos/modules/services/web-apps/nextcloud.nix
+++ b/nixos/modules/services/web-apps/nextcloud.nix
@@ -569,10 +569,10 @@ in {
secretFile = mkOption {
type = types.nullOr types.str;
default = null;
- description = ''
+ description = lib.mdDoc ''
Secret options which will be appended to nextcloud's config.php file (written as JSON, in the same
- form as the <xref linkend="opt-services.nextcloud.extraOptions"/> option), for example
- <literal>{"redis":{"password":"secret"}}</literal>.
+ form as the [](#opt-services.nextcloud.extraOptions) option), for example
+ `{"redis":{"password":"secret"}}`.
'';
};
diff --git a/nixos/modules/services/web-apps/pgpkeyserver-lite.nix b/nixos/modules/services/web-apps/pgpkeyserver-lite.nix
index bce9a1b231c3..2552441befe1 100644
--- a/nixos/modules/services/web-apps/pgpkeyserver-lite.nix
+++ b/nixos/modules/services/web-apps/pgpkeyserver-lite.nix
@@ -24,14 +24,14 @@ in
default = pkgs.pgpkeyserver-lite;
defaultText = literalExpression "pkgs.pgpkeyserver-lite";
type = types.package;
- description = ''
+ description = lib.mdDoc ''
Which webgui derivation to use.
'';
};
hostname = mkOption {
type = types.str;
- description = ''
+ description = lib.mdDoc ''
Which hostname to set the vHost to that is proxying to sks.
'';
};
@@ -40,7 +40,7 @@ in
default = builtins.head sksCfg.hkpAddress;
defaultText = literalExpression "head config.${sksOpt.hkpAddress}";
type = types.str;
- description = ''
+ description = lib.mdDoc ''
Wich ip address the sks-keyserver is listening on.
'';
};
@@ -49,7 +49,7 @@ in
default = sksCfg.hkpPort;
defaultText = literalExpression "config.${sksOpt.hkpPort}";
type = types.int;
- description = ''
+ description = lib.mdDoc ''
Which port the sks-keyserver is listening on.
'';
};
diff --git a/nixos/modules/services/web-apps/plausible.nix b/nixos/modules/services/web-apps/plausible.nix
index 00b1cf3ce3f5..00e16b09b1ec 100644
--- a/nixos/modules/services/web-apps/plausible.nix
+++ b/nixos/modules/services/web-apps/plausible.nix
@@ -49,8 +49,8 @@ in {
url = mkOption {
default = "http://localhost:8123/default";
type = types.str;
- description = ''
- The URL to be used to connect to <literal>clickhouse</literal>.
+ description = lib.mdDoc ''
+ The URL to be used to connect to `clickhouse`.
'';
};
};
@@ -66,8 +66,8 @@ in {
socket = mkOption {
default = "/run/postgresql";
type = types.str;
- description = ''
- Path to the UNIX domain-socket to communicate with <literal>postgres</literal>.
+ description = lib.mdDoc ''
+ Path to the UNIX domain-socket to communicate with `postgres`.
'';
};
};
diff --git a/nixos/modules/services/web-apps/rss-bridge.nix b/nixos/modules/services/web-apps/rss-bridge.nix
index b1a3907d1964..bef3d9de2a10 100644
--- a/nixos/modules/services/web-apps/rss-bridge.nix
+++ b/nixos/modules/services/web-apps/rss-bridge.nix
@@ -66,10 +66,10 @@ in
"Twitter"
]
'';
- description = ''
+ description = lib.mdDoc ''
List of bridges to be whitelisted.
If the list is empty, rss-bridge will use whitelist.default.txt.
- Use <literal>[ "*" ]</literal> to whitelist all.
+ Use `[ "*" ]` to whitelist all.
'';
};
};
diff --git a/nixos/modules/services/web-apps/wiki-js.nix b/nixos/modules/services/web-apps/wiki-js.nix
index 76fc37c88b53..c648cfff6cef 100644
--- a/nixos/modules/services/web-apps/wiki-js.nix
+++ b/nixos/modules/services/web-apps/wiki-js.nix
@@ -54,10 +54,10 @@ in {
type = mkOption {
default = "postgres";
type = types.enum [ "postgres" "mysql" "mariadb" "mssql" ];
- description = ''
- Database driver to use for persistence. Please note that <literal>sqlite</literal>
+ description = lib.mdDoc ''
+ Database driver to use for persistence. Please note that `sqlite`
is currently not supported as the build process for it is currently not implemented
- in <literal>pkgs.wiki-js</literal> and it's not recommended by upstream for
+ in `pkgs.wiki-js` and it's not recommended by upstream for
production use.
'';
};
diff --git a/nixos/modules/services/web-servers/nginx/default.nix b/nixos/modules/services/web-servers/nginx/default.nix
index c29c9ca4f1c2..0c4b2246a1b2 100644
--- a/nixos/modules/services/web-servers/nginx/default.nix
+++ b/nixos/modules/services/web-servers/nginx/default.nix
@@ -390,7 +390,7 @@ in
statusPage = mkOption {
default = false;
type = types.bool;
- description = ''
+ description = lib.mdDoc ''
Enable status page reachable from localhost on http://127.0.0.1/nginx_status.
'';
};
@@ -398,7 +398,7 @@ in
recommendedTlsSettings = mkOption {
default = false;
type = types.bool;
- description = ''
+ description = lib.mdDoc ''
Enable recommended TLS settings.
'';
};
@@ -406,7 +406,7 @@ in
recommendedOptimisation = mkOption {
default = false;
type = types.bool;
- description = ''
+ description = lib.mdDoc ''
Enable recommended optimisation settings.
'';
};
@@ -414,7 +414,7 @@ in
recommendedGzipSettings = mkOption {
default = false;
type = types.bool;
- description = ''
+ description = lib.mdDoc ''
Enable recommended gzip settings.
'';
};
@@ -422,7 +422,7 @@ in
recommendedProxySettings = mkOption {
default = false;
type = types.bool;
- description = ''
+ description = lib.mdDoc ''
Whether to enable recommended proxy settings if a vhost does not specify the option manually.
'';
};
@@ -431,7 +431,7 @@ in
type = types.str;
default = "60s";
example = "20s";
- description = ''
+ description = lib.mdDoc ''
Change the proxy related timeouts in recommendedProxySettings.
'';
};
@@ -441,7 +441,7 @@ in
default = [ "0.0.0.0" ] ++ optional enableIPv6 "[::0]";
defaultText = literalExpression ''[ "0.0.0.0" ] ++ lib.optional config.networking.enableIPv6 "[::0]"'';
example = literalExpression ''[ "10.0.0.12" "[2002:a00:1::]" ]'';
- description = ''
+ description = lib.mdDoc ''
If vhosts do not specify listenAddresses, use these addresses by default.
'';
};
@@ -453,10 +453,10 @@ in
apply = p: p.override {
modules = p.modules ++ cfg.additionalModules;
};
- description = ''
+ description = lib.mdDoc ''
Nginx package to use. This defaults to the stable version. Note
that the nginx team recommends to use the mainline version which
- available in nixpkgs as <literal>nginxMainline</literal>.
+ available in nixpkgs as `nginxMainline`.
'';
};
@@ -474,7 +474,7 @@ in
logError = mkOption {
default = "stderr";
type = types.str;
- description = ''
+ description = lib.mdDoc ''
Configures logging.
The first parameter defines a file that will store the log. The
special value stderr selects the standard error file. Logging to
@@ -491,7 +491,7 @@ in
preStart = mkOption {
type = types.lines;
default = "";
- description = ''
+ description = lib.mdDoc ''
Shell commands executed before the service's nginx is started.
'';
};
@@ -551,7 +551,7 @@ in
httpConfig = mkOption {
type = types.lines;
default = "";
- description = ''
+ description = lib.mdDoc ''
Configuration lines to be set inside the http block.
This is mutually exclusive with the structured configuration
via virtualHosts and the recommendedXyzSettings configuration
@@ -569,7 +569,7 @@ in
proxy_pass 192.168.0.1:53535;
}
'';
- description = ''
+ description = lib.mdDoc ''
Configuration lines to be set inside the stream block.
'';
};
@@ -585,7 +585,7 @@ in
appendHttpConfig = mkOption {
type = types.lines;
default = "";
- description = ''
+ description = lib.mdDoc ''
Configuration lines to be appended to the generated http block.
This is mutually exclusive with using config and httpConfig for
specifying the whole http block verbatim.
@@ -595,10 +595,10 @@ in
enableReload = mkOption {
default = false;
type = types.bool;
- description = ''
+ description = lib.mdDoc ''
Reload nginx when configuration file changes (instead of restart).
- The configuration file is exposed at <filename>/etc/nginx/nginx.conf</filename>.
- See also <literal>systemd.services.*.restartIfChanged</literal>.
+ The configuration file is exposed at {file}`/etc/nginx/nginx.conf`.
+ See also `systemd.services.*.restartIfChanged`.
'';
};
diff --git a/nixos/modules/services/web-servers/nginx/vhost-options.nix b/nixos/modules/services/web-servers/nginx/vhost-options.nix
index d8d43bbdadef..96006f88758e 100644
--- a/nixos/modules/services/web-servers/nginx/vhost-options.nix
+++ b/nixos/modules/services/web-servers/nginx/vhost-options.nix
@@ -197,12 +197,12 @@ with lib;
http3 = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Whether to enable HTTP 3.
- This requires using <literal>pkgs.nginxQuic</literal> package
- which can be achieved by setting <literal>services.nginx.package = pkgs.nginxQuic;</literal>.
+ This requires using `pkgs.nginxQuic` package
+ which can be achieved by setting `services.nginx.package = pkgs.nginxQuic;`.
Note that HTTP 3 support is experimental and
- <emphasis>not</emphasis> yet recommended for production.
+ *not* yet recommended for production.
Read more at https://quic.nginx.org/
'';
};
diff --git a/nixos/modules/services/web-servers/tomcat.nix b/nixos/modules/services/web-servers/tomcat.nix
index a032094bf22e..95c307dba61a 100644
--- a/nixos/modules/services/web-servers/tomcat.nix
+++ b/nixos/modules/services/web-servers/tomcat.nix
@@ -112,7 +112,7 @@ in
serverXml = mkOption {
type = types.lines;
default = "";
- description = ''
+ description = lib.mdDoc ''
Verbatim server.xml configuration.
This is mutually exclusive with the virtualHosts options.
'';
diff --git a/nixos/modules/services/web-servers/varnish/default.nix b/nixos/modules/services/web-servers/varnish/default.nix
index 56722bb99d3e..c812c3664268 100644
--- a/nixos/modules/services/web-servers/varnish/default.nix
+++ b/nixos/modules/services/web-servers/varnish/default.nix
@@ -27,14 +27,14 @@ in
http_address = mkOption {
type = types.str;
default = "*:6081";
- description = ''
+ description = lib.mdDoc ''
HTTP listen address and port.
'';
};
config = mkOption {
type = types.lines;
- description = ''
+ description = lib.mdDoc ''
Verbatim default.vcl configuration.
'';
};
@@ -43,7 +43,7 @@ in
type = types.path;
default = "/var/spool/varnish/${config.networking.hostName}";
defaultText = literalExpression ''"/var/spool/varnish/''${config.networking.hostName}"'';
- description = ''
+ description = lib.mdDoc ''
Directory holding all state for Varnish to run.
'';
};
@@ -52,7 +52,7 @@ in
type = types.listOf types.package;
default = [];
example = literalExpression "[ pkgs.varnishPackages.geoip ]";
- description = ''
+ description = lib.mdDoc ''
Varnish modules (except 'std').
'';
};
@@ -61,7 +61,7 @@ in
type = types.str;
default = "";
example = "-s malloc,256M";
- description = ''
+ description = lib.mdDoc ''
Command line switches for varnishd (run 'varnishd -?' to get list of options)
'';
};
diff --git a/nixos/modules/services/x11/desktop-managers/none.nix b/nixos/modules/services/x11/desktop-managers/none.nix
index f53a2d93a14e..074b729cc3f3 100644
--- a/nixos/modules/services/x11/desktop-managers/none.nix
+++ b/nixos/modules/services/x11/desktop-managers/none.nix
@@ -8,16 +8,16 @@ in
services.xserver.desktopManager.runXdgAutostartIfNone = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Whether to run XDG autostart files for sessions without a desktop manager
(with only a window manager), these sessions usually don't handle XDG
autostart files by default.
- Some services like <option>i18n.inputMethod</option> and
- <option>service.earlyoom</option> use XDG autostart files to start.
- If this option is not set to <literal>true</literal> and you are using
+ Some services like {option}`i18n.inputMethod` and
+ {option}`service.earlyoom` use XDG autostart files to start.
+ If this option is not set to `true` and you are using
a window manager without a desktop manager, you need to manually start
- them or running <literal>dex</literal> somewhere.
+ them or running `dex` somewhere.
'';
};
};
diff --git a/nixos/modules/system/boot/luksroot.nix b/nixos/modules/system/boot/luksroot.nix
index 899f7df51e45..8cd16974916c 100644
--- a/nixos/modules/system/boot/luksroot.nix
+++ b/nixos/modules/system/boot/luksroot.nix
@@ -532,14 +532,14 @@ in
boot.initrd.luks.reusePassphrases = mkOption {
type = types.bool;
default = true;
- description = ''
+ description = lib.mdDoc ''
When opening a new LUKS device try reusing last successful
passphrase.
Useful for mounting a number of devices that use the same
passphrase without retyping it several times.
- Such setup can be useful if you use <command>cryptsetup luksSuspend</command>.
+ Such setup can be useful if you use {command}`cryptsetup luksSuspend`.
Different LUKS devices will still have
different master keys even when using the same passphrase.
'';
diff --git a/nixos/modules/tasks/auto-upgrade.nix b/nixos/modules/tasks/auto-upgrade.nix
index 309790eb0ed8..29e3e313336f 100644
--- a/nixos/modules/tasks/auto-upgrade.nix
+++ b/nixos/modules/tasks/auto-upgrade.nix
@@ -46,10 +46,10 @@ in {
type = types.nullOr types.str;
default = null;
example = "https://nixos.org/channels/nixos-14.12-small";
- description = ''
+ description = lib.mdDoc ''
The URI of the NixOS channel to use for automatic
upgrades. By default, this is the channel set using
- <command>nix-channel</command> (run <literal>nix-channel --list</literal>
+ {command}`nix-channel` (run `nix-channel --list`
to see the current value).
'';
};
diff --git a/nixos/modules/tasks/filesystems.nix b/nixos/modules/tasks/filesystems.nix
index cf9429f76b4c..2a17baf65167 100644
--- a/nixos/modules/tasks/filesystems.nix
+++ b/nixos/modules/tasks/filesystems.nix
@@ -175,20 +175,20 @@ in
}
'';
type = types.attrsOf (types.submodule [coreFileSystemOpts fileSystemOpts]);
- description = ''
+ description = lib.mdDoc ''
The file systems to be mounted. It must include an entry for
- the root directory (<literal>mountPoint = "/"</literal>). Each
+ the root directory (`mountPoint = "/"`). Each
entry in the list is an attribute set with the following fields:
- <literal>mountPoint</literal>, <literal>device</literal>,
- <literal>fsType</literal> (a file system type recognised by
- <command>mount</command>; defaults to
- <literal>"auto"</literal>), and <literal>options</literal>
- (the mount options passed to <command>mount</command> using the
- <option>-o</option> flag; defaults to <literal>[ "defaults" ]</literal>).
+ `mountPoint`, `device`,
+ `fsType` (a file system type recognised by
+ {command}`mount`; defaults to
+ `"auto"`), and `options`
+ (the mount options passed to {command}`mount` using the
+ {option}`-o` flag; defaults to `[ "defaults" ]`).
- Instead of specifying <literal>device</literal>, you can also
- specify a volume label (<literal>label</literal>) for file
- systems that support it, such as ext2/ext3 (see <command>mke2fs -L</command>).
+ Instead of specifying `device`, you can also
+ specify a volume label (`label`) for file
+ systems that support it, such as ext2/ext3 (see {command}`mke2fs -L`).
'';
};
diff --git a/nixos/modules/virtualisation/azure-image.nix b/nixos/modules/virtualisation/azure-image.nix
index 03dd3c051309..17cfd3938305 100644
--- a/nixos/modules/virtualisation/azure-image.nix
+++ b/nixos/modules/virtualisation/azure-image.nix
@@ -12,7 +12,7 @@ in
type = with types; either (enum [ "auto" ]) int;
default = "auto";
example = 2048;
- description = ''
+ description = lib.mdDoc ''
Size of disk image. Unit is MB.
'';
};
diff --git a/nixos/modules/virtualisation/google-compute-image.nix b/nixos/modules/virtualisation/google-compute-image.nix
index 133b6e9c8901..197ebb18b9ad 100644
--- a/nixos/modules/virtualisation/google-compute-image.nix
+++ b/nixos/modules/virtualisation/google-compute-image.nix
@@ -21,7 +21,7 @@ in
type = with types; either (enum [ "auto" ]) int;
default = "auto";
example = 1536;
- description = ''
+ description = lib.mdDoc ''
Size of disk image. Unit is MB.
'';
};
@@ -40,7 +40,7 @@ in
virtualisation.googleComputeImage.compressionLevel = mkOption {
type = types.int;
default = 6;
- description = ''
+ description = lib.mdDoc ''
GZIP compression level of the resulting disk image (1-9).
'';
};
diff --git a/nixos/modules/virtualisation/hyperv-image.nix b/nixos/modules/virtualisation/hyperv-image.nix
index 6845d6750092..efaea0c110d2 100644
--- a/nixos/modules/virtualisation/hyperv-image.nix
+++ b/nixos/modules/virtualisation/hyperv-image.nix
@@ -12,21 +12,21 @@ in {
type = with types; either (enum [ "auto" ]) int;
default = "auto";
example = 2048;
- description = ''
+ description = lib.mdDoc ''
The size of the hyper-v base image in MiB.
'';
};
vmDerivationName = mkOption {
type = types.str;
default = "nixos-hyperv-${config.system.nixos.label}-${pkgs.stdenv.hostPlatform.system}";
- description = ''
+ description = lib.mdDoc ''
The name of the derivation for the hyper-v appliance.
'';
};
vmFileName = mkOption {
type = types.str;
default = "nixos-${config.system.nixos.label}-${pkgs.stdenv.hostPlatform.system}.vhdx";
- description = ''
+ description = lib.mdDoc ''
The file name of the hyper-v appliance.
'';
};
diff --git a/nixos/modules/virtualisation/kvmgt.nix b/nixos/modules/virtualisation/kvmgt.nix
index 0c4694c1330d..5671e5b66dbb 100644
--- a/nixos/modules/virtualisation/kvmgt.nix
+++ b/nixos/modules/virtualisation/kvmgt.nix
@@ -10,7 +10,7 @@ let
vgpuOptions = {
uuid = mkOption {
type = with types; listOf str;
- description = "UUID(s) of VGPU device. You can generate one with <literal>libossp_uuid</literal>.";
+ description = lib.mdDoc "UUID(s) of VGPU device. You can generate one with `libossp_uuid`.";
};
};
@@ -31,9 +31,9 @@ in {
vgpus = mkOption {
default = {};
type = with types; attrsOf (submodule [ { options = vgpuOptions; } ]);
- description = ''
- Virtual GPUs to be used in Qemu. You can find devices via <command>ls /sys/bus/pci/devices/*/mdev_supported_types</command>
- and find info about device via <command>cat /sys/bus/pci/devices/*/mdev_supported_types/i915-GVTg_V5_4/description</command>
+ description = lib.mdDoc ''
+ Virtual GPUs to be used in Qemu. You can find devices via {command}`ls /sys/bus/pci/devices/*/mdev_supported_types`
+ and find info about device via {command}`cat /sys/bus/pci/devices/*/mdev_supported_types/i915-GVTg_V5_4/description`
'';
example = {
i915-GVTg_V5_8.uuid = [ "a297db4a-f4c2-11e6-90f6-d3b88d6c9525" ];
diff --git a/nixos/modules/virtualisation/lxc.nix b/nixos/modules/virtualisation/lxc.nix
index 2ae392ef931b..5bd64a5f9a56 100644
--- a/nixos/modules/virtualisation/lxc.nix
+++ b/nixos/modules/virtualisation/lxc.nix
@@ -53,9 +53,9 @@ in
type = types.lines;
default = "";
description =
- ''
+ lib.mdDoc ''
This is the config file for managing unprivileged user network
- administration access in LXC. See <citerefentry><refentrytitle>lxc-usernet</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+ administration access in LXC. See {manpage}`lxc-usernet(5)`.
'';
};
};
diff --git a/nixos/modules/virtualisation/nixos-containers.nix b/nixos/modules/virtualisation/nixos-containers.nix
index 1285563c6463..f15511f2df54 100644
--- a/nixos/modules/virtualisation/nixos-containers.nix
+++ b/nixos/modules/virtualisation/nixos-containers.nix
@@ -536,13 +536,13 @@ in
type = types.path;
default = pkgs.path;
defaultText = literalExpression "pkgs.path";
- description = ''
+ description = lib.mdDoc ''
A path to the nixpkgs that provide the modules, pkgs and lib for evaluating the container.
- To only change the <literal>pkgs</literal> argument used inside the container modules,
- set the <literal>nixpkgs.*</literal> options in the container <option>config</option>.
- Setting <literal>config.nixpkgs.pkgs = pkgs</literal> speeds up the container evaluation
- by reusing the system pkgs, but the <literal>nixpkgs.config</literal> option in the
+ To only change the `pkgs` argument used inside the container modules,
+ set the `nixpkgs.*` options in the container {option}`config`.
+ Setting `config.nixpkgs.pkgs = pkgs` speeds up the container evaluation
+ by reusing the system pkgs, but the `nixpkgs.config` option in the
container config is ignored in this case.
'';
};
diff --git a/nixos/modules/virtualisation/podman/network-socket.nix b/nixos/modules/virtualisation/podman/network-socket.nix
index 523cbd00715b..a10597175ab9 100644
--- a/nixos/modules/virtualisation/podman/network-socket.nix
+++ b/nixos/modules/virtualisation/podman/network-socket.nix
@@ -17,16 +17,16 @@ in
enable = mkOption {
type = types.bool;
default = false;
- description = ''
+ description = lib.mdDoc ''
Make the Podman and Docker compatibility API available over the network
with TLS client certificate authentication.
This allows Docker clients to connect with the equivalents of the Docker
- CLI <literal>-H</literal> and <literal>--tls*</literal> family of options.
+ CLI `-H` and `--tls*` family of options.
For certificate setup, see https://docs.docker.com/engine/security/protect-access/
- This option is independent of <xref linkend="opt-virtualisation.podman.dockerSocket.enable"/>.
+ This option is independent of [](#opt-virtualisation.podman.dockerSocket.enable).
'';
};
diff --git a/nixos/modules/virtualisation/proxmox-image.nix b/nixos/modules/virtualisation/proxmox-image.nix
index e07d1d1eb3fc..4076d68b93ef 100644
--- a/nixos/modules/virtualisation/proxmox-image.nix
+++ b/nixos/modules/virtualisation/proxmox-image.nix
@@ -10,7 +10,7 @@ with lib;
type = types.str;
default = "";
example = "order=scsi0;net0";
- description = ''
+ description = lib.mdDoc ''
Default boot device. PVE will try all devices in its default order if this value is empty.
'';
};
@@ -18,16 +18,16 @@ with lib;
type = types.str;
default = "virtio-scsi-pci";
example = "lsi";
- description = ''
+ description = lib.mdDoc ''
SCSI controller type. Must be one of the supported values given in
- <link xlink:href="https://pve.proxmox.com/wiki/Qemu/KVM_Virtual_Machines"/>
+ <https://pve.proxmox.com/wiki/Qemu/KVM_Virtual_Machines>
'';
};
virtio0 = mkOption {
type = types.str;
default = "local-lvm:vm-9999-disk-0";
example = "ceph:vm-123-disk-0";
- description = ''
+ description = lib.mdDoc ''
Configuration for the default virtio disk. It can be used as a cue for PVE to autodetect the target sotrage.
This parameter is required by PVE even if it isn't used.
'';
@@ -35,21 +35,21 @@ with lib;
ostype = mkOption {
type = types.str;
default = "l26";
- description = ''
+ description = lib.mdDoc ''
Guest OS type
'';
};
cores = mkOption {
type = types.ints.positive;
default = 1;
- description = ''
+ description = lib.mdDoc ''
Guest core count
'';
};
memory = mkOption {
type = types.ints.positive;
default = 1024;
- description = ''
+ description = lib.mdDoc ''
Guest memory in MB
'';
};
@@ -58,14 +58,14 @@ with lib;
name = mkOption {
type = types.str;
default = "nixos-${config.system.nixos.label}";
- description = ''
+ description = lib.mdDoc ''
VM name
'';
};
net0 = mkOption {
type = types.commas;
default = "virtio=00:00:00:00:00:00,bridge=vmbr0,firewall=1";
- description = ''
+ description = lib.mdDoc ''
Configuration for the default interface. When restoring from VMA, check the
"unique" box to ensure device mac is randomized.
'';
@@ -74,7 +74,7 @@ with lib;
type = types.str;
default = "socket";
example = "/dev/ttyS0";
- description = ''
+ description = lib.mdDoc ''
Create a serial device inside the VM (n is 0 to 3), and pass through a host serial device (i.e. /dev/ttyS0),
or create a unix socket on the host side (use qm terminal to open a terminal connection).
'';
@@ -83,7 +83,7 @@ with lib;
type = types.bool;
apply = x: if x then "1" else "0";
default = true;
- description = ''
+ description = lib.mdDoc ''
Expect guest to have qemu agent running
'';
};
@@ -95,7 +95,7 @@ with lib;
cpu = "host";
onboot = 1;
}'';
- description = ''
+ description = lib.mdDoc ''
Additional options appended to qemu-server.conf
'';
};
@@ -103,7 +103,7 @@ with lib;
type = types.str;
default = config.proxmox.qemuConf.name;
example = "999-nixos_template";
- description = ''
+ description = lib.mdDoc ''
Filename of the image will be vzdump-qemu-''${filenameSuffix}.vma.zstd.
This will also determine the default name of the VM on restoring the VMA.
Start this value with a number if you want the VMA to be detected as a backup of
diff --git a/nixos/modules/virtualisation/qemu-vm.nix b/nixos/modules/virtualisation/qemu-vm.nix
index 630613909152..5cb2a99bc3f7 100644
--- a/nixos/modules/virtualisation/qemu-vm.nix
+++ b/nixos/modules/virtualisation/qemu-vm.nix
@@ -739,10 +739,10 @@ in
type = types.nullOr types.package;
default = null;
description =
- ''
- An alternate BIOS (such as <literal>qboot</literal>) with which to start the VM.
- Should contain a file named <literal>bios.bin</literal>.
- If <literal>null</literal>, QEMU's builtin SeaBIOS will be used.
+ lib.mdDoc ''
+ An alternate BIOS (such as `qboot`) with which to start the VM.
+ Should contain a file named `bios.bin`.
+ If `null`, QEMU's builtin SeaBIOS will be used.
'';
};
diff --git a/nixos/modules/virtualisation/vmware-image.nix b/nixos/modules/virtualisation/vmware-image.nix
index f6cd12e2bb79..a38713b4d4ee 100644
--- a/nixos/modules/virtualisation/vmware-image.nix
+++ b/nixos/modules/virtualisation/vmware-image.nix
@@ -21,34 +21,34 @@ in {
type = with types; either (enum [ "auto" ]) int;
default = "auto";
example = 2048;
- description = ''
+ description = lib.mdDoc ''
The size of the VMWare base image in MiB.
'';
};
vmDerivationName = mkOption {
type = types.str;
default = "nixos-vmware-${config.system.nixos.label}-${pkgs.stdenv.hostPlatform.system}";
- description = ''
+ description = lib.mdDoc ''
The name of the derivation for the VMWare appliance.
'';
};
vmFileName = mkOption {
type = types.str;
default = "nixos-${config.system.nixos.label}-${pkgs.stdenv.hostPlatform.system}.vmdk";
- description = ''
+ description = lib.mdDoc ''
The file name of the VMWare appliance.
'';
};
vmSubformat = mkOption {
type = types.enum subformats;
default = "monolithicSparse";
- description = "Specifies which VMDK subformat to use.";
+ description = lib.mdDoc "Specifies which VMDK subformat to use.";
};
vmCompat6 = mkOption {
type = types.bool;
default = false;
example = true;
- description = "Create a VMDK version 6 image (instead of version 4).";
+ description = lib.mdDoc "Create a VMDK version 6 image (instead of version 4).";
};
};
};