nixos: remove all uses of lib.mdDoc

these changes were generated with nixq 0.0.2, by running

  nixq ">> lib.mdDoc[remove] Argument[keep]" --batchmode nixos/**.nix
  nixq ">> mdDoc[remove] Argument[keep]" --batchmode nixos/**.nix
  nixq ">> Inherit >> mdDoc[remove]" --batchmode nixos/**.nix

two mentions of the mdDoc function remain in nixos/, both of which
are inside of comments.

Since lib.mdDoc is already defined as just id, this commit is a no-op as
far as Nix (and the built manual) is concerned.
This commit is contained in:
stuebinm 2024-04-13 14:54:15 +02:00 committed by Jonathan Ringer
parent 1dd996e59a
commit 6afb255d97
1701 changed files with 13694 additions and 13865 deletions

View file

@ -34,12 +34,12 @@ in
services.mysql = {
enable = mkEnableOption (lib.mdDoc "MySQL server");
enable = mkEnableOption "MySQL server";
package = mkOption {
type = types.package;
example = literalExpression "pkgs.mariadb";
description = lib.mdDoc ''
description = ''
Which MySQL derivation to use. MariaDB packages are supported too.
'';
};
@ -47,7 +47,7 @@ in
user = mkOption {
type = types.str;
default = "mysql";
description = lib.mdDoc ''
description = ''
User account under which MySQL runs.
::: {.note}
@ -61,7 +61,7 @@ in
group = mkOption {
type = types.str;
default = "mysql";
description = lib.mdDoc ''
description = ''
Group account under which MySQL runs.
::: {.note}
@ -75,7 +75,7 @@ in
dataDir = mkOption {
type = types.path;
example = "/var/lib/mysql";
description = lib.mdDoc ''
description = ''
The data directory for MySQL.
::: {.note}
@ -91,7 +91,7 @@ in
defaultText = ''
A configuration file automatically generated by NixOS.
'';
description = lib.mdDoc ''
description = ''
Override the configuration file used by MySQL. By default,
NixOS generates one automatically from {option}`services.mysql.settings`.
'';
@ -110,7 +110,7 @@ in
settings = mkOption {
type = format.type;
default = {};
description = lib.mdDoc ''
description = ''
MySQL configuration. Refer to
<https://dev.mysql.com/doc/refman/5.7/en/server-system-variables.html>,
<https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html>,
@ -144,14 +144,14 @@ in
options = {
name = mkOption {
type = types.str;
description = lib.mdDoc ''
description = ''
The name of the database to create.
'';
};
schema = mkOption {
type = types.nullOr types.path;
default = null;
description = lib.mdDoc ''
description = ''
The initial schema of the database; if null (the default),
an empty database is created.
'';
@ -159,7 +159,7 @@ in
};
});
default = [];
description = lib.mdDoc ''
description = ''
List of database names and their initial schemas that should be used to create databases on the first startup
of MySQL. The schema attribute is optional: If not specified, an empty database is created.
'';
@ -174,13 +174,13 @@ in
initialScript = mkOption {
type = types.nullOr types.path;
default = null;
description = lib.mdDoc "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 {
type = types.listOf types.str;
default = [];
description = lib.mdDoc ''
description = ''
Ensures that the specified databases exist.
This option will never delete existing databases, especially not when the value of this
option is changed. This means that databases created once through this option or
@ -197,14 +197,14 @@ in
options = {
name = mkOption {
type = types.str;
description = lib.mdDoc ''
description = ''
Name of the user to ensure.
'';
};
ensurePermissions = mkOption {
type = types.attrsOf types.str;
default = {};
description = lib.mdDoc ''
description = ''
Permissions to ensure for the user, specified as attribute set.
The attribute names specify the database and tables to grant the permissions for,
separated by a dot. You may use wildcards here.
@ -226,7 +226,7 @@ in
};
});
default = [];
description = lib.mdDoc ''
description = ''
Ensures that the specified users exist and have at least the ensured permissions.
The MySQL users will be identified using Unix socket authentication. This authenticates the Unix user with the
same name only, and that without the need for a password.
@ -256,39 +256,39 @@ in
role = mkOption {
type = types.enum [ "master" "slave" "none" ];
default = "none";
description = lib.mdDoc "Role of the MySQL server instance.";
description = "Role of the MySQL server instance.";
};
serverId = mkOption {
type = types.int;
default = 1;
description = lib.mdDoc "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 {
type = types.str;
description = lib.mdDoc "Hostname of the MySQL master server.";
description = "Hostname of the MySQL master server.";
};
slaveHost = mkOption {
type = types.str;
description = lib.mdDoc "Hostname of the MySQL slave server.";
description = "Hostname of the MySQL slave server.";
};
masterUser = mkOption {
type = types.str;
description = lib.mdDoc "Username of the MySQL replication user.";
description = "Username of the MySQL replication user.";
};
masterPassword = mkOption {
type = types.str;
description = lib.mdDoc "Password of the MySQL replication user.";
description = "Password of the MySQL replication user.";
};
masterPort = mkOption {
type = types.port;
default = 3306;
description = lib.mdDoc "Port number on which the MySQL master server runs.";
description = "Port number on which the MySQL master server runs.";
};
};
};