lol

nixos/*: convert more partially-md option descriptions

this mostly means marking options that use markdown already
appropriately and making a few adjustments so they still render
correctly. notable for nftables we have to transform the md links
because the manpage would not render them correctly otherwise.

pennae 1013069f 7d102d11

+50 -52
+1 -1
nixos/modules/installer/sd-card/sd-image.nix
··· 58 58 firmwarePartitionOffset = mkOption { 59 59 type = types.int; 60 60 default = 8; 61 - description = '' 61 + description = lib.mdDoc '' 62 62 Gap in front of the /boot/firmware partition, in mebibytes (1024×1024 63 63 bytes). 64 64 Can be increased to make more space for boards requiring to dd u-boot
+2 -2
nixos/modules/programs/feedbackd.nix
··· 7 7 in { 8 8 options = { 9 9 programs.feedbackd = { 10 - enable = mkEnableOption '' 10 + enable = mkEnableOption (lib.mdDoc '' 11 11 Whether to enable the feedbackd D-BUS service and udev rules. 12 12 13 13 Your user needs to be in the `feedbackd` group to trigger effects. 14 - ''; 14 + ''); 15 15 package = mkOption { 16 16 description = lib.mdDoc '' 17 17 Which feedbackd package to use.
+3 -3
nixos/modules/services/backup/restic.nix
··· 182 182 pruneOpts = mkOption { 183 183 type = types.listOf types.str; 184 184 default = [ ]; 185 - description = '' 186 - A list of options (--keep-* et al.) for 'restic forget 185 + description = lib.mdDoc '' 186 + A list of options (--keep-\* et al.) for 'restic forget 187 187 --prune', to automatically prune old snapshots. The 188 188 'forget' command is run *after* the 'backup' command, so 189 - keep that in mind when constructing the --keep-* options. 189 + keep that in mind when constructing the --keep-\* options. 190 190 ''; 191 191 example = [ 192 192 "--keep-daily 7"
+3 -3
nixos/modules/services/logging/logrotate.nix
··· 316 316 paths = mkOption { 317 317 type = with types; attrsOf (submodule pathOpts); 318 318 default = { }; 319 - description = '' 319 + description = lib.mdDoc '' 320 320 Attribute set of paths to rotate. The order each block appears in the generated configuration file 321 - can be controlled by the <link linkend="opt-services.logrotate.paths._name_.priority">priority</link> option 321 + can be controlled by the [priority](#opt-services.logrotate.paths._name_.priority) option 322 322 using the same semantics as `lib.mkOrder`. Smaller values have a greater priority. 323 - This setting has been deprecated in favor of <link linkend="opt-services.logrotate.settings">logrotate settings</link>. 323 + This setting has been deprecated in favor of [logrotate settings](#opt-services.logrotate.settings). 324 324 ''; 325 325 example = literalExpression '' 326 326 {
+1 -1
nixos/modules/services/mail/dkimproxy-out.nix
··· 45 45 type = types.str; 46 46 example = "selector1"; 47 47 description = 48 - '' 48 + lib.mdDoc '' 49 49 The selector to use for DKIM key identification. 50 50 51 51 For example, if 'selector1' is used here, then for each domain
+2 -2
nixos/modules/services/mail/sympa.nix
··· 239 239 server = mkOption { 240 240 type = enum [ "nginx" "none" ]; 241 241 default = "nginx"; 242 - description = '' 242 + description = lib.mdDoc '' 243 243 The webserver used for the Sympa web interface. Set it to `none` if you want to configure it yourself. 244 244 Further nginx configuration can be done by adapting 245 - <option>services.nginx.virtualHosts.«name»</option>. 245 + {option}`services.nginx.virtualHosts.«name»`. 246 246 ''; 247 247 }; 248 248
+2 -2
nixos/modules/services/misc/klipper.nix
··· 76 76 type = with types; attrsOf 77 77 (submodule { 78 78 options = { 79 - enable = mkEnableOption '' 79 + enable = mkEnableOption (lib.mdDoc '' 80 80 building of firmware and addition of klipper-flash tools for manual flashing. 81 81 This will add `klipper-flash-$mcu` scripts to your environment which can be called to flash the firmware. 82 - ''; 82 + ''); 83 83 configFile = mkOption { 84 84 type = path; 85 85 description = lib.mdDoc "Path to firmware config which is generated using `klipper-genconf`";
+3 -3
nixos/modules/services/misc/mbpfan.nix
··· 38 38 options.general.min_fan1_speed = mkOption { 39 39 type = types.nullOr types.int; 40 40 default = 2000; 41 - description = '' 41 + description = lib.mdDoc '' 42 42 You can check minimum and maximum fan limits with 43 - "cat /sys/devices/platform/applesmc.768/fan*_min" and 44 - "cat /sys/devices/platform/applesmc.768/fan*_max" respectively. 43 + `cat /sys/devices/platform/applesmc.768/fan*_min` and 44 + `cat /sys/devices/platform/applesmc.768/fan*_max` respectively. 45 45 Setting to null implies using default value from applesmc. 46 46 ''; 47 47 };
+2 -2
nixos/modules/services/misc/zoneminder.nix
··· 66 66 in { 67 67 options = { 68 68 services.zoneminder = with lib; { 69 - enable = lib.mkEnableOption '' 69 + enable = lib.mkEnableOption (lib.mdDoc '' 70 70 ZoneMinder 71 71 72 72 If you intend to run the database locally, you should set ··· 75 75 and database user as well as populate the database yourself. 76 76 Additionally, you will need to run `zmupdate.pl` yourself when 77 77 upgrading to a newer version. 78 - ''; 78 + ''); 79 79 80 80 webserver = mkOption { 81 81 type = types.enum [ "nginx" "none" ];
+1 -1
nixos/modules/services/monitoring/ups.nix
··· 116 116 mode = mkOption { 117 117 default = "standalone"; 118 118 type = types.str; 119 - description = '' 119 + description = lib.mdDoc '' 120 120 The MODE determines which part of the NUT is to be started, and 121 121 which configuration files must be modified. 122 122
+3 -3
nixos/modules/services/networking/bitlbee.nix
··· 59 59 interface = mkOption { 60 60 type = types.str; 61 61 default = "127.0.0.1"; 62 - description = '' 63 - The interface the BitlBee deamon will be listening to. If `127.0.0.1', 64 - only clients on the local host can connect to it; if `0.0.0.0', clients 62 + description = lib.mdDoc '' 63 + The interface the BitlBee deamon will be listening to. If `127.0.0.1`, 64 + only clients on the local host can connect to it; if `0.0.0.0`, clients 65 65 can access it from any network interface. 66 66 ''; 67 67 };
+2 -2
nixos/modules/services/networking/lokinet.nix
··· 65 65 exit-node = [ "example.loki" ]; # maps all exit traffic to example.loki 66 66 exit-node = [ "example.loki:100.0.0.0/24" ]; # maps 100.0.0.0/24 to example.loki 67 67 ''; 68 - description = '' 68 + description = lib.mdDoc '' 69 69 Specify a `.loki` address and an optional ip range to use as an exit broker. 70 - See <link xlink:href="http://probably.loki/wiki/index.php?title=Exit_Nodes"/> for 70 + See <http://probably.loki/wiki/index.php?title=Exit_Nodes> for 71 71 a list of exit nodes. 72 72 ''; 73 73 };
+5 -6
nixos/modules/services/networking/nftables.nix
··· 11 11 type = types.bool; 12 12 default = false; 13 13 description = 14 - '' 14 + lib.mdDoc '' 15 15 Whether to enable nftables. nftables is a Linux-based packet 16 16 filtering framework intended to replace frameworks like iptables. 17 17 ··· 21 21 Note that if you have Docker enabled you will not be able to use 22 22 nftables without intervention. Docker uses iptables internally to 23 23 setup NAT for containers. This module disables the ip_tables kernel 24 - module, however Docker automatically loads the module. Please see [1] 24 + module, however Docker automatically loads the module. Please see 25 + <https://github.com/NixOS/nixpkgs/issues/24318#issuecomment-289216273> 25 26 for more information. 26 27 27 28 There are other programs that use iptables internally too, such as 28 - libvirt. For information on how the two firewalls interact, see [2]. 29 - 30 - [1]: https://github.com/NixOS/nixpkgs/issues/24318#issuecomment-289216273 31 - [2]: https://wiki.nftables.org/wiki-nftables/index.php/Troubleshooting#Question_4._How_do_nftables_and_iptables_interact_when_used_on_the_same_system.3F 29 + libvirt. For information on how the two firewalls interact, see 30 + <https://wiki.nftables.org/wiki-nftables/index.php/Troubleshooting#Question_4._How_do_nftables_and_iptables_interact_when_used_on_the_same_system.3F>. 32 31 ''; 33 32 }; 34 33 networking.nftables.ruleset = mkOption {
+3 -3
nixos/modules/services/networking/quassel.nix
··· 47 47 interfaces = mkOption { 48 48 type = types.listOf types.str; 49 49 default = [ "127.0.0.1" ]; 50 - description = '' 51 - The interfaces the Quassel daemon will be listening to. If `[ 127.0.0.1 ]', 52 - only clients on the local host can connect to it; if `[ 0.0.0.0 ]', clients 50 + description = lib.mdDoc '' 51 + The interfaces the Quassel daemon will be listening to. If `[ 127.0.0.1 ]`, 52 + only clients on the local host can connect to it; if `[ 0.0.0.0 ]`, clients 53 53 can access it from any network interface. 54 54 ''; 55 55 };
+2 -2
nixos/modules/services/networking/seafile.nix
··· 131 131 seahubExtraConf = mkOption { 132 132 default = ""; 133 133 type = types.lines; 134 - description = '' 134 + description = lib.mdDoc '' 135 135 Extra config to append to `seahub_settings.py` file. 136 - Refer to <link xlink:href="https://manual.seafile.com/config/seahub_settings_py/"/> 136 + Refer to <https://manual.seafile.com/config/seahub_settings_py/> 137 137 for all available options. 138 138 ''; 139 139 };
+1 -1
nixos/modules/services/networking/soju.nix
··· 79 79 acceptProxyIP = mkOption { 80 80 type = types.listOf types.str; 81 81 default = []; 82 - description = '' 82 + description = lib.mdDoc '' 83 83 Allow the specified IPs to act as a proxy. Proxys have the ability to 84 84 overwrite the remote and local connection addresses (via the X-Forwarded-\* 85 85 HTTP header fields). The special name "localhost" accepts the loopback
+1 -1
nixos/modules/services/networking/x2goserver.nix
··· 22 22 ]; 23 23 24 24 options.services.x2goserver = { 25 - enable = mkEnableOption "x2goserver" // { 25 + enable = mkEnableOption (lib.mdDoc "x2goserver") // { 26 26 description = '' 27 27 Enables the x2goserver module. 28 28 NOTE: This will create a good amount of symlinks in `/usr/local/bin`
+4 -4
nixos/modules/services/system/earlyoom.nix
··· 72 72 enableNotifications = mkOption { 73 73 type = types.bool; 74 74 default = false; 75 - description = '' 75 + description = lib.mdDoc '' 76 76 Send notifications about killed processes via the system d-bus. 77 77 78 78 WARNING: enabling this option (while convenient) should *not* be done on a ··· 80 80 local user to DoS your session by spamming notifications. 81 81 82 82 To actually see the notifications in your GUI session, you need to have 83 - <literal>systembus-notify</literal> running as your user, which this 84 - option handles by enabling <option>services.systembus-notify</option>. 83 + `systembus-notify` running as your user, which this 84 + option handles by enabling {option}`services.systembus-notify`. 85 85 86 - See <link xlink:href="https://github.com/rfjakob/earlyoom#notifications">README</link> for details. 86 + See [README](https://github.com/rfjakob/earlyoom#notifications) for details. 87 87 ''; 88 88 }; 89 89
+2 -2
nixos/modules/services/system/systembus-notify.nix
··· 8 8 in 9 9 { 10 10 options.services.systembus-notify = { 11 - enable = mkEnableOption '' 11 + enable = mkEnableOption (lib.mdDoc '' 12 12 System bus notification support 13 13 14 14 WARNING: enabling this option (while convenient) should *not* be done on a 15 15 machine where you do not trust the other users as it allows any other 16 16 local user to DoS your session by spamming notifications. 17 - ''; 17 + ''); 18 18 }; 19 19 20 20 config = mkIf cfg.enable {
+2 -2
nixos/modules/services/torrent/transmission.nix
··· 108 108 type = types.str; 109 109 default = "127.0.0.1"; 110 110 example = "0.0.0.0"; 111 - description = '' 111 + description = lib.mdDoc '' 112 112 Where to listen for RPC connections. 113 - Use \"0.0.0.0\" to listen on all interfaces. 113 + Use `0.0.0.0` to listen on all interfaces. 114 114 ''; 115 115 }; 116 116 options.rpc-port = mkOption {
+5 -6
nixos/modules/virtualisation/qemu-vm.nix
··· 463 463 type = types.enum [ "host" "guest" ]; 464 464 default = "host"; 465 465 description = 466 - '' 466 + lib.mdDoc '' 467 467 Controls the direction in which the ports are mapped: 468 468 469 - - <literal>"host"</literal> means traffic from the host ports 470 - is forwarded to the given guest port. 471 - 472 - - <literal>"guest"</literal> means traffic from the guest ports 473 - is forwarded to the given host port. 469 + - `"host"` means traffic from the host ports 470 + is forwarded to the given guest port. 471 + - `"guest"` means traffic from the guest ports 472 + is forwarded to the given host port. 474 473 ''; 475 474 }; 476 475 options.proto = mkOption {