diff options
author | Pavel Goran <me@pvgoran.name> | 2018-10-05 13:14:45 +0700 |
---|---|---|
committer | Pavel Goran <me@pvgoran.name> | 2018-10-05 13:14:45 +0700 |
commit | 858b263bf0f9844d6924c0af4ffc690af2fb4496 (patch) | |
tree | b318093f208eb2c3cfdf23ad24358588716b670e /nixos | |
parent | 89beaef64dae87eb31f3537d3b0921d7585c7ab6 (diff) | |
download | nixpkgs-858b263bf0f9844d6924c0af4ffc690af2fb4496.tar nixpkgs-858b263bf0f9844d6924c0af4ffc690af2fb4496.tar.gz nixpkgs-858b263bf0f9844d6924c0af4ffc690af2fb4496.tar.bz2 nixpkgs-858b263bf0f9844d6924c0af4ffc690af2fb4496.tar.lz nixpkgs-858b263bf0f9844d6924c0af4ffc690af2fb4496.tar.xz nixpkgs-858b263bf0f9844d6924c0af4ffc690af2fb4496.tar.zst nixpkgs-858b263bf0f9844d6924c0af4ffc690af2fb4496.zip |
nixos: correct improper uses of mkEnableOption, clarify service descriptions
Several service definitions used `mkEnableOption` with text starting with "Whether to", which produced funny option descriptions like "Whether to enable Whether to run the rspamd daemon..". This commit corrects this, and adds short descriptions of services to affected service definitions.
Diffstat (limited to 'nixos')
-rw-r--r-- | nixos/modules/config/krb5/default.nix | 2 | ||||
-rw-r--r-- | nixos/modules/services/mail/rspamd.nix | 2 | ||||
-rw-r--r-- | nixos/modules/services/networking/pptpd.nix | 2 | ||||
-rw-r--r-- | nixos/modules/services/networking/xl2tpd.nix | 2 | ||||
-rw-r--r-- | nixos/modules/services/networking/xrdp.nix | 2 | ||||
-rw-r--r-- | nixos/modules/services/system/saslauthd.nix | 2 | ||||
-rw-r--r-- | nixos/modules/virtualisation/xe-guest-utilities.nix | 2 |
7 files changed, 7 insertions, 7 deletions
diff --git a/nixos/modules/config/krb5/default.nix b/nixos/modules/config/krb5/default.nix index c22e99a0a2f..87021a27d34 100644 --- a/nixos/modules/config/krb5/default.nix +++ b/nixos/modules/config/krb5/default.nix @@ -79,7 +79,7 @@ in { options = { krb5 = { - enable = mkEnableOption "Whether to enable Kerberos V."; + enable = mkEnableOption "building krb5.conf, configuration file for Kerberos V"; kerberos = mkOption { type = types.package; diff --git a/nixos/modules/services/mail/rspamd.nix b/nixos/modules/services/mail/rspamd.nix index bba11796a3d..ff01a5dee53 100644 --- a/nixos/modules/services/mail/rspamd.nix +++ b/nixos/modules/services/mail/rspamd.nix @@ -159,7 +159,7 @@ in services.rspamd = { - enable = mkEnableOption "Whether to run the rspamd daemon."; + enable = mkEnableOption "rspamd, the Rapid spam filtering system"; debug = mkOption { type = types.bool; diff --git a/nixos/modules/services/networking/pptpd.nix b/nixos/modules/services/networking/pptpd.nix index 56a612b9105..d8b9e8f8341 100644 --- a/nixos/modules/services/networking/pptpd.nix +++ b/nixos/modules/services/networking/pptpd.nix @@ -5,7 +5,7 @@ with lib; { options = { services.pptpd = { - enable = mkEnableOption "Whether pptpd should be run on startup."; + enable = mkEnableOption "pptpd, the Point-to-Point Tunneling Protocol daemon"; serverIp = mkOption { type = types.string; diff --git a/nixos/modules/services/networking/xl2tpd.nix b/nixos/modules/services/networking/xl2tpd.nix index 46111a76af8..d0a3ed7bb5e 100644 --- a/nixos/modules/services/networking/xl2tpd.nix +++ b/nixos/modules/services/networking/xl2tpd.nix @@ -5,7 +5,7 @@ with lib; { options = { services.xl2tpd = { - enable = mkEnableOption "Whether xl2tpd should be run on startup."; + enable = mkEnableOption "xl2tpd, the Layer 2 Tunnelling Protocol Daemon"; serverIp = mkOption { type = types.string; diff --git a/nixos/modules/services/networking/xrdp.nix b/nixos/modules/services/networking/xrdp.nix index 61f22a366a0..9ed3025e47d 100644 --- a/nixos/modules/services/networking/xrdp.nix +++ b/nixos/modules/services/networking/xrdp.nix @@ -36,7 +36,7 @@ in services.xrdp = { - enable = mkEnableOption "Whether xrdp should be run on startup."; + enable = mkEnableOption "xrdp, the Remote Desktop Protocol server"; package = mkOption { type = types.package; diff --git a/nixos/modules/services/system/saslauthd.nix b/nixos/modules/services/system/saslauthd.nix index c8ddca9a0db..8fcf4fb91fc 100644 --- a/nixos/modules/services/system/saslauthd.nix +++ b/nixos/modules/services/system/saslauthd.nix @@ -16,7 +16,7 @@ in services.saslauthd = { - enable = mkEnableOption "Whether to enable the Cyrus SASL authentication daemon."; + enable = mkEnableOption "saslauthd, the Cyrus SASL authentication daemon"; package = mkOption { default = pkgs.cyrus_sasl.bin; diff --git a/nixos/modules/virtualisation/xe-guest-utilities.nix b/nixos/modules/virtualisation/xe-guest-utilities.nix index d703353858c..675cf929737 100644 --- a/nixos/modules/virtualisation/xe-guest-utilities.nix +++ b/nixos/modules/virtualisation/xe-guest-utilities.nix @@ -5,7 +5,7 @@ let in { options = { services.xe-guest-utilities = { - enable = mkEnableOption "Whether to enable the Xen guest utilities daemon."; + enable = mkEnableOption "the Xen guest utilities daemon"; }; }; config = mkIf cfg.enable { |