movefasta/nixpkgs
0
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-07-13 21:50:33 +03:00
Code Activity

nixos: remove all uses of lib.mdDoc

Browse source 
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
Download patch file Download diff file Expand all files Collapse all files

58
nixos/modules/services/databases/redis.nix
View file

@ -56,22 +56,22 @@ in {
services.redis = {
package = mkPackageOption pkgs "redis" { };
vmOverCommit = mkEnableOption (lib.mdDoc ''
vmOverCommit = mkEnableOption ''
setting of vm.overcommit_memory to 1
(Suggested for Background Saving: <https://redis.io/docs/get-started/faq/>)
'');
'';
servers = mkOption {
type = with types; attrsOf (submodule ({ config, name, ... }: {
options = {
enable = mkEnableOption (lib.mdDoc ''
enable = mkEnableOption ''
Redis server.
Note that the NixOS module for Redis disables kernel support
for Transparent Huge Pages (THP),
because this features causes major performance problems for Redis,
e.g. (https://redis.io/topics/latency)
'');
'';
user = mkOption {
type = types.str;
@ -79,14 +79,14 @@ in {
defaultText = literalExpression ''
if name == "" then "redis" else "redis-''${name}"
'';
description = lib.mdDoc "The username and groupname for redis-server.";
description = "The username and groupname for redis-server.";
};
port = mkOption {
type = types.port;
default = if name == "" then 6379 else 0;
defaultText = literalExpression ''if name == "" then 6379 else 0'';
description = lib.mdDoc ''
description = ''
The TCP port to accept connections.
If port 0 is specified Redis will not listen on a TCP socket.
'';
@ -95,7 +95,7 @@ in {
openFirewall = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether to open ports in the firewall for the server.
'';
};
@ -103,14 +103,14 @@ in {
extraParams = mkOption {
type = with types; listOf str;
default = [];
description = lib.mdDoc "Extra parameters to append to redis-server invocation";
description = "Extra parameters to append to redis-server invocation";
example = [ "--sentinel" ];
};
bind = mkOption {
type = with types; nullOr str;
default = "127.0.0.1";
description = lib.mdDoc ''
description = ''
The IP interface to bind to.
`null` means "all interfaces".
'';
@ -123,13 +123,13 @@ in {
defaultText = literalExpression ''
if name == "" then "/run/redis/redis.sock" else "/run/redis-''${name}/redis.sock"
'';
description = lib.mdDoc "The path to the socket to bind to.";
description = "The path to the socket to bind to.";
};
unixSocketPerm = mkOption {
type = types.int;
default = 660;
description = lib.mdDoc "Change permissions for the socket";
description = "Change permissions for the socket";
example = 600;
};
@ -137,38 +137,38 @@ in {
type = types.str;
default = "notice"; # debug, verbose, notice, warning
example = "debug";
description = lib.mdDoc "Specify the server verbosity level, options: debug, verbose, notice, warning.";
description = "Specify the server verbosity level, options: debug, verbose, notice, warning.";
};
logfile = mkOption {
type = types.str;
default = "/dev/null";
description = lib.mdDoc "Specify the log file name. Also 'stdout' can be used to force Redis to log on the standard output.";
description = "Specify the log file name. Also 'stdout' can be used to force Redis to log on the standard output.";
example = "/var/log/redis.log";
};
syslog = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc "Enable logging to the system logger.";
description = "Enable logging to the system logger.";
};
databases = mkOption {
type = types.int;
default = 16;
description = lib.mdDoc "Set the number of databases.";
description = "Set the number of databases.";
};
maxclients = mkOption {
type = types.int;
default = 10000;
description = lib.mdDoc "Set the max number of connected clients at the same time.";
description = "Set the max number of connected clients at the same time.";
};
save = mkOption {
type = with types; listOf (listOf int);
default = [ [900 1] [300 10] [60 10000] ];
description = mdDoc ''
description = ''
The schedule in which data is persisted to disk, represented as a list of lists where the first element represent the amount of seconds and the second the number of changes.
If set to the empty list (`[]`) then RDB persistence will be disabled (useful if you are using AOF or don't want any persistence).
@ -180,27 +180,27 @@ in {
options = {
ip = mkOption {
type = str;
description = lib.mdDoc "IP of the Redis master";
description = "IP of the Redis master";
example = "192.168.1.100";
};
port = mkOption {
type = port;
description = lib.mdDoc "port of the Redis master";
description = "port of the Redis master";
default = 6379;
};
};
}));
default = null;
description = lib.mdDoc "IP and port to which this redis instance acts as a slave.";
description = "IP and port to which this redis instance acts as a slave.";
example = { ip = "192.168.1.100"; port = 6379; };
};
masterAuth = mkOption {
type = with types; nullOr str;
default = null;
description = lib.mdDoc ''If the master is password protected (using the requirePass configuration)
description = ''If the master is password protected (using the requirePass configuration)
it is possible to tell the slave to authenticate before starting the replication synchronization
process, otherwise the master will refuse the slave request.
(STORED PLAIN TEXT, WORLD-READABLE IN NIX STORE)'';
@ -209,7 +209,7 @@ in {
requirePass = mkOption {
type = with types; nullOr str;
default = null;
description = lib.mdDoc ''
description = ''
Password for database (STORED PLAIN TEXT, WORLD-READABLE IN NIX STORE).
Use requirePassFile to store it outside of the nix store in a dedicated file.
'';
@ -219,40 +219,40 @@ in {
requirePassFile = mkOption {
type = with types; nullOr path;
default = null;
description = lib.mdDoc "File with password for the database.";
description = "File with password for the database.";
example = "/run/keys/redis-password";
};
appendOnly = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc "By default data is only periodically persisted to disk, enable this option to use an append-only file for improved persistence.";
description = "By default data is only periodically persisted to disk, enable this option to use an append-only file for improved persistence.";
};
appendFsync = mkOption {
type = types.str;
default = "everysec"; # no, always, everysec
description = lib.mdDoc "How often to fsync the append-only log, options: no, always, everysec.";
description = "How often to fsync the append-only log, options: no, always, everysec.";
};
slowLogLogSlowerThan = mkOption {
type = types.int;
default = 10000;
description = lib.mdDoc "Log queries whose execution take longer than X in milliseconds.";
description = "Log queries whose execution take longer than X in milliseconds.";
example = 1000;
};
slowLogMaxLen = mkOption {
type = types.int;
default = 128;
description = lib.mdDoc "Maximum number of items to keep in slow log.";
description = "Maximum number of items to keep in slow log.";
};
settings = mkOption {
# TODO: this should be converted to freeformType
type = with types; attrsOf (oneOf [ bool int str (listOf str) ]);
default = {};
description = lib.mdDoc ''
description = ''
Redis configuration. Refer to
<https://redis.io/topics/config>
for details on supported values.
@ -292,7 +292,7 @@ in {
(mkIf (config.requirePass != null) { requirepass = config.requirePass; })
];
}));
description = lib.mdDoc "Configuration of multiple `redis-server` instances.";
description = "Configuration of multiple `redis-server` instances.";
default = {};
};
};