nixos/*: use properly indented strings for option docs
using regular strings works well for docbook because docbook is not as whitespace-sensitive as markdown. markdown would render all of these as code blocks when given the chance.
···773773 }
774774 ];
775775776776- description =
777777- '' Define resource limits that should apply to users or groups.
778778- Each item in the list should be an attribute set with a
779779- <varname>domain</varname>, <varname>type</varname>,
780780- <varname>item</varname>, and <varname>value</varname>
781781- attribute. The syntax and semantics of these attributes
782782- must be that described in <citerefentry><refentrytitle>limits.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
776776+ description = ''
777777+ Define resource limits that should apply to users or groups.
778778+ Each item in the list should be an attribute set with a
779779+ <varname>domain</varname>, <varname>type</varname>,
780780+ <varname>item</varname>, and <varname>value</varname>
781781+ attribute. The syntax and semantics of these attributes
782782+ must be that described in <citerefentry><refentrytitle>limits.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
783783784784- Note that these limits do not apply to systemd services,
785785- whose limits can be changed via <option>systemd.extraConfig</option>
786786- instead.
787787- '';
784784+ Note that these limits do not apply to systemd services,
785785+ whose limits can be changed via <option>systemd.extraConfig</option>
786786+ instead.
787787+ '';
788788 };
789789790790 security.pam.services = mkOption {
···121121 keepalive = mkOption {
122122 default = 600;
123123 type = types.int;
124124- description = "
124124+ description = ''
125125 This is a number that indicates how frequently keepalive messages should be sent
126126 from the worker to the buildmaster, expressed in seconds.
127127- ";
127127+ '';
128128 };
129129130130 package = mkOption {
+2-2
nixos/modules/services/databases/mongodb.nix
···3535 default = pkgs.mongodb;
3636 defaultText = literalExpression "pkgs.mongodb";
3737 type = types.package;
3838- description = "
3838+ description = ''
3939 Which MongoDB derivation to use.
4040- ";
4040+ '';
4141 };
42424343 user = mkOption {
+2-2
nixos/modules/services/databases/mysql.nix
···3636 package = mkOption {
3737 type = types.package;
3838 example = literalExpression "pkgs.mariadb";
3939- description = "
3939+ description = ''
4040 Which MySQL derivation to use. MariaDB packages are supported too.
4141- ";
4141+ '';
4242 };
43434444 user = mkOption {
···149149 };
150150 }
151151 '';
152152- description = "Declarative kernel config
152152+ description = ''
153153+ Declarative kernel config.
153154154154- Kernels can be declared in any language that supports and has the required
155155- dependencies to communicate with a jupyter server.
156156- In python's case, it means that ipykernel package must always be included in
157157- the list of packages of the targeted environment.
158158- ";
155155+ Kernels can be declared in any language that supports and has the required
156156+ dependencies to communicate with a jupyter server.
157157+ In python's case, it means that ipykernel package must always be included in
158158+ the list of packages of the targeted environment.
159159+ '';
159160 };
160161 };
161162
+36-36
nixos/modules/services/mail/postfix.nix
···355355 setgidGroup = mkOption {
356356 type = types.str;
357357 default = "postdrop";
358358- description = "
358358+ description = ''
359359 How to call postfix setgid group (for postdrop). Should
360360 be uniquely used group.
361361- ";
361361+ '';
362362 };
363363364364 networks = mkOption {
365365 type = types.nullOr (types.listOf types.str);
366366 default = null;
367367 example = ["192.168.0.1/24"];
368368- description = "
368368+ description = ''
369369 Net masks for trusted - allowed to relay mail to third parties -
370370 hosts. Leave empty to use mynetworks_style configuration or use
371371 default (localhost-only).
372372- ";
372372+ '';
373373 };
374374375375 networksStyle = mkOption {
376376 type = types.str;
377377 default = "";
378378- description = "
378378+ description = ''
379379 Name of standard way of trusted network specification to use,
380380 leave blank if you specify it explicitly or if you want to use
381381 default (localhost-only).
382382- ";
382382+ '';
383383 };
384384385385 hostname = mkOption {
386386 type = types.str;
387387 default = "";
388388- description ="
388388+ description = ''
389389 Hostname to use. Leave blank to use just the hostname of machine.
390390 It should be FQDN.
391391- ";
391391+ '';
392392 };
393393394394 domain = mkOption {
395395 type = types.str;
396396 default = "";
397397- description ="
397397+ description = ''
398398 Domain to use. Leave blank to use hostname minus first component.
399399- ";
399399+ '';
400400 };
401401402402 origin = mkOption {
403403 type = types.str;
404404 default = "";
405405- description ="
405405+ description = ''
406406 Origin to use in outgoing e-mail. Leave blank to use hostname.
407407- ";
407407+ '';
408408 };
409409410410 destination = mkOption {
411411 type = types.nullOr (types.listOf types.str);
412412 default = null;
413413 example = ["localhost"];
414414- description = "
414414+ description = ''
415415 Full (!) list of domains we deliver locally. Leave blank for
416416 acceptable Postfix default.
417417- ";
417417+ '';
418418 };
419419420420 relayDomains = mkOption {
421421 type = types.nullOr (types.listOf types.str);
422422 default = null;
423423 example = ["localdomain"];
424424- description = "
424424+ description = ''
425425 List of domains we agree to relay to. Default is empty.
426426- ";
426426+ '';
427427 };
428428429429 relayHost = mkOption {
430430 type = types.str;
431431 default = "";
432432- description = "
432432+ description = ''
433433 Mail relay for outbound mail.
434434- ";
434434+ '';
435435 };
436436437437 relayPort = mkOption {
438438 type = types.int;
439439 default = 25;
440440- description = "
440440+ description = ''
441441 SMTP port for relay mail relay.
442442- ";
442442+ '';
443443 };
444444445445 lookupMX = mkOption {
446446 type = types.bool;
447447 default = false;
448448- description = "
448448+ description = ''
449449 Whether relay specified is just domain whose MX must be used.
450450- ";
450450+ '';
451451 };
452452453453 postmasterAlias = mkOption {
454454 type = types.str;
455455 default = "root";
456456- description = "
456456+ description = ''
457457 Who should receive postmaster e-mail. Multiple values can be added by
458458 separating values with comma.
459459- ";
459459+ '';
460460 };
461461462462 rootAlias = mkOption {
463463 type = types.str;
464464 default = "";
465465- description = "
465465+ description = ''
466466 Who should receive root e-mail. Blank for no redirection.
467467 Multiple values can be added by separating values with comma.
468468- ";
468468+ '';
469469 };
470470471471 extraAliases = mkOption {
472472 type = types.lines;
473473 default = "";
474474- description = "
474474+ description = ''
475475 Additional entries to put verbatim into aliases file, cf. man-page aliases(8).
476476- ";
476476+ '';
477477 };
478478479479 aliasMapType = mkOption {
···497497 extraConfig = mkOption {
498498 type = types.lines;
499499 default = "";
500500- description = "
500500+ description = ''
501501 Extra lines to be added verbatim to the main.cf configuration file.
502502- ";
502502+ '';
503503 };
504504505505 tlsTrustedAuthorities = mkOption {
···527527 type = types.str;
528528 default = "";
529529 example = "+";
530530- description = "
530530+ description = ''
531531 Delimiter for address extension: so mail to user+test can be handled by ~user/.forward+test
532532- ";
532532+ '';
533533 };
534534535535 canonical = mkOption {
···543543 virtual = mkOption {
544544 type = types.lines;
545545 default = "";
546546- description = "
546546+ description = ''
547547 Entries for the virtual alias map, cf. man-page virtual(5).
548548- ";
548548+ '';
549549 };
550550551551 virtualMapType = mkOption {
···572572 transport = mkOption {
573573 default = "";
574574 type = types.lines;
575575- description = "
575575+ description = ''
576576 Entries for the transport map, cf. man-page transport(8).
577577- ";
577577+ '';
578578 };
579579580580 dnsBlacklists = mkOption {
+2-2
nixos/modules/services/misc/exhibitor.nix
···7171 enable = mkOption {
7272 type = types.bool;
7373 default = false;
7474- description = "
7474+ description = ''
7575 Whether to enable the exhibitor server.
7676- ";
7676+ '';
7777 };
7878 # See https://github.com/soabase/exhibitor/wiki/Running-Exhibitor for what these mean
7979 # General options for any type of config
+10-10
nixos/modules/services/monitoring/nagios.nix
···9191 enable = mkEnableOption ''<link xlink:href="http://www.nagios.org/">Nagios</link> to monitor your system or network.'';
92929393 objectDefs = mkOption {
9494- description = "
9494+ description = ''
9595 A list of Nagios object configuration files that must define
9696 the hosts, host groups, services and contacts for the
9797 network that you want Nagios to monitor.
9898- ";
9898+ '';
9999 type = types.listOf types.path;
100100 example = literalExpression "[ ./objects.cfg ]";
101101 };
···104104 type = types.listOf types.package;
105105 default = with pkgs; [ monitoring-plugins msmtp mailutils ];
106106 defaultText = literalExpression "[pkgs.monitoring-plugins pkgs.msmtp pkgs.mailutils]";
107107- description = "
107107+ description = ''
108108 Packages to be added to the Nagios <envar>PATH</envar>.
109109 Typically used to add plugins, but can be anything.
110110- ";
110110+ '';
111111 };
112112113113 mainConfigFile = mkOption {
114114 type = types.nullOr types.package;
115115 default = null;
116116- description = "
116116+ description = ''
117117 If non-null, overrides the main configuration file of Nagios.
118118- ";
118118+ '';
119119 };
120120121121 extraConfig = mkOption {
···139139 type = types.package;
140140 default = nagiosCGICfgFile;
141141 defaultText = literalExpression "nagiosCGICfgFile";
142142- description = "
142142+ description = ''
143143 Derivation for the configuration file of Nagios CGI scripts
144144 that can be used in web servers for running the Nagios web interface.
145145- ";
145145+ '';
146146 };
147147148148 enableWebInterface = mkOption {
149149 type = types.bool;
150150 default = false;
151151- description = "
151151+ description = ''
152152 Whether to enable the Nagios web interface. You should also
153153 enable Apache (<option>services.httpd.enable</option>).
154154- ";
154154+ '';
155155 };
156156157157 virtualHost = mkOption {