nixos: add some missing '.' in option descriptions

Changed files
+19 -19
nixos
modules
config
programs
services
databases
tasks
+2 -2
nixos/modules/config/krb5.nix
···
kdc = mkOption {
default = "kerberos.mit.edu";
-
description = "Kerberos Domain Controller";
};
kerberosAdminServer = mkOption {
default = "kerberos.mit.edu";
-
description = "Kerberos Admin Server";
};
};
···
kdc = mkOption {
default = "kerberos.mit.edu";
+
description = "Kerberos Domain Controller.";
};
kerberosAdminServer = mkOption {
default = "kerberos.mit.edu";
+
description = "Kerberos Admin Server.";
};
};
+1 -1
nixos/modules/programs/atop.nix
···
interval = 5;
};
description = ''
-
Parameters to be written to <filename>/etc/atoprc</filename>
'';
};
···
interval = 5;
};
description = ''
+
Parameters to be written to <filename>/etc/atoprc</filename>.
'';
};
+12 -12
nixos/modules/services/databases/redis.nix
···
user = mkOption {
default = "redis";
-
description = "User account under which Redis runs";
};
pidFile = mkOption {
···
port = mkOption {
default = 6379;
-
description = "The port for Redis to listen to";
type = with types; int;
};
bind = mkOption {
default = null; # All interfaces
-
description = "The IP interface to bind to";
example = "127.0.0.1";
};
unixSocket = mkOption {
default = null;
-
description = "The path to the socket to bind to";
example = "/var/run/redis.sock";
};
logLevel = mkOption {
default = "notice"; # debug, verbose, notice, warning
example = "debug";
-
description = "Specify the server verbosity level, options: debug, verbose, notice, warning";
type = with types; string;
};
···
dbFilename = mkOption {
default = "dump.rdb";
-
description = "The filename where to dump the DB";
type = with types; string;
};
dbpath = mkOption {
default = "/var/lib/redis";
-
description = "The DB will be written inside this directory, with the filename specified using the 'dbFilename' configuration";
type = with types; string;
};
slaveOf = mkOption {
default = null; # { ip, port }
-
description = "An attribute set with two attributes: ip and port to which this redis instance acts as a slave";
example = { ip = "192.168.1.100"; port = 6379; };
};
···
appendFsync = mkOption {
default = "everysec"; # no, always, everysec
-
description = "How often to fsync the append-only log, options: no, always, everysec";
type = with types; string;
};
slowLogLogSlowerThan = mkOption {
default = 10000;
-
description = "Log queries whose execution take longer than X in milliseconds";
example = 1000;
type = with types; int;
};
slowLogMaxLen = mkOption {
default = 128;
-
description = "Maximum number of items to keep in slow log";
type = with types; int;
};
extraConfig = mkOption {
default = "";
-
description = "Extra configuration options for redis.conf";
type = with types; string;
};
};
···
user = mkOption {
default = "redis";
+
description = "User account under which Redis runs.";
};
pidFile = mkOption {
···
port = mkOption {
default = 6379;
+
description = "The port for Redis to listen to.";
type = with types; int;
};
bind = mkOption {
default = null; # All interfaces
+
description = "The IP interface to bind to.";
example = "127.0.0.1";
};
unixSocket = mkOption {
default = null;
+
description = "The path to the socket to bind to.";
example = "/var/run/redis.sock";
};
logLevel = mkOption {
default = "notice"; # debug, verbose, notice, warning
example = "debug";
+
description = "Specify the server verbosity level, options: debug, verbose, notice, warning.";
type = with types; string;
};
···
dbFilename = mkOption {
default = "dump.rdb";
+
description = "The filename where to dump the DB.";
type = with types; string;
};
dbpath = mkOption {
default = "/var/lib/redis";
+
description = "The DB will be written inside this directory, with the filename specified using the 'dbFilename' configuration.";
type = with types; string;
};
slaveOf = mkOption {
default = null; # { ip, port }
+
description = "An attribute set with two attributes: ip and port to which this redis instance acts as a slave.";
example = { ip = "192.168.1.100"; port = 6379; };
};
···
appendFsync = mkOption {
default = "everysec"; # no, always, everysec
+
description = "How often to fsync the append-only log, options: no, always, everysec.";
type = with types; string;
};
slowLogLogSlowerThan = mkOption {
default = 10000;
+
description = "Log queries whose execution take longer than X in milliseconds.";
example = 1000;
type = with types; int;
};
slowLogMaxLen = mkOption {
default = 128;
+
description = "Maximum number of items to keep in slow log.";
type = with types; int;
};
extraConfig = mkOption {
default = "";
+
description = "Extra configuration options for redis.conf.";
type = with types; string;
};
};
+4 -4
nixos/modules/tasks/encrypted-devices.nix
···
enable = mkOption {
default = false;
type = types.bool;
-
description = "The block device is backed by an encrypted one, adds this device as a initrd luks entry";
};
blkDev = mkOption {
default = null;
example = "/dev/sda1";
type = types.uniq (types.nullOr types.string);
-
description = "Location of the backing encrypted device";
};
label = mkOption {
default = null;
example = "rootfs";
type = types.uniq (types.nullOr types.string);
-
description = "Label of the backing encrypted device";
};
keyFile = mkOption {
default = null;
example = "/root/.swapkey";
type = types.uniq (types.nullOr types.string);
-
description = "File system location of keyfile";
};
};
};
···
enable = mkOption {
default = false;
type = types.bool;
+
description = "The block device is backed by an encrypted one, adds this device as a initrd luks entry.";
};
blkDev = mkOption {
default = null;
example = "/dev/sda1";
type = types.uniq (types.nullOr types.string);
+
description = "Location of the backing encrypted device.";
};
label = mkOption {
default = null;
example = "rootfs";
type = types.uniq (types.nullOr types.string);
+
description = "Label of the backing encrypted device.";
};
keyFile = mkOption {
default = null;
example = "/root/.swapkey";
type = types.uniq (types.nullOr types.string);
+
description = "File system location of keyfile.";
};
};
};