nixos/*: remove trailing period in mkEnableOptions

those are added by mkEnableOption, and .. is replaced to … by markdown
processing.
This commit is contained in:
pennae
2023-02-01 06:12:57 +01:00
committed by Florian Brandes
parent cb12267aa0
commit 2610f45516
27 changed files with 39 additions and 39 deletions

View File

@@ -15,7 +15,7 @@ let
in in
{ {
options.networking.stevenblack = { options.networking.stevenblack = {
enable = mkEnableOption (mdDoc "Enable the stevenblack hosts file blocklist."); enable = mkEnableOption (mdDoc "Enable the stevenblack hosts file blocklist");
block = mkOption { block = mkOption {
type = types.listOf (types.enum [ "fakenews" "gambling" "porn" "social" ]); type = types.listOf (types.enum [ "fakenews" "gambling" "porn" "social" ]);

View File

@@ -86,7 +86,7 @@ in {
description = lib.mdDoc "Proxy DNS requests - no leak for DNS data."; description = lib.mdDoc "Proxy DNS requests - no leak for DNS data.";
}; };
quietMode = mkEnableOption (lib.mdDoc "Quiet mode (no output from the library)."); quietMode = mkEnableOption (lib.mdDoc "Quiet mode (no output from the library)");
remoteDNSSubnet = mkOption { remoteDNSSubnet = mkOption {
type = types.enum [ 10 127 224 ]; type = types.enum [ 10 127 224 ];

View File

@@ -14,7 +14,7 @@ in
security.polkit.enable = mkEnableOption (lib.mdDoc "polkit"); security.polkit.enable = mkEnableOption (lib.mdDoc "polkit");
security.polkit.debug = mkEnableOption (lib.mdDoc "debug logs from polkit. This is required in order to see log messages from rule definitions."); security.polkit.debug = mkEnableOption (lib.mdDoc "debug logs from polkit. This is required in order to see log messages from rule definitions");
security.polkit.extraConfig = mkOption { security.polkit.extraConfig = mkOption {
type = types.lines; type = types.lines;

View File

@@ -9,7 +9,7 @@ let
in { in {
options = { options = {
services.zfs.autoReplication = { services.zfs.autoReplication = {
enable = mkEnableOption (lib.mdDoc "ZFS snapshot replication."); enable = mkEnableOption (lib.mdDoc "ZFS snapshot replication");
followDelete = mkOption { followDelete = mkOption {
description = lib.mdDoc "Remove remote snapshots that don't have a local correspondent."; description = lib.mdDoc "Remove remote snapshots that don't have a local correspondent.";

View File

@@ -62,7 +62,7 @@ in
''; '';
}; };
enable = mkEnableOption (lib.mdDoc "Kubernetes addon manager."); enable = mkEnableOption (lib.mdDoc "Kubernetes addon manager");
}; };
###### implementation ###### implementation

View File

@@ -146,7 +146,7 @@ in
default = "unix:///run/containerd/containerd.sock"; default = "unix:///run/containerd/containerd.sock";
}; };
enable = mkEnableOption (lib.mdDoc "Kubernetes kubelet."); enable = mkEnableOption (lib.mdDoc "Kubernetes kubelet");
extraOpts = mkOption { extraOpts = mkOption {
description = lib.mdDoc "Kubernetes kubelet extra command line options."; description = lib.mdDoc "Kubernetes kubelet extra command line options.";

View File

@@ -27,7 +27,7 @@ with lib;
options = { options = {
services.gnome.evolution-data-server = { services.gnome.evolution-data-server = {
enable = mkEnableOption (lib.mdDoc "Evolution Data Server, a collection of services for storing addressbooks and calendars."); enable = mkEnableOption (lib.mdDoc "Evolution Data Server, a collection of services for storing addressbooks and calendars");
plugins = mkOption { plugins = mkOption {
type = types.listOf types.package; type = types.listOf types.package;
default = [ ]; default = [ ];
@@ -35,7 +35,7 @@ with lib;
}; };
}; };
programs.evolution = { programs.evolution = {
enable = mkEnableOption (lib.mdDoc "Evolution, a Personal information management application that provides integrated mail, calendaring and address book functionality."); enable = mkEnableOption (lib.mdDoc "Evolution, a Personal information management application that provides integrated mail, calendaring and address book functionality");
plugins = mkOption { plugins = mkOption {
type = types.listOf types.package; type = types.listOf types.package;
default = [ ]; default = [ ];

View File

@@ -28,7 +28,7 @@ in
options = { options = {
services.zammad = { services.zammad = {
enable = mkEnableOption (lib.mdDoc "Zammad, a web-based, open source user support/ticketing solution."); enable = mkEnableOption (lib.mdDoc "Zammad, a web-based, open source user support/ticketing solution");
package = mkOption { package = mkOption {
type = types.package; type = types.package;

View File

@@ -54,7 +54,7 @@ in
default = 0; default = 0;
description = lib.mdDoc "Set debug log level."; description = lib.mdDoc "Set debug log level.";
}; };
options.exit-on-end = mkEnableOption (lib.mdDoc "exit instead of restarting when a game ends."); options.exit-on-end = mkEnableOption (lib.mdDoc "exit instead of restarting when a game ends");
options.Guests = mkEnableOption (lib.mdDoc "guests to login if auth is enabled"); options.Guests = mkEnableOption (lib.mdDoc "guests to login if auth is enabled");
options.Newusers = mkEnableOption (lib.mdDoc "new users to login if auth is enabled"); options.Newusers = mkEnableOption (lib.mdDoc "new users to login if auth is enabled");
options.port = mkOption { options.port = mkOption {

View File

@@ -19,7 +19,7 @@ in
services.udisks2 = { services.udisks2 = {
enable = mkEnableOption (lib.mdDoc "udisks2, a DBus service that allows applications to query and manipulate storage devices."); enable = mkEnableOption (lib.mdDoc "udisks2, a DBus service that allows applications to query and manipulate storage devices");
settings = mkOption rec { settings = mkOption rec {
type = types.attrsOf settingsFormat.type; type = types.attrsOf settingsFormat.type;

View File

@@ -171,11 +171,11 @@ in
options.services.dovecot2 = { options.services.dovecot2 = {
enable = mkEnableOption (lib.mdDoc "the dovecot 2.x POP3/IMAP server"); enable = mkEnableOption (lib.mdDoc "the dovecot 2.x POP3/IMAP server");
enablePop3 = mkEnableOption (lib.mdDoc "starting the POP3 listener (when Dovecot is enabled)."); enablePop3 = mkEnableOption (lib.mdDoc "starting the POP3 listener (when Dovecot is enabled)");
enableImap = mkEnableOption (lib.mdDoc "starting the IMAP listener (when Dovecot is enabled).") // { default = true; }; enableImap = mkEnableOption (lib.mdDoc "starting the IMAP listener (when Dovecot is enabled)") // { default = true; };
enableLmtp = mkEnableOption (lib.mdDoc "starting the LMTP listener (when Dovecot is enabled)."); enableLmtp = mkEnableOption (lib.mdDoc "starting the LMTP listener (when Dovecot is enabled)");
protocols = mkOption { protocols = mkOption {
type = types.listOf types.str; type = types.listOf types.str;
@@ -300,9 +300,9 @@ in
description = lib.mdDoc "Path to the server's private key."; description = lib.mdDoc "Path to the server's private key.";
}; };
enablePAM = mkEnableOption (lib.mdDoc "creating a own Dovecot PAM service and configure PAM user logins.") // { default = true; }; enablePAM = mkEnableOption (lib.mdDoc "creating a own Dovecot PAM service and configure PAM user logins") // { default = true; };
enableDHE = mkEnableOption (lib.mdDoc "enable ssl_dh and generation of primes for the key exchange.") // { default = true; }; enableDHE = mkEnableOption (lib.mdDoc "enable ssl_dh and generation of primes for the key exchange") // { default = true; };
sieveScripts = mkOption { sieveScripts = mkOption {
type = types.attrsOf types.path; type = types.attrsOf types.path;
@@ -310,7 +310,7 @@ in
description = lib.mdDoc "Sieve scripts to be executed. Key is a sequence, e.g. 'before2', 'after' etc."; description = lib.mdDoc "Sieve scripts to be executed. Key is a sequence, e.g. 'before2', 'after' etc.";
}; };
showPAMFailure = mkEnableOption (lib.mdDoc "showing the PAM failure message on authentication error (useful for OTPW)."); showPAMFailure = mkEnableOption (lib.mdDoc "showing the PAM failure message on authentication error (useful for OTPW)");
mailboxes = mkOption { mailboxes = mkOption {
type = with types; coercedTo type = with types; coercedTo
@@ -326,7 +326,7 @@ in
description = lib.mdDoc "Configure mailboxes and auto create or subscribe them."; description = lib.mdDoc "Configure mailboxes and auto create or subscribe them.";
}; };
enableQuota = mkEnableOption (lib.mdDoc "the dovecot quota service."); enableQuota = mkEnableOption (lib.mdDoc "the dovecot quota service");
quotaPort = mkOption { quotaPort = mkOption {
type = types.str; type = types.str;

View File

@@ -8,7 +8,7 @@ in
{ {
options = { options = {
services.atuin = { services.atuin = {
enable = mkEnableOption (mdDoc "Enable server for shell history sync with atuin."); enable = mkEnableOption (mdDoc "Enable server for shell history sync with atuin");
openRegistration = mkOption { openRegistration = mkOption {
type = types.bool; type = types.bool;

View File

@@ -6,7 +6,7 @@ let cfg = config.services.input-remapper; in
{ {
options = { options = {
services.input-remapper = { services.input-remapper = {
enable = mkEnableOption (lib.mdDoc "input-remapper, an easy to use tool to change the mapping of your input device buttons."); enable = mkEnableOption (lib.mdDoc "input-remapper, an easy to use tool to change the mapping of your input device buttons");
package = mkPackageOptionMD pkgs "input-remapper" { }; package = mkPackageOptionMD pkgs "input-remapper" { };
enableUdevRules = mkEnableOption (lib.mdDoc "udev rules added by input-remapper to handle hotplugged devices. Currently disabled by default due to https://github.com/sezanzeb/input-remapper/issues/140"); enableUdevRules = mkEnableOption (lib.mdDoc "udev rules added by input-remapper to handle hotplugged devices. Currently disabled by default due to https://github.com/sezanzeb/input-remapper/issues/140");
serviceWantedBy = mkOption { serviceWantedBy = mkOption {

View File

@@ -438,7 +438,7 @@ in
}; };
options."lists.sr.ht" = commonServiceSettings "lists" // { options."lists.sr.ht" = commonServiceSettings "lists" // {
allow-new-lists = mkEnableOption (lib.mdDoc "Allow creation of new lists."); allow-new-lists = mkEnableOption (lib.mdDoc "Allow creation of new lists");
notify-from = mkOption { notify-from = mkOption {
description = lib.mdDoc "Outgoing email for notifications generated by users."; description = lib.mdDoc "Outgoing email for notifications generated by users.";
type = types.str; type = types.str;

View File

@@ -11,7 +11,7 @@ in {
# the upstream package runs as root, but doesn't seem to be strictly # the upstream package runs as root, but doesn't seem to be strictly
# necessary for basic functionality # necessary for basic functionality
runAsRoot = mkEnableOption (lib.mdDoc "Whether to run as root."); runAsRoot = mkEnableOption (lib.mdDoc "Whether to run as root");
autoRetirement = mkEnableOption (lib.mdDoc '' autoRetirement = mkEnableOption (lib.mdDoc ''
Whether to automatically retire the host upon OS shutdown. Whether to automatically retire the host upon OS shutdown.

View File

@@ -24,9 +24,9 @@ in {
inherit (options.services.unpoller.unifi) controllers; inherit (options.services.unpoller.unifi) controllers;
inherit (options.services.unpoller) loki; inherit (options.services.unpoller) loki;
log = { log = {
debug = mkEnableOption (lib.mdDoc "debug logging including line numbers, high resolution timestamps, per-device logs."); debug = mkEnableOption (lib.mdDoc "debug logging including line numbers, high resolution timestamps, per-device logs");
quiet = mkEnableOption (lib.mdDoc "startup and error logs only."); quiet = mkEnableOption (lib.mdDoc "startup and error logs only");
prometheusErrors = mkEnableOption (lib.mdDoc "emitting errors to prometheus."); prometheusErrors = mkEnableOption (lib.mdDoc "emitting errors to prometheus");
}; };
}; };

View File

@@ -11,7 +11,7 @@ in
options = { options = {
services.uptime-kuma = { services.uptime-kuma = {
enable = mkEnableOption (mdDoc "Uptime Kuma, this assumes a reverse proxy to be set."); enable = mkEnableOption (mdDoc "Uptime Kuma, this assumes a reverse proxy to be set");
package = mkOption { package = mkOption {
type = types.package; type = types.package;
@@ -20,7 +20,7 @@ in
description = lib.mdDoc "Uptime Kuma package to use."; description = lib.mdDoc "Uptime Kuma package to use.";
}; };
appriseSupport = mkEnableOption (mdDoc "apprise support for notifications."); appriseSupport = mkEnableOption (mdDoc "apprise support for notifications");
settings = lib.mkOption { settings = lib.mkOption {
type = lib.types.submodule { freeformType = with lib.types; attrsOf str; }; type = lib.types.submodule { freeformType = with lib.types; attrsOf str; };

View File

@@ -85,7 +85,7 @@ in {
description = lib.mdDoc "Run daemons as user moosefs instead of root."; description = lib.mdDoc "Run daemons as user moosefs instead of root.";
}; };
client.enable = mkEnableOption (lib.mdDoc "Moosefs client."); client.enable = mkEnableOption (lib.mdDoc "Moosefs client");
master = { master = {
enable = mkOption { enable = mkOption {
@@ -131,7 +131,7 @@ in {
}; };
metalogger = { metalogger = {
enable = mkEnableOption (lib.mdDoc "Moosefs metalogger daemon."); enable = mkEnableOption (lib.mdDoc "Moosefs metalogger daemon");
settings = mkOption { settings = mkOption {
type = types.submodule { type = types.submodule {
@@ -149,7 +149,7 @@ in {
}; };
chunkserver = { chunkserver = {
enable = mkEnableOption (lib.mdDoc "Moosefs chunkserver daemon."); enable = mkEnableOption (lib.mdDoc "Moosefs chunkserver daemon");
openFirewall = mkOption { openFirewall = mkOption {
type = types.bool; type = types.bool;

View File

@@ -10,7 +10,7 @@ let
options = { options = {
enable = mkEnableOption (lib.mdDoc "blockbook-frontend application."); enable = mkEnableOption (lib.mdDoc "blockbook-frontend application");
package = mkOption { package = mkOption {
type = types.package; type = types.package;

View File

@@ -55,7 +55,7 @@ in
options.services.kanidm = { options.services.kanidm = {
enableClient = lib.mkEnableOption (lib.mdDoc "the Kanidm client"); enableClient = lib.mkEnableOption (lib.mdDoc "the Kanidm client");
enableServer = lib.mkEnableOption (lib.mdDoc "the Kanidm server"); enableServer = lib.mkEnableOption (lib.mdDoc "the Kanidm server");
enablePam = lib.mkEnableOption (lib.mdDoc "the Kanidm PAM and NSS integration."); enablePam = lib.mkEnableOption (lib.mdDoc "the Kanidm PAM and NSS integration");
serverSettings = lib.mkOption { serverSettings = lib.mkOption {
type = lib.types.submodule { type = lib.types.submodule {

View File

@@ -68,7 +68,7 @@ let
in in
{ {
options.services.cloudlog = with types; { options.services.cloudlog = with types; {
enable = mkEnableOption (mdDoc "Whether to enable Cloudlog."); enable = mkEnableOption (mdDoc "Whether to enable Cloudlog");
dataDir = mkOption { dataDir = mkOption {
type = str; type = str;
default = "/var/lib/cloudlog"; default = "/var/lib/cloudlog";

View File

@@ -148,7 +148,7 @@ let
]; ];
options = { options = {
enable = mkEnableOption (lib.mdDoc "DokuWiki web application."); enable = mkEnableOption (lib.mdDoc "DokuWiki web application");
package = mkOption { package = mkOption {
type = types.package; type = types.package;

View File

@@ -12,7 +12,7 @@ in
{ {
options = { options = {
services.galene = { services.galene = {
enable = mkEnableOption (lib.mdDoc "Galene Service."); enable = mkEnableOption (lib.mdDoc "Galene Service");
stateDir = mkOption { stateDir = mkOption {
default = defaultstateDir; default = defaultstateDir;

View File

@@ -7,7 +7,7 @@ in {
enable = mkEnableOption (lib.mdDoc "hledger-web service"); enable = mkEnableOption (lib.mdDoc "hledger-web service");
serveApi = mkEnableOption (lib.mdDoc "Serve only the JSON web API, without the web UI."); serveApi = mkEnableOption (lib.mdDoc "Serve only the JSON web API, without the web UI");
host = mkOption { host = mkOption {
type = types.str; type = types.str;

View File

@@ -36,7 +36,7 @@ in
description = lib.mdDoc "Location of Jirafeau storage directory."; description = lib.mdDoc "Location of Jirafeau storage directory.";
}; };
enable = mkEnableOption (lib.mdDoc "Jirafeau file upload application."); enable = mkEnableOption (lib.mdDoc "Jirafeau file upload application");
extraConfig = mkOption { extraConfig = mkOption {
type = types.lines; type = types.lines;

View File

@@ -32,7 +32,7 @@ in
# interface # interface
options.services.limesurvey = { options.services.limesurvey = {
enable = mkEnableOption (lib.mdDoc "Limesurvey web application."); enable = mkEnableOption (lib.mdDoc "Limesurvey web application");
database = { database = {
type = mkOption { type = mkOption {

View File

@@ -20,7 +20,7 @@ in
###### interface ###### interface
options = { options = {
boot.kernel.enable = mkEnableOption (lib.mdDoc "the Linux kernel. This is useful for systemd-like containers which do not require a kernel.") // { boot.kernel.enable = mkEnableOption (lib.mdDoc "the Linux kernel. This is useful for systemd-like containers which do not require a kernel") // {
default = true; default = true;
}; };