nixos/mysql: cleanup some descriptions

This commit is contained in:
Aaron Andersen 2020-08-11 21:17:02 -04:00
parent ff9921f0fd
commit 31098a03a2

View File

@ -20,7 +20,7 @@ in
{ {
imports = [ imports = [
(mkRemovedOptionModule [ "services" "mysql" "pidDir" ] "Don't wait for pidfiles, describe dependencies through systemd") (mkRemovedOptionModule [ "services" "mysql" "pidDir" ] "Don't wait for pidfiles, describe dependencies through systemd.")
(mkRemovedOptionModule [ "services" "mysql" "rootPassword" ] "Use socket authentication or set the password outside of the nix store.") (mkRemovedOptionModule [ "services" "mysql" "rootPassword" ] "Use socket authentication or set the password outside of the nix store.")
]; ];
@ -44,19 +44,19 @@ in
type = types.nullOr types.str; type = types.nullOr types.str;
default = null; default = null;
example = literalExample "0.0.0.0"; example = literalExample "0.0.0.0";
description = "Address to bind to. The default is to bind to all addresses"; description = "Address to bind to. The default is to bind to all addresses.";
}; };
port = mkOption { port = mkOption {
type = types.int; type = types.int;
default = 3306; default = 3306;
description = "Port of MySQL"; description = "Port of MySQL.";
}; };
user = mkOption { user = mkOption {
type = types.str; type = types.str;
default = "mysql"; default = "mysql";
description = "User account under which MySQL runs"; description = "User account under which MySQL runs.";
}; };
group = mkOption { group = mkOption {
@ -68,7 +68,7 @@ in
dataDir = mkOption { dataDir = mkOption {
type = types.path; type = types.path;
example = "/var/lib/mysql"; example = "/var/lib/mysql";
description = "Location where MySQL stores its table files"; description = "Location where MySQL stores its table files.";
}; };
configFile = mkOption { configFile = mkOption {
@ -175,7 +175,7 @@ in
initialScript = mkOption { initialScript = mkOption {
type = types.nullOr types.path; type = types.nullOr types.path;
default = null; default = null;
description = "A file containing SQL statements to be executed on the first startup. Can be used for granting certain permissions on the database"; description = "A file containing SQL statements to be executed on the first startup. Can be used for granting certain permissions on the database.";
}; };
ensureDatabases = mkOption { ensureDatabases = mkOption {
@ -263,33 +263,33 @@ in
serverId = mkOption { serverId = mkOption {
type = types.int; type = types.int;
default = 1; default = 1;
description = "Id of the MySQL server instance. This number must be unique for each instance"; description = "Id of the MySQL server instance. This number must be unique for each instance.";
}; };
masterHost = mkOption { masterHost = mkOption {
type = types.str; type = types.str;
description = "Hostname of the MySQL master server"; description = "Hostname of the MySQL master server.";
}; };
slaveHost = mkOption { slaveHost = mkOption {
type = types.str; type = types.str;
description = "Hostname of the MySQL slave server"; description = "Hostname of the MySQL slave server.";
}; };
masterUser = mkOption { masterUser = mkOption {
type = types.str; type = types.str;
description = "Username of the MySQL replication user"; description = "Username of the MySQL replication user.";
}; };
masterPassword = mkOption { masterPassword = mkOption {
type = types.str; type = types.str;
description = "Password of the MySQL replication user"; description = "Password of the MySQL replication user.";
}; };
masterPort = mkOption { masterPort = mkOption {
type = types.int; type = types.int;
default = 3306; default = 3306;
description = "Port number on which the MySQL master server runs"; description = "Port number on which the MySQL master server runs.";
}; };
}; };
}; };