diff options
70 files changed, 96 insertions, 96 deletions
diff --git a/nixos/modules/hardware/corectrl.nix b/nixos/modules/hardware/corectrl.nix index 3185f6486c71..345ec479e736 100644 --- a/nixos/modules/hardware/corectrl.nix +++ b/nixos/modules/hardware/corectrl.nix @@ -20,7 +20,7 @@ in type = types.str; default = "0xfffd7fff"; example = "0xffffffff"; - description = '' + description = lib.mdDoc '' Sets the `amdgpu.ppfeaturemask` kernel option. In particular, it is used here to set the overdrive bit. Default is `0xfffd7fff` as it is less likely to cause flicker issues. diff --git a/nixos/modules/misc/wordlist.nix b/nixos/modules/misc/wordlist.nix index 988b522d7431..72ef226ca651 100644 --- a/nixos/modules/misc/wordlist.nix +++ b/nixos/modules/misc/wordlist.nix @@ -23,7 +23,7 @@ in } ''; - description = '' + description = lib.mdDoc '' A set with the key names being the environment variable you'd like to set and the values being a list of paths to text documents containing lists of words. The various files will be merged, sorted, duplicates diff --git a/nixos/modules/programs/mosh.nix b/nixos/modules/programs/mosh.nix index 31aadb6aba61..9e56e1731d7c 100644 --- a/nixos/modules/programs/mosh.nix +++ b/nixos/modules/programs/mosh.nix @@ -17,7 +17,7 @@ in type = lib.types.bool; }; withUtempter = mkOption { - description = '' + description = lib.mdDoc '' Whether to enable libutempter for mosh. This is required so that mosh can write to /var/run/utmp (which can be queried with `who` to display currently connected user sessions). Note, this will add a guid wrapper for the group utmp! diff --git a/nixos/modules/programs/msmtp.nix b/nixos/modules/programs/msmtp.nix index fbdab2cac559..023ffdd444b8 100644 --- a/nixos/modules/programs/msmtp.nix +++ b/nixos/modules/programs/msmtp.nix @@ -45,7 +45,7 @@ in { passwordeval = "cat /secrets/password.txt"; }; }; - description = '' + description = lib.mdDoc '' Named accounts and their respective configurations. The special name "default" allows a default account to be defined. See msmtp(1) for the available options. diff --git a/nixos/modules/programs/thefuck.nix b/nixos/modules/programs/thefuck.nix index 18d09e26866c..6b939cce4195 100644 --- a/nixos/modules/programs/thefuck.nix +++ b/nixos/modules/programs/thefuck.nix @@ -22,7 +22,7 @@ in default = "fuck"; type = types.str; - description = '' + description = lib.mdDoc '' `thefuck` needs an alias to be configured. The default value is `fuck`, but you can use anything else as well. ''; diff --git a/nixos/modules/programs/yabar.nix b/nixos/modules/programs/yabar.nix index 0ec668ada8eb..c6eb0eb10c34 100644 --- a/nixos/modules/programs/yabar.nix +++ b/nixos/modules/programs/yabar.nix @@ -62,7 +62,7 @@ in to use `yabar-unstable'. ''; - description = '' + description = lib.mdDoc '' The package which contains the `yabar` binary. Nixpkgs provides the `yabar` and `yabar-unstable` diff --git a/nixos/modules/programs/zsh/oh-my-zsh.nix b/nixos/modules/programs/zsh/oh-my-zsh.nix index b253b803edcc..41ea31b0f122 100644 --- a/nixos/modules/programs/zsh/oh-my-zsh.nix +++ b/nixos/modules/programs/zsh/oh-my-zsh.nix @@ -49,7 +49,7 @@ in package = mkOption { default = pkgs.oh-my-zsh; defaultText = literalExpression "pkgs.oh-my-zsh"; - description = '' + description = lib.mdDoc '' Package to install for `oh-my-zsh` usage. ''; @@ -67,7 +67,7 @@ in custom = mkOption { default = null; type = with types; nullOr str; - description = '' + description = lib.mdDoc '' Path to a custom oh-my-zsh package to override config of oh-my-zsh. (Can't be used along with `customPkgs`). ''; @@ -76,7 +76,7 @@ in customPkgs = mkOption { default = []; type = types.listOf types.package; - description = '' + description = lib.mdDoc '' List of custom packages that should be loaded into `oh-my-zsh`. ''; }; @@ -92,7 +92,7 @@ in cacheDir = mkOption { default = "$HOME/.cache/oh-my-zsh"; type = types.str; - description = '' + description = lib.mdDoc '' Cache directory to be used by `oh-my-zsh`. Without this option it would default to the read-only nix store. ''; diff --git a/nixos/modules/programs/zsh/zsh-autoenv.nix b/nixos/modules/programs/zsh/zsh-autoenv.nix index 62f497a45dd0..46fc4d49c597 100644 --- a/nixos/modules/programs/zsh/zsh-autoenv.nix +++ b/nixos/modules/programs/zsh/zsh-autoenv.nix @@ -11,7 +11,7 @@ in { package = mkOption { default = pkgs.zsh-autoenv; defaultText = literalExpression "pkgs.zsh-autoenv"; - description = '' + description = lib.mdDoc '' Package to install for `zsh-autoenv` usage. ''; diff --git a/nixos/modules/programs/zsh/zsh-autosuggestions.nix b/nixos/modules/programs/zsh/zsh-autosuggestions.nix index b6c36a082e77..92a3fc081370 100644 --- a/nixos/modules/programs/zsh/zsh-autosuggestions.nix +++ b/nixos/modules/programs/zsh/zsh-autosuggestions.nix @@ -24,7 +24,7 @@ in strategy = mkOption { type = types.listOf (types.enum [ "history" "completion" "match_prev_cmd" ]); default = [ "history" ]; - description = '' + description = lib.mdDoc '' `ZSH_AUTOSUGGEST_STRATEGY` is an array that specifies how suggestions should be generated. The strategies in the array are tried successively until a suggestion is found. There are currently three built-in strategies to choose from: diff --git a/nixos/modules/security/acme/default.nix b/nixos/modules/security/acme/default.nix index 1df6d9eba953..f85cf2fc1211 100644 --- a/nixos/modules/security/acme/default.nix +++ b/nixos/modules/security/acme/default.nix @@ -676,7 +676,7 @@ let inheritDefaults = mkOption { default = true; example = true; - description = "Whether to inherit values set in `security.acme.defaults` or not."; + description = lib.mdDoc "Whether to inherit values set in `security.acme.defaults` or not."; type = lib.types.bool; }; }; diff --git a/nixos/modules/security/sudo.nix b/nixos/modules/security/sudo.nix index faa99a31a6d6..68ceb6c230eb 100644 --- a/nixos/modules/security/sudo.nix +++ b/nixos/modules/security/sudo.nix @@ -46,7 +46,7 @@ in type = types.package; default = pkgs.sudo; defaultText = literalExpression "pkgs.sudo"; - description = '' + description = lib.mdDoc '' Which package to use for `sudo`. ''; }; diff --git a/nixos/modules/services/continuous-integration/buildkite-agents.nix b/nixos/modules/services/continuous-integration/buildkite-agents.nix index cafa40dc6e5f..8e8a65b56b78 100644 --- a/nixos/modules/services/continuous-integration/buildkite-agents.nix +++ b/nixos/modules/services/continuous-integration/buildkite-agents.nix @@ -193,7 +193,7 @@ in options.services.buildkite-agents = mkOption { type = types.attrsOf (types.submodule buildkiteOptions); default = {}; - description = '' + description = lib.mdDoc '' Attribute set of buildkite agents. The attribute key is combined with the hostname and a unique integer to create the final agent name. This can be overridden by setting the `name` diff --git a/nixos/modules/services/continuous-integration/hydra/default.nix b/nixos/modules/services/continuous-integration/hydra/default.nix index 7159ec287fc8..af6d86cd96b0 100644 --- a/nixos/modules/services/continuous-integration/hydra/default.nix +++ b/nixos/modules/services/continuous-integration/hydra/default.nix @@ -87,7 +87,7 @@ in type = types.str; default = localDB; example = "dbi:Pg:dbname=hydra;host=postgres.example.org;user=foo;"; - description = '' + description = lib.mdDoc '' The DBI string for Hydra database connection. NOTE: Attempts to set `application_name` will be overridden by diff --git a/nixos/modules/services/development/lorri.nix b/nixos/modules/services/development/lorri.nix index a82b3f57f8e8..8c64e3d9a560 100644 --- a/nixos/modules/services/development/lorri.nix +++ b/nixos/modules/services/development/lorri.nix @@ -9,7 +9,7 @@ in { enable = lib.mkOption { default = false; type = lib.types.bool; - description = '' + description = lib.mdDoc '' Enables the daemon for `lorri`, a nix-shell replacement for project development. The socket-activated daemon starts on the first request issued by the `lorri` command. diff --git a/nixos/modules/services/editors/infinoted.nix b/nixos/modules/services/editors/infinoted.nix index d2eb4946f2fb..c91197ea57b1 100644 --- a/nixos/modules/services/editors/infinoted.nix +++ b/nixos/modules/services/editors/infinoted.nix @@ -36,7 +36,7 @@ in { certificateChain = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' Chain of CA-certificates to which our `certificateFile` is relative. Optional for TLS. ''; diff --git a/nixos/modules/services/games/crossfire-server.nix b/nixos/modules/services/games/crossfire-server.nix index a0dc1e6c564c..7820a08be40b 100644 --- a/nixos/modules/services/games/crossfire-server.nix +++ b/nixos/modules/services/games/crossfire-server.nix @@ -41,7 +41,7 @@ in { stateDir = mkOption { type = types.str; default = "/var/lib/crossfire"; - description = '' + description = lib.mdDoc '' Where to store runtime data (save files, persistent items, etc). If left at the default, this will be automatically created on server @@ -61,7 +61,7 @@ in { configFiles = mkOption { type = types.attrsOf types.str; - description = '' + description = lib.mdDoc '' Text to append to the corresponding configuration files. Note that the files given in the example are *not* the complete set of files available to customize; look in /etc/crossfire after enabling the server to see diff --git a/nixos/modules/services/games/deliantra-server.nix b/nixos/modules/services/games/deliantra-server.nix index 17bdf2aef776..f39044eda7c7 100644 --- a/nixos/modules/services/games/deliantra-server.nix +++ b/nixos/modules/services/games/deliantra-server.nix @@ -41,7 +41,7 @@ in { stateDir = mkOption { type = types.str; default = "/var/lib/deliantra"; - description = '' + description = lib.mdDoc '' Where to store runtime data (save files, persistent items, etc). If left at the default, this will be automatically created on server diff --git a/nixos/modules/services/games/minetest-server.nix b/nixos/modules/services/games/minetest-server.nix index bc6ab7462d6b..34e0ba8c8e5c 100644 --- a/nixos/modules/services/games/minetest-server.nix +++ b/nixos/modules/services/games/minetest-server.nix @@ -25,7 +25,7 @@ in gameId = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Id of the game to use. To list available games run `minetestserver --gameid list`. @@ -36,7 +36,7 @@ in world = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' Name of the world to use. To list available worlds run `minetestserver --world list`. @@ -47,7 +47,7 @@ in configPath = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' Path to the config to use. If set to null, the config of the running user will be used: diff --git a/nixos/modules/services/logging/logrotate.nix b/nixos/modules/services/logging/logrotate.nix index 53230cc51e59..3ea130a891d4 100644 --- a/nixos/modules/services/logging/logrotate.nix +++ b/nixos/modules/services/logging/logrotate.nix @@ -79,7 +79,7 @@ let priority = mkOption { type = types.int; default = 1000; - description = '' + description = lib.mdDoc '' Order of this logrotate block in relation to the others. The semantics are the same as with `lib.mkOrder`. Smaller values have a greater priority. ''; @@ -260,7 +260,7 @@ in priority = mkOption { type = types.int; default = 1000; - description = '' + description = lib.mdDoc '' Order of this logrotate block in relation to the others. The semantics are the same as with `lib.mkOrder`. Smaller values are inserted first. ''; diff --git a/nixos/modules/services/matrix/synapse.nix b/nixos/modules/services/matrix/synapse.nix index 0dbfcc17638d..a40ed93b4a6d 100644 --- a/nixos/modules/services/matrix/synapse.nix +++ b/nixos/modules/services/matrix/synapse.nix @@ -516,7 +516,7 @@ in { type = types.bool; default = true; example = false; - description = '' + description = lib.mdDoc '' Is the preview URL API enabled? If enabled, you *must* specify an explicit url_preview_ip_range_blacklist of IPs that the spider is denied from accessing. diff --git a/nixos/modules/services/misc/gitea.nix b/nixos/modules/services/misc/gitea.nix index 048ff3211654..5bcc0fbc7e19 100644 --- a/nixos/modules/services/misc/gitea.nix +++ b/nixos/modules/services/misc/gitea.nix @@ -183,7 +183,7 @@ in file = mkOption { type = types.nullOr types.str; default = null; - description = "Filename to be used for the dump. If `null` a default name is choosen by gitea."; + description = lib.mdDoc "Filename to be used for the dump. If `null` a default name is choosen by gitea."; example = "gitea-dump"; }; }; diff --git a/nixos/modules/services/misc/klipper.nix b/nixos/modules/services/misc/klipper.nix index 34e9acc71929..0dadc0c74705 100644 --- a/nixos/modules/services/misc/klipper.nix +++ b/nixos/modules/services/misc/klipper.nix @@ -82,7 +82,7 @@ in ''; configFile = mkOption { type = path; - description = "Path to firmware config which is generated using `klipper-genconf`"; + description = lib.mdDoc "Path to firmware config which is generated using `klipper-genconf`"; }; }; }); diff --git a/nixos/modules/services/misc/nix-daemon.nix b/nixos/modules/services/misc/nix-daemon.nix index a218b0048977..4022c7ebbc2f 100644 --- a/nixos/modules/services/misc/nix-daemon.nix +++ b/nixos/modules/services/misc/nix-daemon.nix @@ -264,7 +264,7 @@ in type = types.nullOr types.str; default = null; example = "/root/.ssh/id_buildhost_builduser"; - description = '' + description = lib.mdDoc '' The path to the SSH private key with which to authenticate on the build machine. The private key must not have a passphrase. If null, the building user (root on NixOS machines) must have an diff --git a/nixos/modules/services/misc/rmfakecloud.nix b/nixos/modules/services/misc/rmfakecloud.nix index 2feb663f7cb6..c1b5291ce200 100644 --- a/nixos/modules/services/misc/rmfakecloud.nix +++ b/nixos/modules/services/misc/rmfakecloud.nix @@ -50,7 +50,7 @@ in { type = with types; attrsOf str; default = { }; example = { DATADIR = "/custom/path/for/rmfakecloud/data"; }; - description = '' + description = lib.mdDoc '' Extra settings in the form of a set of key-value pairs. For tokens and secrets, use `environmentFile` instead. diff --git a/nixos/modules/services/misc/zoneminder.nix b/nixos/modules/services/misc/zoneminder.nix index ef3f6c1a0fd9..fa0e06a01480 100644 --- a/nixos/modules/services/misc/zoneminder.nix +++ b/nixos/modules/services/misc/zoneminder.nix @@ -80,7 +80,7 @@ in { webserver = mkOption { type = types.enum [ "nginx" "none" ]; default = "nginx"; - description = '' + description = lib.mdDoc '' The webserver to configure for the PHP frontend. Set it to `none` if you want to configure it yourself. PRs are welcome diff --git a/nixos/modules/services/monitoring/collectd.nix b/nixos/modules/services/monitoring/collectd.nix index 5c62d509511d..3d518ebc67a4 100644 --- a/nixos/modules/services/monitoring/collectd.nix +++ b/nixos/modules/services/monitoring/collectd.nix @@ -52,7 +52,7 @@ in { buildMinimalPackage = mkOption { default = false; - description = '' + description = lib.mdDoc '' Build a minimal collectd package with only the configured `services.collectd.plugins` ''; type = bool; diff --git a/nixos/modules/services/monitoring/datadog-agent.nix b/nixos/modules/services/monitoring/datadog-agent.nix index 9b984fafc12b..a7f6fa23aa65 100644 --- a/nixos/modules/services/monitoring/datadog-agent.nix +++ b/nixos/modules/services/monitoring/datadog-agent.nix @@ -60,7 +60,7 @@ in { package = mkOption { default = pkgs.datadog-agent; defaultText = literalExpression "pkgs.datadog-agent"; - description = '' + description = lib.mdDoc '' Which DataDog v7 agent package to use. Note that the provided package is expected to have an overridable `pythonPackages`-attribute which configures the Python environment with the Datadog @@ -168,7 +168,7 @@ in { }; checks = mkOption { - description = '' + description = lib.mdDoc '' Configuration for all Datadog checks. Keys of this attribute set will be used as the name of the check to create the appropriate configuration in `conf.d/$check.d/conf.yaml`. diff --git a/nixos/modules/services/monitoring/prometheus/default.nix b/nixos/modules/services/monitoring/prometheus/default.nix index ce7455425a63..bb79a8feb97d 100644 --- a/nixos/modules/services/monitoring/prometheus/default.nix +++ b/nixos/modules/services/monitoring/prometheus/default.nix @@ -251,7 +251,7 @@ let authorization = mkOption { type = types.nullOr types.attrs; default = null; - description = '' + description = lib.mdDoc '' Sets the `Authorization` header on every scrape request with the configured credentials. ''; }; @@ -664,7 +664,7 @@ let promTypes.dockerswarm_sd_config = mkDockerSdConfigModule { role = mkOption { type = types.enum [ "services" "tasks" "nodes" ]; - description = '' + description = lib.mdDoc '' Role of the targets to retrieve. Must be `services`, `tasks`, or `nodes`. ''; }; @@ -1222,7 +1222,7 @@ let role = mkOption { type = types.enum [ "instance" "baremetal" ]; - description = '' + description = lib.mdDoc '' Role of the targets to retrieve. Must be `instance` or `baremetal`. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/exporters/nginxlog.nix b/nixos/modules/services/monitoring/prometheus/exporters/nginxlog.nix index 9967d3647e00..9e507423c7d6 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters/nginxlog.nix +++ b/nixos/modules/services/monitoring/prometheus/exporters/nginxlog.nix @@ -10,7 +10,7 @@ in { settings = mkOption { type = types.attrs; default = {}; - description = '' + description = lib.mdDoc '' All settings of nginxlog expressed as an Nix attrset. Check the official documentation for the corresponding YAML diff --git a/nixos/modules/services/monitoring/riemann-tools.nix b/nixos/modules/services/monitoring/riemann-tools.nix index b5cd79c74301..28821267b4f3 100644 --- a/nixos/modules/services/monitoring/riemann-tools.nix +++ b/nixos/modules/services/monitoring/riemann-tools.nix @@ -37,7 +37,7 @@ in { extraArgs = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' A list of commandline-switches forwarded to a riemann-tool. See for example `riemann-health --help` for available options. ''; diff --git a/nixos/modules/services/network-filesystems/xtreemfs.nix b/nixos/modules/services/network-filesystems/xtreemfs.nix index 7b476fc7ac93..09d517740a0a 100644 --- a/nixos/modules/services/network-filesystems/xtreemfs.nix +++ b/nixos/modules/services/network-filesystems/xtreemfs.nix @@ -111,7 +111,7 @@ in uuid = mkOption { example = "eacb6bab-f444-4ebf-a06a-3f72d7465e40"; type = types.str; - description = '' + description = lib.mdDoc '' Must be set to a unique identifier, preferably a UUID according to RFC 4122. UUIDs can be generated with `uuidgen` command, found in the `util-linux` package. @@ -236,7 +236,7 @@ in uuid = mkOption { example = "eacb6bab-f444-4ebf-a06a-3f72d7465e41"; type = types.str; - description = '' + description = lib.mdDoc '' Must be set to a unique identifier, preferably a UUID according to RFC 4122. UUIDs can be generated with `uuidgen` command, found in the `util-linux` package. @@ -379,7 +379,7 @@ in uuid = mkOption { example = "eacb6bab-f444-4ebf-a06a-3f72d7465e42"; type = types.str; - description = '' + description = lib.mdDoc '' Must be set to a unique identifier, preferably a UUID according to RFC 4122. UUIDs can be generated with `uuidgen` command, found in the `util-linux` package. diff --git a/nixos/modules/services/networking/bind.nix b/nixos/modules/services/networking/bind.nix index f2948a8cc199..aaa1cc2f1000 100644 --- a/nixos/modules/services/networking/bind.nix +++ b/nixos/modules/services/networking/bind.nix @@ -117,7 +117,7 @@ in cacheNetworks = mkOption { default = [ "127.0.0.0/24" ]; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' What networks are allowed to use us as a resolver. Note that this is for recursive queries -- all networks are allowed to query zones configured with the `zones` option. diff --git a/nixos/modules/services/networking/cloudflare-dyndns.nix b/nixos/modules/services/networking/cloudflare-dyndns.nix index 5dd90cfe35ba..92d7f97b0bc4 100644 --- a/nixos/modules/services/networking/cloudflare-dyndns.nix +++ b/nixos/modules/services/networking/cloudflare-dyndns.nix @@ -13,7 +13,7 @@ in apiTokenFile = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The path to a file containing the CloudFlare API token. The file must have the form `CLOUDFLARE_API_TOKEN=...` diff --git a/nixos/modules/services/networking/dhcpcd.nix b/nixos/modules/services/networking/dhcpcd.nix index 6b7ce828919c..ac5d45a65e3b 100644 --- a/nixos/modules/services/networking/dhcpcd.nix +++ b/nixos/modules/services/networking/dhcpcd.nix @@ -155,7 +155,7 @@ in type = types.lines; default = ""; example = "if [[ $reason =~ BOUND ]]; then echo $interface: Routers are $new_routers - were $old_routers; fi"; - description = '' + description = lib.mdDoc '' Shell code that will be run after all other hooks. See `man dhcpcd-run-hooks` for details on what is possible. ''; diff --git a/nixos/modules/services/networking/ferm.nix b/nixos/modules/services/networking/ferm.nix index 7faebcef6300..ea96a736fecf 100644 --- a/nixos/modules/services/networking/ferm.nix +++ b/nixos/modules/services/networking/ferm.nix @@ -20,7 +20,7 @@ in { enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to enable Ferm Firewall. *Warning*: Enabling this service WILL disable the existing NixOS firewall! Default firewall rules provided by packages are not diff --git a/nixos/modules/services/networking/fireqos.nix b/nixos/modules/services/networking/fireqos.nix index 5469bce58c60..b7f51a89c0e1 100644 --- a/nixos/modules/services/networking/fireqos.nix +++ b/nixos/modules/services/networking/fireqos.nix @@ -10,7 +10,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' If enabled, FireQOS will be launched with the specified configuration given in `config`. ''; diff --git a/nixos/modules/services/networking/gnunet.nix b/nixos/modules/services/networking/gnunet.nix index 2ab9097e7f7d..9d1c9746f728 100644 --- a/nixos/modules/services/networking/gnunet.nix +++ b/nixos/modules/services/networking/gnunet.nix @@ -123,7 +123,7 @@ in extraOptions = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Additional options that will be copied verbatim in `gnunet.conf'. See `gnunet.conf(5)' for details. ''; diff --git a/nixos/modules/services/networking/headscale.nix b/nixos/modules/services/networking/headscale.nix index ab07e7c14b8c..23d8dac2f986 100644 --- a/nixos/modules/services/networking/headscale.nix +++ b/nixos/modules/services/networking/headscale.nix @@ -216,7 +216,7 @@ in magicDns = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to use [MagicDNS](https://tailscale.com/kb/1081/magicdns/). Only works if there is at least a nameserver defined. ''; diff --git a/nixos/modules/services/networking/iscsi/root-initiator.nix b/nixos/modules/services/networking/iscsi/root-initiator.nix index b55fda672521..4434fedce1eb 100644 --- a/nixos/modules/services/networking/iscsi/root-initiator.nix +++ b/nixos/modules/services/networking/iscsi/root-initiator.nix @@ -77,7 +77,7 @@ in }; extraConfigFile = mkOption { - description = '' + description = lib.mdDoc '' Append an additional file's contents to `/etc/iscsid.conf`. Use a non-store path and store passwords in this file. Note: the file specified here must be available in the initrd, see: `boot.initrd.secrets`. diff --git a/nixos/modules/services/networking/lokinet.nix b/nixos/modules/services/networking/lokinet.nix index 6dc33faa82b4..59622d173a35 100644 --- a/nixos/modules/services/networking/lokinet.nix +++ b/nixos/modules/services/networking/lokinet.nix @@ -95,7 +95,7 @@ in with lib; { network.exit-node = [ "example.loki" "example2.loki" ]; } ''; - description = '' + description = lib.mdDoc '' Configuration for Lokinet. Currently, the best way to view the available settings is by generating a config file using `lokinet -g`. diff --git a/nixos/modules/services/networking/monero.nix b/nixos/modules/services/networking/monero.nix index 032f6df4e79e..bac705843eb0 100644 --- a/nixos/modules/services/networking/monero.nix +++ b/nixos/modules/services/networking/monero.nix @@ -181,7 +181,7 @@ in exclusiveNodes = mkOption { type = types.listOf types.str; default = [ ]; - description = '' + description = lib.mdDoc '' List of peer IP addresses to connect to *only*. If given the other peer options will be ignored. ''; diff --git a/nixos/modules/services/networking/murmur.nix b/nixos/modules/services/networking/murmur.nix index 807caceb5bfe..73787f433b45 100644 --- a/nixos/modules/services/networking/murmur.nix +++ b/nixos/modules/services/networking/murmur.nix @@ -219,7 +219,7 @@ in registerHostname = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' DNS hostname where your server can be reached. This is only needed if you want your server to be accessed by its hostname and not IP - but the name *must* resolve on the diff --git a/nixos/modules/services/networking/nar-serve.nix b/nixos/modules/services/networking/nar-serve.nix index 09f019d41bb7..a725f4453ca2 100644 --- a/nixos/modules/services/networking/nar-serve.nix +++ b/nixos/modules/services/networking/nar-serve.nix @@ -23,7 +23,7 @@ in cacheURL = mkOption { type = types.str; default = "https://cache.nixos.org/"; - description = '' + description = lib.mdDoc '' Binary cache URL to connect to. The URL format is compatible with the nix remote url style, such as: diff --git a/nixos/modules/services/networking/nixops-dns.nix b/nixos/modules/services/networking/nixops-dns.nix index 4abdb50d6942..378c2ee6d05f 100644 --- a/nixos/modules/services/networking/nixops-dns.nix +++ b/nixos/modules/services/networking/nixops-dns.nix @@ -40,7 +40,7 @@ in dnsmasq = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Enable dnsmasq forwarding to nixops-dns. This allows to use nixops-dns for `services.nixops-dns.domain` resolution while forwarding the rest of the queries to original resolvers. diff --git a/nixos/modules/services/networking/ocserv.nix b/nixos/modules/services/networking/ocserv.nix index dc26ffeafeef..efe1d240a9a7 100644 --- a/nixos/modules/services/networking/ocserv.nix +++ b/nixos/modules/services/networking/ocserv.nix @@ -15,7 +15,7 @@ in config = mkOption { type = types.lines; - description = '' + description = lib.mdDoc '' Configuration content to start an OCServ server. For a full configuration reference,please refer to the online documentation diff --git a/nixos/modules/services/networking/redsocks.nix b/nixos/modules/services/networking/redsocks.nix index 5aa9f003bad5..85ae3125ded8 100644 --- a/nixos/modules/services/networking/redsocks.nix +++ b/nixos/modules/services/networking/redsocks.nix @@ -30,7 +30,7 @@ in type = types.str; default = "stderr"; description = - '' + lib.mdDoc '' Where to send logs. Possible values are: @@ -122,7 +122,7 @@ in "Forwarded_ipport" ]; default = "false"; description = - '' + lib.mdDoc '' Way to disclose client IP to the proxy. - "false": do not disclose http-connect supports the following ways: diff --git a/nixos/modules/services/networking/rpcbind.nix b/nixos/modules/services/networking/rpcbind.nix index 0a5df6987092..aa04214debb0 100644 --- a/nixos/modules/services/networking/rpcbind.nix +++ b/nixos/modules/services/networking/rpcbind.nix @@ -13,7 +13,7 @@ with lib; enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to enable `rpcbind', an ONC RPC directory service notably used by NFS and NIS, and which can be queried using the rpcinfo(1) command. `rpcbind` is a replacement for diff --git a/nixos/modules/services/networking/x2goserver.nix b/nixos/modules/services/networking/x2goserver.nix index 3c2424b6f4f9..a1e096c19a2a 100644 --- a/nixos/modules/services/networking/x2goserver.nix +++ b/nixos/modules/services/networking/x2goserver.nix @@ -50,7 +50,7 @@ in { settings = mkOption { type = types.attrsOf types.attrs; default = {}; - description = '' + description = lib.mdDoc '' x2goserver.conf ini configuration as nix attributes. See `x2goserver.conf(5)` for details ''; diff --git a/nixos/modules/services/networking/znc/options.nix b/nixos/modules/services/networking/znc/options.nix index 0b86c34678d1..9d472abdf484 100644 --- a/nixos/modules/services/networking/znc/options.nix +++ b/nixos/modules/services/networking/znc/options.nix @@ -118,7 +118,7 @@ in type = types.listOf types.str; default = [ "webadmin" "adminlog" ]; example = [ "partyline" "webadmin" "adminlog" "log" ]; - description = '' + description = lib.mdDoc '' A list of modules to include in the `znc.conf` file. ''; }; @@ -127,7 +127,7 @@ in type = types.listOf types.str; default = [ "chansaver" "controlpanel" ]; example = [ "chansaver" "controlpanel" "fish" "push" ]; - description = '' + description = lib.mdDoc '' A list of user modules to include in the `znc.conf` file. ''; }; @@ -216,7 +216,7 @@ in extraZncConf = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Extra config to `znc.conf` file. ''; }; diff --git a/nixos/modules/services/search/meilisearch.nix b/nixos/modules/services/search/meilisearch.nix index 9a03fc1f715b..496200b80813 100644 --- a/nixos/modules/services/search/meilisearch.nix +++ b/nixos/modules/services/search/meilisearch.nix @@ -68,7 +68,7 @@ in }; logLevel = mkOption { - description = '' + description = lib.mdDoc '' Defines how much detail should be present in MeiliSearch's logs. MeiliSearch currently supports four log levels, listed in order of increasing verbosity: - 'ERROR': only log unexpected events indicating MeiliSearch is not functioning as expected diff --git a/nixos/modules/services/security/fail2ban.nix b/nixos/modules/services/security/fail2ban.nix index 24c84151bc78..29aa49c8aada 100644 --- a/nixos/modules/services/security/fail2ban.nix +++ b/nixos/modules/services/security/fail2ban.nix @@ -73,7 +73,7 @@ in default = []; type = types.listOf types.package; example = lib.literalExpression "[ pkgs.ipset ]"; - description = '' + description = lib.mdDoc '' Extra packages to be made available to the fail2ban service. The example contains the packages needed by the `iptables-ipset-proto6` action. ''; diff --git a/nixos/modules/services/security/infnoise.nix b/nixos/modules/services/security/infnoise.nix index 4fb8adaf33f8..883185fab171 100644 --- a/nixos/modules/services/security/infnoise.nix +++ b/nixos/modules/services/security/infnoise.nix @@ -10,7 +10,7 @@ in { enable = mkEnableOption "the Infinite Noise TRNG driver"; fillDevRandom = mkOption { - description = '' + description = lib.mdDoc '' Whether to run the infnoise driver as a daemon to refill /dev/random. If disabled, you can use the `infnoise` command-line tool to diff --git a/nixos/modules/services/security/oauth2_proxy.nix b/nixos/modules/services/security/oauth2_proxy.nix index 8b2c7fa21402..e22c3a52f8db 100644 --- a/nixos/modules/services/security/oauth2_proxy.nix +++ b/nixos/modules/services/security/oauth2_proxy.nix @@ -347,7 +347,7 @@ in domain = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Optional cookie domains to force cookies to (ie: `.yourcompany.com`). The longest domain matching the request's host will be used (or the shortest cookie domain if there is no match). diff --git a/nixos/modules/services/system/cloud-init.nix b/nixos/modules/services/system/cloud-init.nix index 111cfa83c222..95ca5fb48dba 100644 --- a/nixos/modules/services/system/cloud-init.nix +++ b/nixos/modules/services/system/cloud-init.nix @@ -39,7 +39,7 @@ in btrfs.enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Allow the cloud-init service to operate `btrfs` filesystem. ''; }; @@ -47,7 +47,7 @@ in ext4.enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Allow the cloud-init service to operate `ext4` filesystem. ''; }; diff --git a/nixos/modules/services/system/self-deploy.nix b/nixos/modules/services/system/self-deploy.nix index ff56206573c1..ecba2e43dc20 100644 --- a/nixos/modules/services/system/self-deploy.nix +++ b/nixos/modules/services/system/self-deploy.nix @@ -41,7 +41,7 @@ in default = null; - description = '' + description = lib.mdDoc '' Attribute of `nixFile` that builds the current system. ''; }; @@ -51,7 +51,7 @@ in default = { }; - description = '' + description = lib.mdDoc '' Arguments to `nix-build` passed as `--argstr` or `--arg` depending on the type. ''; @@ -62,7 +62,7 @@ in default = "switch"; - description = '' + description = lib.mdDoc '' The `switch-to-configuration` subcommand used. ''; }; @@ -70,7 +70,7 @@ in repository = lib.mkOption { type = with lib.types; oneOf [ path str ]; - description = '' + description = lib.mdDoc '' The repository to fetch from. Must be properly formatted for git. If this value is set to a path (must begin with `/`) then it's @@ -99,7 +99,7 @@ in default = "master"; - description = '' + description = lib.mdDoc '' Branch to track Technically speaking any ref can be specified here, as this is @@ -113,7 +113,7 @@ in default = "hourly"; - description = '' + description = lib.mdDoc '' The schedule on which to run the `self-deploy` service. Format specified by `systemd.time 7`. diff --git a/nixos/modules/services/web-apps/hedgedoc.nix b/nixos/modules/services/web-apps/hedgedoc.nix index 691e0dec3bc2..97ed4c90c780 100644 --- a/nixos/modules/services/web-apps/hedgedoc.nix +++ b/nixos/modules/services/web-apps/hedgedoc.nix @@ -937,7 +937,7 @@ in id = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Attribute map for `id'. Defaults to `NameID' of SAML response. ''; @@ -945,7 +945,7 @@ in username = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Attribute map for `username'. Defaults to `NameID' of SAML response. ''; diff --git a/nixos/modules/services/web-apps/nexus.nix b/nixos/modules/services/web-apps/nexus.nix index cfa137e77d25..64dc0b625dba 100644 --- a/nixos/modules/services/web-apps/nexus.nix +++ b/nixos/modules/services/web-apps/nexus.nix @@ -93,7 +93,7 @@ in ''' ''; - description = '' + description = lib.mdDoc '' Options for the JVM written to `nexus.jvmopts`. Please refer to the docs (https://help.sonatype.com/repomanager3/installation/configuring-the-runtime-environment) for further information. diff --git a/nixos/modules/services/web-servers/apache-httpd/location-options.nix b/nixos/modules/services/web-servers/apache-httpd/location-options.nix index 726ad2683d28..f2d4f8357047 100644 --- a/nixos/modules/services/web-servers/apache-httpd/location-options.nix +++ b/nixos/modules/services/web-servers/apache-httpd/location-options.nix @@ -43,7 +43,7 @@ in priority = mkOption { type = types.int; default = 1000; - description = '' + description = lib.mdDoc '' Order of this location block in relation to the others in the vhost. The semantics are the same as with `lib.mkOrder`. Smaller values have a greater priority. diff --git a/nixos/modules/services/web-servers/darkhttpd.nix b/nixos/modules/services/web-servers/darkhttpd.nix index 5663e9ca9df6..ca079ea00517 100644 --- a/nixos/modules/services/web-servers/darkhttpd.nix +++ b/nixos/modules/services/web-servers/darkhttpd.nix @@ -29,7 +29,7 @@ in { address = mkOption { default = "127.0.0.1"; type = str; - description = '' + description = lib.mdDoc '' Address to listen on. Pass `all` to listen on all interfaces. ''; diff --git a/nixos/modules/services/web-servers/nginx/location-options.nix b/nixos/modules/services/web-servers/nginx/location-options.nix index dc68194f752b..2728852058ea 100644 --- a/nixos/modules/services/web-servers/nginx/location-options.nix +++ b/nixos/modules/services/web-servers/nginx/location-options.nix @@ -122,7 +122,7 @@ with lib; priority = mkOption { type = types.int; default = 1000; - description = '' + description = lib.mdDoc '' Order of this location block in relation to the others in the vhost. The semantics are the same as with `lib.mkOrder`. Smaller values have a greater priority. diff --git a/nixos/modules/services/web-servers/tomcat.nix b/nixos/modules/services/web-servers/tomcat.nix index 57a6aa8cf4e3..a032094bf22e 100644 --- a/nixos/modules/services/web-servers/tomcat.nix +++ b/nixos/modules/services/web-servers/tomcat.nix @@ -34,7 +34,7 @@ in purifyOnStart = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' On startup, the `baseDir` directory is populated with various files, subdirectories and symlinks. If this option is enabled, these items (except for the `logs` and `work` subdirectories) are first removed. @@ -46,7 +46,7 @@ in baseDir = mkOption { type = lib.types.path; default = "/var/tomcat"; - description = '' + description = lib.mdDoc '' Location where Tomcat stores configuration files, web applications and logfiles. Note that it is partially cleared on each service startup if `purifyOnStart` is enabled. diff --git a/nixos/modules/services/x11/desktop-managers/phosh.nix b/nixos/modules/services/x11/desktop-managers/phosh.nix index 0ff5d6fd1b11..2f670d3492e9 100644 --- a/nixos/modules/services/x11/desktop-managers/phosh.nix +++ b/nixos/modules/services/x11/desktop-managers/phosh.nix @@ -24,7 +24,7 @@ let phocConfigType = types.submodule { options = { xwayland = mkOption { - description = '' + description = lib.mdDoc '' Whether to enable XWayland support. To start XWayland immediately, use `immediate`. diff --git a/nixos/modules/system/boot/kernel_config.nix b/nixos/modules/system/boot/kernel_config.nix index 448835c3e625..997c404be168 100644 --- a/nixos/modules/system/boot/kernel_config.nix +++ b/nixos/modules/system/boot/kernel_config.nix @@ -91,7 +91,7 @@ in USB? y DEBUG n ''; - description = '' + description = lib.mdDoc '' The result of converting the structured kernel configuration in settings to an intermediate string that can be parsed by generate-config.pl to answer the kernel `make defconfig`. diff --git a/nixos/modules/tasks/filesystems/zfs.nix b/nixos/modules/tasks/filesystems/zfs.nix index 2ff6c1067c76..0975ed0aab9b 100644 --- a/nixos/modules/tasks/filesystems/zfs.nix +++ b/nixos/modules/tasks/filesystems/zfs.nix @@ -426,7 +426,7 @@ in type = types.either (types.enum [ "disabled" "all" ]) (types.listOf types.str); default = "disabled"; example = [ "tank" "dozer" ]; - description = '' + description = lib.mdDoc '' After importing, expand each device in the specified pools. Set the value to the plain string "all" to expand all pools on boot: diff --git a/nixos/modules/tasks/network-interfaces.nix b/nixos/modules/tasks/network-interfaces.nix index fabddece376b..eb4818756bb1 100644 --- a/nixos/modules/tasks/network-interfaces.nix +++ b/nixos/modules/tasks/network-interfaces.nix @@ -785,7 +785,7 @@ in default = null; example = "fast"; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' DEPRECATED, use `driverOptions`. Option specifying the rate in which we'll ask our link partner to transmit LACPDU packets in 802.3ad mode. @@ -796,7 +796,7 @@ in default = null; example = 100; type = types.nullOr types.int; - description = '' + description = lib.mdDoc '' DEPRECATED, use `driverOptions`. Miimon is the number of millisecond in between each round of polling by the device driver for failed links. By default polling is not @@ -809,7 +809,7 @@ in default = null; example = "active-backup"; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' DEPRECATED, use `driverOptions`. The mode which the bond will be running. The default mode for the bonding driver is balance-rr, optimizing for throughput. @@ -822,7 +822,7 @@ in default = null; example = "layer2+3"; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' DEPRECATED, use `driverOptions`. Selects the transmit hash policy to use for slave selection in balance-xor, 802.3ad, and tlb modes. diff --git a/nixos/modules/virtualisation/amazon-options.nix b/nixos/modules/virtualisation/amazon-options.nix index 52c960d453d3..ef0ad52b905b 100644 --- a/nixos/modules/virtualisation/amazon-options.nix +++ b/nixos/modules/virtualisation/amazon-options.nix @@ -14,7 +14,7 @@ in { }; datasets = lib.mkOption { - description = '' + description = lib.mdDoc '' Datasets to create under the `tank` and `boot` zpools. **NOTE:** This option is used only at image creation time, and diff --git a/nixos/modules/virtualisation/google-compute-image.nix b/nixos/modules/virtualisation/google-compute-image.nix index 0c72696f802b..133b6e9c8901 100644 --- a/nixos/modules/virtualisation/google-compute-image.nix +++ b/nixos/modules/virtualisation/google-compute-image.nix @@ -29,7 +29,7 @@ in virtualisation.googleComputeImage.configFile = mkOption { type = with types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' A path to a configuration file which will be placed at `/etc/nixos/configuration.nix` and be used when switching to a new configuration. If set to `null`, a default configuration is used, where the only import is diff --git a/nixos/modules/virtualisation/libvirtd.nix b/nixos/modules/virtualisation/libvirtd.nix index 817d7180a022..c2ff6b611af5 100644 --- a/nixos/modules/virtualisation/libvirtd.nix +++ b/nixos/modules/virtualisation/libvirtd.nix @@ -81,7 +81,7 @@ let type = types.package; default = pkgs.qemu; defaultText = literalExpression "pkgs.qemu"; - description = '' + description = lib.mdDoc '' Qemu package to use with libvirt. `pkgs.qemu` can emulate alien architectures (e.g. aarch64 on x86) `pkgs.qemu_kvm` saves disk space allowing to emulate only host architectures. diff --git a/nixos/modules/virtualisation/openstack-options.nix b/nixos/modules/virtualisation/openstack-options.nix index eded418c9c91..e1985a20732c 100644 --- a/nixos/modules/virtualisation/openstack-options.nix +++ b/nixos/modules/virtualisation/openstack-options.nix @@ -15,7 +15,7 @@ in }; datasets = lib.mkOption { - description = '' + description = lib.mdDoc '' Datasets to create under the `tank` and `boot` zpools. **NOTE:** This option is used only at image creation time, and diff --git a/nixos/modules/virtualisation/parallels-guest.nix b/nixos/modules/virtualisation/parallels-guest.nix index d3affe2b8f2c..07a61bf208db 100644 --- a/nixos/modules/virtualisation/parallels-guest.nix +++ b/nixos/modules/virtualisation/parallels-guest.nix @@ -23,7 +23,7 @@ in autoMountShares = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Control prlfsmountd service. When this service is running, shares can not be manually mounted through `mount -t prl_fs ...` as this service will remount and trample any set options. Recommended to enable for simple file sharing, but extended share use such as for code should |