diff --git a/nixos/modules/security/pam.nix b/nixos/modules/security/pam.nix index fefa303603dd..ca71a5b9c15e 100644 --- a/nixos/modules/security/pam.nix +++ b/nixos/modules/security/pam.nix @@ -773,18 +773,18 @@ in } ]; - description = - '' Define resource limits that should apply to users or groups. - Each item in the list should be an attribute set with a - domain, type, - item, and value - attribute. The syntax and semantics of these attributes - must be that described in limits.conf5. + description = '' + Define resource limits that should apply to users or groups. + Each item in the list should be an attribute set with a + domain, type, + item, and value + attribute. The syntax and semantics of these attributes + must be that described in limits.conf5. - Note that these limits do not apply to systemd services, - whose limits can be changed via - instead. - ''; + Note that these limits do not apply to systemd services, + whose limits can be changed via + instead. + ''; }; security.pam.services = mkOption { diff --git a/nixos/modules/services/continuous-integration/buildbot/worker.nix b/nixos/modules/services/continuous-integration/buildbot/worker.nix index 245f685764dc..513be78d485b 100644 --- a/nixos/modules/services/continuous-integration/buildbot/worker.nix +++ b/nixos/modules/services/continuous-integration/buildbot/worker.nix @@ -121,10 +121,10 @@ in { keepalive = mkOption { default = 600; type = types.int; - description = " + description = '' This is a number that indicates how frequently keepalive messages should be sent from the worker to the buildmaster, expressed in seconds. - "; + ''; }; package = mkOption { diff --git a/nixos/modules/services/databases/mongodb.nix b/nixos/modules/services/databases/mongodb.nix index 981185cc534c..97713b5d6e1b 100644 --- a/nixos/modules/services/databases/mongodb.nix +++ b/nixos/modules/services/databases/mongodb.nix @@ -35,9 +35,9 @@ in default = pkgs.mongodb; defaultText = literalExpression "pkgs.mongodb"; type = types.package; - description = " + description = '' Which MongoDB derivation to use. - "; + ''; }; user = mkOption { diff --git a/nixos/modules/services/databases/mysql.nix b/nixos/modules/services/databases/mysql.nix index 1a096d2a88a4..a42926a542f2 100644 --- a/nixos/modules/services/databases/mysql.nix +++ b/nixos/modules/services/databases/mysql.nix @@ -36,9 +36,9 @@ in package = mkOption { type = types.package; example = literalExpression "pkgs.mariadb"; - description = " + description = '' Which MySQL derivation to use. MariaDB packages are supported too. - "; + ''; }; user = mkOption { diff --git a/nixos/modules/services/development/jupyter/default.nix b/nixos/modules/services/development/jupyter/default.nix index b77f5adbd5e9..edcc6b7c6c0c 100644 --- a/nixos/modules/services/development/jupyter/default.nix +++ b/nixos/modules/services/development/jupyter/default.nix @@ -149,13 +149,14 @@ in { }; } ''; - description = "Declarative kernel config + description = '' + Declarative kernel config. - Kernels can be declared in any language that supports and has the required - dependencies to communicate with a jupyter server. - In python's case, it means that ipykernel package must always be included in - the list of packages of the targeted environment. - "; + Kernels can be declared in any language that supports and has the required + dependencies to communicate with a jupyter server. + In python's case, it means that ipykernel package must always be included in + the list of packages of the targeted environment. + ''; }; }; diff --git a/nixos/modules/services/mail/postfix.nix b/nixos/modules/services/mail/postfix.nix index 75ef09dbc6ee..42344041842f 100644 --- a/nixos/modules/services/mail/postfix.nix +++ b/nixos/modules/services/mail/postfix.nix @@ -355,125 +355,125 @@ in setgidGroup = mkOption { type = types.str; default = "postdrop"; - description = " + description = '' How to call postfix setgid group (for postdrop). Should be uniquely used group. - "; + ''; }; networks = mkOption { type = types.nullOr (types.listOf types.str); default = null; example = ["192.168.0.1/24"]; - description = " + description = '' Net masks for trusted - allowed to relay mail to third parties - hosts. Leave empty to use mynetworks_style configuration or use default (localhost-only). - "; + ''; }; networksStyle = mkOption { type = types.str; default = ""; - description = " + description = '' 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). - "; + ''; }; hostname = mkOption { type = types.str; default = ""; - description =" + description = '' Hostname to use. Leave blank to use just the hostname of machine. It should be FQDN. - "; + ''; }; domain = mkOption { type = types.str; default = ""; - description =" + description = '' Domain to use. Leave blank to use hostname minus first component. - "; + ''; }; origin = mkOption { type = types.str; default = ""; - description =" + description = '' Origin to use in outgoing e-mail. Leave blank to use hostname. - "; + ''; }; destination = mkOption { type = types.nullOr (types.listOf types.str); default = null; example = ["localhost"]; - description = " + description = '' Full (!) list of domains we deliver locally. Leave blank for acceptable Postfix default. - "; + ''; }; relayDomains = mkOption { type = types.nullOr (types.listOf types.str); default = null; example = ["localdomain"]; - description = " + description = '' List of domains we agree to relay to. Default is empty. - "; + ''; }; relayHost = mkOption { type = types.str; default = ""; - description = " + description = '' Mail relay for outbound mail. - "; + ''; }; relayPort = mkOption { type = types.int; default = 25; - description = " + description = '' SMTP port for relay mail relay. - "; + ''; }; lookupMX = mkOption { type = types.bool; default = false; - description = " + description = '' Whether relay specified is just domain whose MX must be used. - "; + ''; }; postmasterAlias = mkOption { type = types.str; default = "root"; - description = " + description = '' Who should receive postmaster e-mail. Multiple values can be added by separating values with comma. - "; + ''; }; rootAlias = mkOption { type = types.str; default = ""; - description = " + description = '' Who should receive root e-mail. Blank for no redirection. Multiple values can be added by separating values with comma. - "; + ''; }; extraAliases = mkOption { type = types.lines; default = ""; - description = " + description = '' Additional entries to put verbatim into aliases file, cf. man-page aliases(8). - "; + ''; }; aliasMapType = mkOption { @@ -497,9 +497,9 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = " + description = '' Extra lines to be added verbatim to the main.cf configuration file. - "; + ''; }; tlsTrustedAuthorities = mkOption { @@ -527,9 +527,9 @@ in type = types.str; default = ""; example = "+"; - description = " + description = '' Delimiter for address extension: so mail to user+test can be handled by ~user/.forward+test - "; + ''; }; canonical = mkOption { @@ -543,9 +543,9 @@ in virtual = mkOption { type = types.lines; default = ""; - description = " + description = '' Entries for the virtual alias map, cf. man-page virtual(5). - "; + ''; }; virtualMapType = mkOption { @@ -572,9 +572,9 @@ in transport = mkOption { default = ""; type = types.lines; - description = " + description = '' Entries for the transport map, cf. man-page transport(8). - "; + ''; }; dnsBlacklists = mkOption { diff --git a/nixos/modules/services/misc/exhibitor.nix b/nixos/modules/services/misc/exhibitor.nix index 3db42b8e4a43..4e9e1077f528 100644 --- a/nixos/modules/services/misc/exhibitor.nix +++ b/nixos/modules/services/misc/exhibitor.nix @@ -71,9 +71,9 @@ in enable = mkOption { type = types.bool; default = false; - description = " + description = '' Whether to enable the exhibitor server. - "; + ''; }; # See https://github.com/soabase/exhibitor/wiki/Running-Exhibitor for what these mean # General options for any type of config diff --git a/nixos/modules/services/monitoring/nagios.nix b/nixos/modules/services/monitoring/nagios.nix index a45d0c0e070b..fe217be915aa 100644 --- a/nixos/modules/services/monitoring/nagios.nix +++ b/nixos/modules/services/monitoring/nagios.nix @@ -91,11 +91,11 @@ in enable = mkEnableOption ''Nagios to monitor your system or network.''; objectDefs = mkOption { - description = " + description = '' 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. - "; + ''; type = types.listOf types.path; example = literalExpression "[ ./objects.cfg ]"; }; @@ -104,18 +104,18 @@ in type = types.listOf types.package; default = with pkgs; [ monitoring-plugins msmtp mailutils ]; defaultText = literalExpression "[pkgs.monitoring-plugins pkgs.msmtp pkgs.mailutils]"; - description = " + description = '' Packages to be added to the Nagios PATH. Typically used to add plugins, but can be anything. - "; + ''; }; mainConfigFile = mkOption { type = types.nullOr types.package; default = null; - description = " + description = '' If non-null, overrides the main configuration file of Nagios. - "; + ''; }; extraConfig = mkOption { @@ -139,19 +139,19 @@ in type = types.package; default = nagiosCGICfgFile; defaultText = literalExpression "nagiosCGICfgFile"; - description = " + description = '' Derivation for the configuration file of Nagios CGI scripts that can be used in web servers for running the Nagios web interface. - "; + ''; }; enableWebInterface = mkOption { type = types.bool; default = false; - description = " + description = '' Whether to enable the Nagios web interface. You should also enable Apache (). - "; + ''; }; virtualHost = mkOption { diff --git a/nixos/modules/services/network-filesystems/yandex-disk.nix b/nixos/modules/services/network-filesystems/yandex-disk.nix index 94f806a61789..d66e481a9690 100644 --- a/nixos/modules/services/network-filesystems/yandex-disk.nix +++ b/nixos/modules/services/network-filesystems/yandex-disk.nix @@ -23,9 +23,9 @@ in enable = mkOption { type = types.bool; default = false; - description = " + description = '' Whether to enable Yandex-disk client. See https://disk.yandex.ru/ - "; + ''; }; username = mkOption { diff --git a/nixos/modules/services/networking/bind.nix b/nixos/modules/services/networking/bind.nix index 0966332f7d0d..f2948a8cc199 100644 --- a/nixos/modules/services/networking/bind.nix +++ b/nixos/modules/services/networking/bind.nix @@ -117,62 +117,62 @@ in cacheNetworks = mkOption { default = [ "127.0.0.0/24" ]; type = types.listOf types.str; - description = " + description = '' 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. It is recommended that you limit cacheNetworks to avoid your server being used for DNS amplification attacks. - "; + ''; }; blockedNetworks = mkOption { default = [ ]; type = types.listOf types.str; - description = " + description = '' What networks are just blocked. - "; + ''; }; ipv4Only = mkOption { default = false; type = types.bool; - description = " + description = '' Only use ipv4, even if the host supports ipv6. - "; + ''; }; forwarders = mkOption { default = config.networking.nameservers; defaultText = literalExpression "config.networking.nameservers"; type = types.listOf types.str; - description = " + description = '' List of servers we should forward requests to. - "; + ''; }; forward = mkOption { default = "first"; type = types.enum ["first" "only"]; - description = " + description = '' Whether to forward 'first' (try forwarding but lookup directly if forwarding fails) or 'only'. - "; + ''; }; listenOn = mkOption { default = [ "any" ]; type = types.listOf types.str; - description = " + description = '' Interfaces to listen on. - "; + ''; }; listenOnIpv6 = mkOption { default = [ "any" ]; type = types.listOf types.str; - description = " + description = '' Ipv6 interfaces to listen on. - "; + ''; }; directory = mkOption { @@ -184,9 +184,9 @@ in zones = mkOption { default = [ ]; type = with types; coercedTo (listOf attrs) bindZoneCoerce (attrsOf (types.submodule bindZoneOptions)); - description = " + description = '' List of zones we claim authority over. - "; + ''; example = { "example.com" = { master = false; @@ -201,9 +201,9 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = " + description = '' Extra lines to be added verbatim to the generated named configuration file. - "; + ''; }; extraOptions = mkOption { @@ -219,10 +219,10 @@ in type = types.path; default = confFile; defaultText = literalExpression "confFile"; - description = " + description = '' Overridable config file to use for named. By default, that generated by nixos. - "; + ''; }; }; diff --git a/nixos/modules/services/networking/ircd-hybrid/default.nix b/nixos/modules/services/networking/ircd-hybrid/default.nix index f659f3f3e8c1..53357abce949 100644 --- a/nixos/modules/services/networking/ircd-hybrid/default.nix +++ b/nixos/modules/services/networking/ircd-hybrid/default.nix @@ -41,69 +41,69 @@ in serverName = mkOption { default = "hades.arpa"; type = types.str; - description = " + description = '' IRCD server name. - "; + ''; }; sid = mkOption { default = "0NL"; type = types.str; - description = " + description = '' IRCD server unique ID in a net of servers. - "; + ''; }; description = mkOption { default = "Hybrid-7 IRC server."; type = types.str; - description = " + description = '' IRCD server description. - "; + ''; }; rsaKey = mkOption { default = null; example = literalExpression "/root/certificates/irc.key"; type = types.nullOr types.path; - description = " + description = '' IRCD server RSA key. - "; + ''; }; certificate = mkOption { default = null; example = literalExpression "/root/certificates/irc.pem"; type = types.nullOr types.path; - description = " + description = '' IRCD server SSL certificate. There are some limitations - read manual. - "; + ''; }; adminEmail = mkOption { default = ""; type = types.str; example = ""; - description = " + description = '' IRCD server administrator e-mail. - "; + ''; }; extraIPs = mkOption { default = []; example = ["127.0.0.1"]; type = types.listOf types.str; - description = " + description = '' Extra IP's to bind. - "; + ''; }; extraPort = mkOption { default = "7117"; type = types.str; - description = " + description = '' Extra port to avoid filtering. - "; + ''; }; }; diff --git a/nixos/modules/services/networking/kresd.nix b/nixos/modules/services/networking/kresd.nix index 623e477ca7a8..601a88176ec2 100644 --- a/nixos/modules/services/networking/kresd.nix +++ b/nixos/modules/services/networking/kresd.nix @@ -59,9 +59,9 @@ in { }; package = mkOption { type = types.package; - description = " + description = '' knot-resolver package to use. - "; + ''; default = pkgs.knot-resolver; defaultText = literalExpression "pkgs.knot-resolver"; example = literalExpression "pkgs.knot-resolver.override { extraFeatures = true; }"; diff --git a/nixos/modules/services/security/haka.nix b/nixos/modules/services/security/haka.nix index 10b7cef54d33..cbc2ce24ac6a 100644 --- a/nixos/modules/services/security/haka.nix +++ b/nixos/modules/services/security/haka.nix @@ -61,9 +61,9 @@ in default = pkgs.haka; defaultText = literalExpression "pkgs.haka"; type = types.package; - description = " + description = '' Which Haka derivation to use. - "; + ''; }; configFile = mkOption { diff --git a/nixos/modules/services/web-apps/pgpkeyserver-lite.nix b/nixos/modules/services/web-apps/pgpkeyserver-lite.nix index faf0ce13238e..bce9a1b231c3 100644 --- a/nixos/modules/services/web-apps/pgpkeyserver-lite.nix +++ b/nixos/modules/services/web-apps/pgpkeyserver-lite.nix @@ -24,34 +24,34 @@ in default = pkgs.pgpkeyserver-lite; defaultText = literalExpression "pkgs.pgpkeyserver-lite"; type = types.package; - description = " + description = '' Which webgui derivation to use. - "; + ''; }; hostname = mkOption { type = types.str; - description = " + description = '' Which hostname to set the vHost to that is proxying to sks. - "; + ''; }; hkpAddress = mkOption { default = builtins.head sksCfg.hkpAddress; defaultText = literalExpression "head config.${sksOpt.hkpAddress}"; type = types.str; - description = " + description = '' Wich ip address the sks-keyserver is listening on. - "; + ''; }; hkpPort = mkOption { default = sksCfg.hkpPort; defaultText = literalExpression "config.${sksOpt.hkpPort}"; type = types.int; - description = " + description = '' Which port the sks-keyserver is listening on. - "; + ''; }; }; }; diff --git a/nixos/modules/services/web-servers/nginx/default.nix b/nixos/modules/services/web-servers/nginx/default.nix index 72b91c37f8a7..c29c9ca4f1c2 100644 --- a/nixos/modules/services/web-servers/nginx/default.nix +++ b/nixos/modules/services/web-servers/nginx/default.nix @@ -390,50 +390,50 @@ in statusPage = mkOption { default = false; type = types.bool; - description = " + description = '' Enable status page reachable from localhost on http://127.0.0.1/nginx_status. - "; + ''; }; recommendedTlsSettings = mkOption { default = false; type = types.bool; - description = " + description = '' Enable recommended TLS settings. - "; + ''; }; recommendedOptimisation = mkOption { default = false; type = types.bool; - description = " + description = '' Enable recommended optimisation settings. - "; + ''; }; recommendedGzipSettings = mkOption { default = false; type = types.bool; - description = " + description = '' Enable recommended gzip settings. - "; + ''; }; recommendedProxySettings = mkOption { default = false; type = types.bool; - description = " + description = '' Whether to enable recommended proxy settings if a vhost does not specify the option manually. - "; + ''; }; proxyTimeout = mkOption { type = types.str; default = "60s"; example = "20s"; - description = " + description = '' Change the proxy related timeouts in recommendedProxySettings. - "; + ''; }; defaultListenAddresses = mkOption { @@ -441,9 +441,9 @@ 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 = '' If vhosts do not specify listenAddresses, use these addresses by default. - "; + ''; }; package = mkOption { @@ -453,11 +453,11 @@ in apply = p: p.override { modules = p.modules ++ cfg.additionalModules; }; - description = " + description = '' 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 nginxMainline. - "; + ''; }; additionalModules = mkOption { @@ -474,7 +474,7 @@ in logError = mkOption { default = "stderr"; type = types.str; - description = " + description = '' Configures logging. The first parameter defines a file that will store the log. The special value stderr selects the standard error file. Logging to @@ -485,15 +485,15 @@ in increasing severity. Setting a certain log level will cause all messages of the specified and more severe log levels to be logged. If this parameter is omitted then error is used. - "; + ''; }; preStart = mkOption { type = types.lines; default = ""; - description = " + description = '' Shell commands executed before the service's nginx is started. - "; + ''; }; config = mkOption { @@ -551,12 +551,12 @@ in httpConfig = mkOption { type = types.lines; default = ""; - description = " + description = '' Configuration lines to be set inside the http block. This is mutually exclusive with the structured configuration via virtualHosts and the recommendedXyzSettings configuration options. See appendHttpConfig for appending to the generated http block. - "; + ''; }; streamConfig = mkOption { @@ -569,9 +569,9 @@ in proxy_pass 192.168.0.1:53535; } ''; - description = " + description = '' Configuration lines to be set inside the stream block. - "; + ''; }; eventsConfig = mkOption { @@ -585,11 +585,11 @@ in appendHttpConfig = mkOption { type = types.lines; default = ""; - description = " + description = '' 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. - "; + ''; }; enableReload = mkOption { diff --git a/nixos/modules/services/web-servers/tomcat.nix b/nixos/modules/services/web-servers/tomcat.nix index ec7f46e25e95..57a6aa8cf4e3 100644 --- a/nixos/modules/services/web-servers/tomcat.nix +++ b/nixos/modules/services/web-servers/tomcat.nix @@ -112,10 +112,10 @@ in serverXml = mkOption { type = types.lines; default = ""; - description = " + description = '' Verbatim server.xml configuration. This is mutually exclusive with the virtualHosts options. - "; + ''; }; commonLibs = mkOption { diff --git a/nixos/modules/services/web-servers/varnish/default.nix b/nixos/modules/services/web-servers/varnish/default.nix index 39ebe6338728..56722bb99d3e 100644 --- a/nixos/modules/services/web-servers/varnish/default.nix +++ b/nixos/modules/services/web-servers/varnish/default.nix @@ -27,43 +27,43 @@ in http_address = mkOption { type = types.str; default = "*:6081"; - description = " + description = '' HTTP listen address and port. - "; + ''; }; config = mkOption { type = types.lines; - description = " + description = '' Verbatim default.vcl configuration. - "; + ''; }; stateDir = mkOption { type = types.path; default = "/var/spool/varnish/${config.networking.hostName}"; defaultText = literalExpression ''"/var/spool/varnish/''${config.networking.hostName}"''; - description = " + description = '' Directory holding all state for Varnish to run. - "; + ''; }; extraModules = mkOption { type = types.listOf types.package; default = []; example = literalExpression "[ pkgs.varnishPackages.geoip ]"; - description = " + description = '' Varnish modules (except 'std'). - "; + ''; }; extraCommandLine = mkOption { type = types.str; default = ""; example = "-s malloc,256M"; - description = " + description = '' Command line switches for varnishd (run 'varnishd -?' to get list of options) - "; + ''; }; };