diff options
| author | éclairevoyant <848000+eclairevoyant@users.noreply.github.com> | 2024-06-03 12:59:45 -0400 |
|---|---|---|
| committer | éclairevoyant <848000+eclairevoyant@users.noreply.github.com> | 2024-06-14 02:41:42 -0400 |
| commit | 7d8742da87c1b06cd6db5eba1fe5a2cf8a7b2568 (patch) | |
| tree | 528858b811d74981eb547ddf166d7bd7bf55bc59 | |
| parent | f587de5d7f8736cef6e106163d65273d3f70516e (diff) | |
treewide: fix mkEnableOption usage
41 files changed, 66 insertions, 67 deletions
diff --git a/nixos/modules/misc/mandoc.nix b/nixos/modules/misc/mandoc.nix index 706e2ac2c283..166693930b5c 100644 --- a/nixos/modules/misc/mandoc.nix +++ b/nixos/modules/misc/mandoc.nix @@ -96,12 +96,17 @@ in {option}`documentation.man.mandoc.manPath` to an empty list (`[]`). ''; }; - output.fragment = lib.mkEnableOption '' - Omit the <!DOCTYPE> declaration and the <html>, <head>, and <body> - elements and only emit the subtree below the <body> element in HTML - output of {manpage}`mandoc(1)`. The style argument will be ignored. - This is useful when embedding manual content within existing documents. - ''; + output.fragment = lib.mkOption { + type = lib.types.bool; + default = false; + example = true; + description = '' + Whether to omit the <!DOCTYPE> declaration and the <html>, <head>, and <body> + elements and only emit the subtree below the <body> element in HTML + output of {manpage}`mandoc(1)`. The style argument will be ignored. + This is useful when embedding manual content within existing documents. + ''; + }; output.includes = lib.mkOption { type = with lib.types; nullOr str; default = null; @@ -160,9 +165,9 @@ in ''; }; output.toc = lib.mkEnableOption '' - In HTML output of {manpage}`mandoc(1)`, If an input file contains - at least two non-standard sections, print a table of contents near - the beginning of the output. + printing a table of contents near the beginning of the HTML output + of {manpage}`mandoc(1)` if an input file contains at least two + non-standard sections ''; output.width = lib.mkOption { type = with lib.types; nullOr int; diff --git a/nixos/modules/programs/dublin-traceroute.nix b/nixos/modules/programs/dublin-traceroute.nix index de9446ad7377..c764352843e7 100644 --- a/nixos/modules/programs/dublin-traceroute.nix +++ b/nixos/modules/programs/dublin-traceroute.nix @@ -8,9 +8,7 @@ in { options = { programs.dublin-traceroute = { - enable = lib.mkEnableOption '' - dublin-traceroute, add it to the global environment and configure a setcap wrapper for it. - ''; + enable = lib.mkEnableOption "dublin-traceroute (including setcap wrapper)"; package = lib.mkPackageOption pkgs "dublin-traceroute" { }; }; diff --git a/nixos/modules/programs/joycond-cemuhook.nix b/nixos/modules/programs/joycond-cemuhook.nix index 6cdd198a7df2..c01a00478113 100644 --- a/nixos/modules/programs/joycond-cemuhook.nix +++ b/nixos/modules/programs/joycond-cemuhook.nix @@ -1,7 +1,7 @@ { lib, pkgs, config, ... }: { options.programs.joycond-cemuhook = { - enable = lib.mkEnableOption "joycond-cemuhook, a program to enable support for cemuhook's UDP protocol for joycond devices."; + enable = lib.mkEnableOption "joycond-cemuhook, a program to enable support for cemuhook's UDP protocol for joycond devices"; }; config = lib.mkIf config.programs.joycond-cemuhook.enable { diff --git a/nixos/modules/programs/mouse-actions.nix b/nixos/modules/programs/mouse-actions.nix index fdf39d56d383..73dc783e3100 100644 --- a/nixos/modules/programs/mouse-actions.nix +++ b/nixos/modules/programs/mouse-actions.nix @@ -6,7 +6,7 @@ in { options.programs.mouse-actions = { enable = lib.mkEnableOption '' - mouse-actions udev rules. This is a prerequisite for using mouse-actions without being root. + mouse-actions udev rules. This is a prerequisite for using mouse-actions without being root ''; }; config = lib.mkIf cfg.enable { diff --git a/nixos/modules/security/ca.nix b/nixos/modules/security/ca.nix index af5d91b35f2e..8aae6eb3f29b 100644 --- a/nixos/modules/security/ca.nix +++ b/nixos/modules/security/ca.nix @@ -26,13 +26,13 @@ in security.pki.useCompatibleBundle = mkEnableOption ''usage of a compatibility bundle. - Such a bundle consist exclusively of `BEGIN CERTIFICATE` and no `BEGIN TRUSTED CERTIFICATE`, - which is a OpenSSL specific PEM format. + Such a bundle consists exclusively of `BEGIN CERTIFICATE` and no `BEGIN TRUSTED CERTIFICATE`, + which is an OpenSSL specific PEM format. It is known to be incompatible with certain software stacks. Nevertheless, enabling this will strip all additional trust rules provided by the - certificates themselves, this can have security consequences depending on your usecases. + certificates themselves. This can have security consequences depending on your usecases ''; security.pki.certificateFiles = mkOption { diff --git a/nixos/modules/security/pam.nix b/nixos/modules/security/pam.nix index 5d3bed2fb02c..f77e819d0c83 100644 --- a/nixos/modules/security/pam.nix +++ b/nixos/modules/security/pam.nix @@ -1055,7 +1055,7 @@ in the dp9ik pam module provided by tlsclient. If set, users can be authenticated against the 9front - authentication server given in {option}`security.pam.dp9ik.authserver`. + authentication server given in {option}`security.pam.dp9ik.authserver` ''; control = mkOption { default = "sufficient"; diff --git a/nixos/modules/security/sudo-rs.nix b/nixos/modules/security/sudo-rs.nix index 6ccf42ed7f08..e63a64d4691c 100644 --- a/nixos/modules/security/sudo-rs.nix +++ b/nixos/modules/security/sudo-rs.nix @@ -41,7 +41,7 @@ in enable = mkEnableOption '' a memory-safe implementation of the {command}`sudo` command, - which allows non-root users to execute commands as root. + which allows non-root users to execute commands as root ''; package = mkPackageOption pkgs "sudo-rs" { }; diff --git a/nixos/modules/services/databases/memcached.nix b/nixos/modules/services/databases/memcached.nix index e38931b6b7ea..7a3afc5efafc 100644 --- a/nixos/modules/services/databases/memcached.nix +++ b/nixos/modules/services/databases/memcached.nix @@ -37,7 +37,7 @@ in description = "The port to bind to."; }; - enableUnixSocket = mkEnableOption "Unix Domain Socket at /run/memcached/memcached.sock instead of listening on an IP address and port. The `listen` and `port` options are ignored."; + enableUnixSocket = mkEnableOption "Unix Domain Socket at /run/memcached/memcached.sock instead of listening on an IP address and port. The `listen` and `port` options are ignored"; maxMemory = mkOption { type = types.ints.unsigned; diff --git a/nixos/modules/services/matrix/mautrix-signal.nix b/nixos/modules/services/matrix/mautrix-signal.nix index faca10551abb..0da95b9c8a7b 100644 --- a/nixos/modules/services/matrix/mautrix-signal.nix +++ b/nixos/modules/services/matrix/mautrix-signal.nix @@ -52,7 +52,7 @@ let in { options.services.mautrix-signal = { - enable = lib.mkEnableOption "mautrix-signal, a Matrix-Signal puppeting bridge."; + enable = lib.mkEnableOption "mautrix-signal, a Matrix-Signal puppeting bridge"; settings = lib.mkOption { apply = lib.recursiveUpdate defaultConfig; diff --git a/nixos/modules/services/matrix/mautrix-whatsapp.nix b/nixos/modules/services/matrix/mautrix-whatsapp.nix index 31f64c16d791..d124edc216dd 100644 --- a/nixos/modules/services/matrix/mautrix-whatsapp.nix +++ b/nixos/modules/services/matrix/mautrix-whatsapp.nix @@ -47,7 +47,7 @@ in { options.services.mautrix-whatsapp = { - enable = lib.mkEnableOption "mautrix-whatsapp, a puppeting/relaybot bridge between Matrix and WhatsApp."; + enable = lib.mkEnableOption "mautrix-whatsapp, a puppeting/relaybot bridge between Matrix and WhatsApp"; settings = lib.mkOption { type = settingsFormat.type; diff --git a/nixos/modules/services/misc/mqtt2influxdb.nix b/nixos/modules/services/misc/mqtt2influxdb.nix index 925139b449b8..d07ce1e66ba3 100644 --- a/nixos/modules/services/misc/mqtt2influxdb.nix +++ b/nixos/modules/services/misc/mqtt2influxdb.nix @@ -124,7 +124,7 @@ let in { options = { services.mqtt2influxdb = { - enable = mkEnableOption "BigClown MQTT to InfluxDB bridge."; + enable = mkEnableOption "BigClown MQTT to InfluxDB bridge"; package = mkPackageOption pkgs ["python3Packages" "mqtt2influxdb"] {}; environmentFiles = mkOption { type = types.listOf types.path; diff --git a/nixos/modules/services/misc/paperless.nix b/nixos/modules/services/misc/paperless.nix index e564fe3b8317..6d6a49c10bdd 100644 --- a/nixos/modules/services/misc/paperless.nix +++ b/nixos/modules/services/misc/paperless.nix @@ -225,7 +225,7 @@ in effectively never complete due to running into timeouts. This sets `OMP_NUM_THREADS` to `1` in order to mitigate the issue. See - https://github.com/NixOS/nixpkgs/issues/240591 for more information. + https://github.com/NixOS/nixpkgs/issues/240591 for more information '' // mkOption { default = true; }; }; diff --git a/nixos/modules/services/misc/portunus.nix b/nixos/modules/services/misc/portunus.nix index c7abb2cfa2a3..a9a069b0c055 100644 --- a/nixos/modules/services/misc/portunus.nix +++ b/nixos/modules/services/misc/portunus.nix @@ -70,7 +70,7 @@ in To activate dex, first a search user must be created in the Portunus web ui and then the password must to be set as the `DEX_SEARCH_USER_PASSWORD` environment variable - in the [](#opt-services.dex.environmentFile) setting. + in the [](#opt-services.dex.environmentFile) setting ''; oidcClients = mkOption { diff --git a/nixos/modules/services/misc/spice-autorandr.nix b/nixos/modules/services/misc/spice-autorandr.nix index 0d58d2865717..92b8a15e93c5 100644 --- a/nixos/modules/services/misc/spice-autorandr.nix +++ b/nixos/modules/services/misc/spice-autorandr.nix @@ -6,7 +6,7 @@ in { options = { services.spice-autorandr = { - enable = lib.mkEnableOption "spice-autorandr service that will automatically resize display to match SPICE client window size."; + enable = lib.mkEnableOption "spice-autorandr service that will automatically resize display to match SPICE client window size"; package = lib.mkPackageOption pkgs "spice-autorandr" { }; }; }; diff --git a/nixos/modules/services/monitoring/rustdesk-server.nix b/nixos/modules/services/monitoring/rustdesk-server.nix index 21e6128c7226..ea4dd43cbb35 100644 --- a/nixos/modules/services/monitoring/rustdesk-server.nix +++ b/nixos/modules/services/monitoring/rustdesk-server.nix @@ -4,7 +4,7 @@ let UDPPorts = [21116]; in { options.services.rustdesk-server = with lib; with types; { - enable = mkEnableOption "RustDesk, a remote access and remote control software, allowing maintenance of computers and other devices."; + enable = mkEnableOption "RustDesk, a remote access and remote control software, allowing maintenance of computers and other devices"; package = mkPackageOption pkgs "rustdesk-server" {}; diff --git a/nixos/modules/services/monitoring/thanos.nix b/nixos/modules/services/monitoring/thanos.nix index f4cec0a545cb..10f4d08f8874 100644 --- a/nixos/modules/services/monitoring/thanos.nix +++ b/nixos/modules/services/monitoring/thanos.nix @@ -696,7 +696,7 @@ in { }; store = paramsToOptions params.store // { - enable = mkEnableOption "the Thanos store node giving access to blocks in a bucket provider."; + enable = mkEnableOption "the Thanos store node giving access to blocks in a bucket provider"; arguments = mkArgumentsOption "store"; }; diff --git a/nixos/modules/services/monitoring/ups.nix b/nixos/modules/services/monitoring/ups.nix index 0a0d5eadccd3..35a2d61da1de 100644 --- a/nixos/modules/services/monitoring/ups.nix +++ b/nixos/modules/services/monitoring/ups.nix @@ -385,8 +385,8 @@ in power.ups = { enable = mkEnableOption '' - Enables support for Power Devices, such as Uninterruptible Power - Supplies, Power Distribution Units and Solar Controllers. + support for Power Devices, such as Uninterruptible Power + Supplies, Power Distribution Units and Solar Controllers ''; mode = mkOption { diff --git a/nixos/modules/services/network-filesystems/openafs/server.nix b/nixos/modules/services/network-filesystems/openafs/server.nix index a399aa6c23bc..8186277b4777 100644 --- a/nixos/modules/services/network-filesystems/openafs/server.nix +++ b/nixos/modules/services/network-filesystems/openafs/server.nix @@ -183,7 +183,7 @@ in { enableFabs = mkEnableOption '' FABS, the flexible AFS backup system. It stores volumes as dump files, relying on other - pre-existing backup solutions for handling them. + pre-existing backup solutions for handling them ''; buserverArgs = mkOption { diff --git a/nixos/modules/services/network-filesystems/samba-wsdd.nix b/nixos/modules/services/network-filesystems/samba-wsdd.nix index 608b48cf0305..f46bf802511a 100644 --- a/nixos/modules/services/network-filesystems/samba-wsdd.nix +++ b/nixos/modules/services/network-filesystems/samba-wsdd.nix @@ -10,7 +10,7 @@ in { services.samba-wsdd = { enable = mkEnableOption '' Web Services Dynamic Discovery host daemon. This enables (Samba) hosts, like your local NAS device, - to be found by Web Service Discovery Clients like Windows. + to be found by Web Service Discovery Clients like Windows ''; interface = mkOption { type = types.nullOr types.str; diff --git a/nixos/modules/services/networking/gns3-server.nix b/nixos/modules/services/networking/gns3-server.nix index ba0d6be30f49..b2f25b158bbb 100644 --- a/nixos/modules/services/networking/gns3-server.nix +++ b/nixos/modules/services/networking/gns3-server.nix @@ -87,17 +87,17 @@ in { }; dynamips = { - enable = lib.mkEnableOption ''Whether to enable Dynamips support.''; + enable = lib.mkEnableOption ''Dynamips support''; package = lib.mkPackageOptionMD pkgs "dynamips" { }; }; ubridge = { - enable = lib.mkEnableOption ''Whether to enable uBridge support.''; + enable = lib.mkEnableOption ''uBridge support''; package = lib.mkPackageOptionMD pkgs "ubridge" { }; }; vpcs = { - enable = lib.mkEnableOption ''Whether to enable VPCS support.''; + enable = lib.mkEnableOption ''VPCS support''; package = lib.mkPackageOptionMD pkgs "vpcs" { }; }; }; diff --git a/nixos/modules/services/networking/haproxy.nix b/nixos/modules/services/networking/haproxy.nix index c764b447b0cb..19b096bf4906 100644 --- a/nixos/modules/services/networking/haproxy.nix +++ b/nixos/modules/services/networking/haproxy.nix @@ -17,7 +17,7 @@ with lib; options = { services.haproxy = { - enable = mkEnableOption "HAProxy, the reliable, high performance TCP/HTTP load balancer."; + enable = mkEnableOption "HAProxy, the reliable, high performance TCP/HTTP load balancer"; package = mkPackageOption pkgs "haproxy" { }; diff --git a/nixos/modules/services/networking/hylafax/options.nix b/nixos/modules/services/networking/hylafax/options.nix index 1880aebe7a6b..973dfa054afc 100644 --- a/nixos/modules/services/networking/hylafax/options.nix +++ b/nixos/modules/services/networking/hylafax/options.nix @@ -312,9 +312,9 @@ in }; faxqclean.enable.spoolInit = mkEnableOption '' - Purge old files from the spooling area with + purging old files from the spooling area with {file}`faxqclean` - each time the spooling area is initialized. + each time the spooling area is initialized ''; faxqclean.enable.frequency = mkOption { type = nullOr nonEmptyStr; diff --git a/nixos/modules/services/networking/netbird/dashboard.nix b/nixos/modules/services/networking/netbird/dashboard.nix index 6fc308615590..788b724231be 100644 --- a/nixos/modules/services/networking/netbird/dashboard.nix +++ b/nixos/modules/services/networking/netbird/dashboard.nix @@ -39,7 +39,7 @@ in package = mkPackageOption pkgs "netbird-dashboard" { }; - enableNginx = mkEnableOption "Nginx reverse-proxy to serve the dashboard."; + enableNginx = mkEnableOption "Nginx reverse-proxy to serve the dashboard"; domain = mkOption { type = str; diff --git a/nixos/modules/services/networking/netbird/management.nix b/nixos/modules/services/networking/netbird/management.nix index 52f033959143..f4b5bbf64323 100644 --- a/nixos/modules/services/networking/netbird/management.nix +++ b/nixos/modules/services/networking/netbird/management.nix @@ -137,7 +137,7 @@ in { options.services.netbird.server.management = { - enable = mkEnableOption "Netbird Management Service."; + enable = mkEnableOption "Netbird Management Service"; package = mkPackageOption pkgs "netbird" { }; @@ -335,7 +335,7 @@ in description = "Log level of the netbird services."; }; - enableNginx = mkEnableOption "Nginx reverse-proxy for the netbird management service."; + enableNginx = mkEnableOption "Nginx reverse-proxy for the netbird management service"; }; config = mkIf cfg.enable { diff --git a/nixos/modules/services/networking/netbird/server.nix b/nixos/modules/services/networking/netbird/server.nix index 2b6ad696646e..cfda801999c7 100644 --- a/nixos/modules/services/networking/netbird/server.nix +++ b/nixos/modules/services/networking/netbird/server.nix @@ -31,7 +31,7 @@ in options.services.netbird.server = { enable = mkEnableOption "Netbird Server stack, comprising the dashboard, management API and signal service"; - enableNginx = mkEnableOption "Nginx reverse-proxy for the netbird server services."; + enableNginx = mkEnableOption "Nginx reverse-proxy for the netbird server services"; domain = mkOption { type = str; diff --git a/nixos/modules/services/networking/netbird/signal.nix b/nixos/modules/services/networking/netbird/signal.nix index 8408d20e874b..b53e9d40c2ee 100644 --- a/nixos/modules/services/networking/netbird/signal.nix +++ b/nixos/modules/services/networking/netbird/signal.nix @@ -28,7 +28,7 @@ in package = mkPackageOption pkgs "netbird" { }; - enableNginx = mkEnableOption "Nginx reverse-proxy for the netbird signal service."; + enableNginx = mkEnableOption "Nginx reverse-proxy for the netbird signal service"; domain = mkOption { type = str; diff --git a/nixos/modules/services/networking/networkd-dispatcher.nix b/nixos/modules/services/networking/networkd-dispatcher.nix index 039888e3c064..427835870e59 100644 --- a/nixos/modules/services/networking/networkd-dispatcher.nix +++ b/nixos/modules/services/networking/networkd-dispatcher.nix @@ -14,7 +14,7 @@ in { enable = mkEnableOption '' Networkd-dispatcher service for systemd-networkd connection status change. See [https://gitlab.com/craftyguy/networkd-dispatcher](upstream instructions) - for usage. + for usage ''; rules = mkOption { diff --git a/nixos/modules/services/networking/nncp.nix b/nixos/modules/services/networking/nncp.nix index f4ed7ecc7d4a..8c5b5a61a181 100644 --- a/nixos/modules/services/networking/nncp.nix +++ b/nixos/modules/services/networking/nncp.nix @@ -34,9 +34,7 @@ in { [](#opt-programs.nncp.settings) ''; socketActivation = { - enable = mkEnableOption '' - Whether to run nncp-daemon persistently or socket-activated. - ''; + enable = mkEnableOption "socket activation for nncp-daemon"; listenStreams = mkOption { type = with types; listOf str; description = '' diff --git a/nixos/modules/services/security/fail2ban.nix b/nixos/modules/services/security/fail2ban.nix index c4031b64ba6a..b6ce42d7318c 100644 --- a/nixos/modules/services/security/fail2ban.nix +++ b/nixos/modules/services/security/fail2ban.nix @@ -263,7 +263,7 @@ in ''; type = with types; attrsOf (either lines (submodule ({ name, ... }: { options = { - enabled = mkEnableOption "this jail." // { + enabled = mkEnableOption "this jail" // { default = true; readOnly = name == "DEFAULT"; }; diff --git a/nixos/modules/services/security/haveged.nix b/nixos/modules/services/security/haveged.nix index 57cef7e44d50..4c686d74268a 100644 --- a/nixos/modules/services/security/haveged.nix +++ b/nixos/modules/services/security/haveged.nix @@ -17,7 +17,7 @@ in enable = mkEnableOption '' haveged entropy daemon, which refills /dev/random when low. - NOTE: does nothing on kernels newer than 5.6. + NOTE: does nothing on kernels newer than 5.6 ''; # source for the note https://github.com/jirka-h/haveged/issues/57 diff --git a/nixos/modules/services/web-apps/audiobookshelf.nix b/nixos/modules/services/web-apps/audiobookshelf.nix index 84dffc5f9d3c..2f00c852ac8f 100644 --- a/nixos/modules/services/web-apps/audiobookshelf.nix +++ b/nixos/modules/services/web-apps/audiobookshelf.nix @@ -8,7 +8,7 @@ in { options = { services.audiobookshelf = { - enable = mkEnableOption "Audiobookshelf, self-hosted audiobook and podcast server."; + enable = mkEnableOption "Audiobookshelf, self-hosted audiobook and podcast server"; package = mkPackageOption pkgs "audiobookshelf" { }; diff --git a/nixos/modules/services/web-apps/jitsi-meet.nix b/nixos/modules/services/web-apps/jitsi-meet.nix index 76753b89ec9e..247b65c78663 100644 --- a/nixos/modules/services/web-apps/jitsi-meet.nix +++ b/nixos/modules/services/web-apps/jitsi-meet.nix @@ -170,7 +170,7 @@ in ''; }; - caddy.enable = mkEnableOption "Whether to enable caddy reverse proxy to expose jitsi-meet"; + caddy.enable = mkEnableOption "caddy reverse proxy to expose jitsi-meet"; prosody.enable = mkOption { type = bool; diff --git a/nixos/modules/services/web-apps/nextcloud.nix b/nixos/modules/services/web-apps/nextcloud.nix in |