mirror of
https://github.com/NixOS/nixpkgs.git
synced 2025-07-13 13:40:28 +03:00
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
Jonathan Ringer
parent
1dd996e59a
commit
6afb255d97
1701 changed files with 13694 additions and 13865 deletions
|
|
@ -148,7 +148,7 @@ in
|
|||
enable = mkOption {
|
||||
type = types.bool;
|
||||
default = false;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Whether to enable Keepalived.
|
||||
'';
|
||||
};
|
||||
|
|
@ -156,7 +156,7 @@ in
|
|||
openFirewall = mkOption {
|
||||
type = types.bool;
|
||||
default = false;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Whether to automatically allow VRRP and AH packets in the firewall.
|
||||
'';
|
||||
};
|
||||
|
|
@ -164,7 +164,7 @@ in
|
|||
enableScriptSecurity = mkOption {
|
||||
type = types.bool;
|
||||
default = false;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Don't run scripts configured to be run as root if any part of the path is writable by a non-root user.
|
||||
'';
|
||||
};
|
||||
|
|
@ -174,7 +174,7 @@ in
|
|||
enable = mkOption {
|
||||
type = types.bool;
|
||||
default = false;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Whether to enable the builtin AgentX subagent.
|
||||
'';
|
||||
};
|
||||
|
|
@ -182,7 +182,7 @@ in
|
|||
socket = mkOption {
|
||||
type = types.nullOr types.str;
|
||||
default = null;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Socket to use for connecting to SNMP master agent. If this value is
|
||||
set to null, keepalived's default will be used, which is
|
||||
unix:/var/agentx/master, unless using a network namespace, when the
|
||||
|
|
@ -193,7 +193,7 @@ in
|
|||
enableKeepalived = mkOption {
|
||||
type = types.bool;
|
||||
default = false;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Enable SNMP handling of vrrp element of KEEPALIVED MIB.
|
||||
'';
|
||||
};
|
||||
|
|
@ -201,7 +201,7 @@ in
|
|||
enableChecker = mkOption {
|
||||
type = types.bool;
|
||||
default = false;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Enable SNMP handling of checker element of KEEPALIVED MIB.
|
||||
'';
|
||||
};
|
||||
|
|
@ -209,7 +209,7 @@ in
|
|||
enableRfc = mkOption {
|
||||
type = types.bool;
|
||||
default = false;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Enable SNMP handling of RFC2787 and RFC6527 VRRP MIBs.
|
||||
'';
|
||||
};
|
||||
|
|
@ -217,7 +217,7 @@ in
|
|||
enableRfcV2 = mkOption {
|
||||
type = types.bool;
|
||||
default = false;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Enable SNMP handling of RFC2787 VRRP MIB.
|
||||
'';
|
||||
};
|
||||
|
|
@ -225,7 +225,7 @@ in
|
|||
enableRfcV3 = mkOption {
|
||||
type = types.bool;
|
||||
default = false;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Enable SNMP handling of RFC6527 VRRP MIB.
|
||||
'';
|
||||
};
|
||||
|
|
@ -233,7 +233,7 @@ in
|
|||
enableTraps = mkOption {
|
||||
type = types.bool;
|
||||
default = false;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Enable SNMP traps.
|
||||
'';
|
||||
};
|
||||
|
|
@ -245,7 +245,7 @@ in
|
|||
inherit lib;
|
||||
}));
|
||||
default = {};
|
||||
description = lib.mdDoc "Declarative vrrp script config";
|
||||
description = "Declarative vrrp script config";
|
||||
};
|
||||
|
||||
vrrpInstances = mkOption {
|
||||
|
|
@ -253,13 +253,13 @@ in
|
|||
inherit lib;
|
||||
}));
|
||||
default = {};
|
||||
description = lib.mdDoc "Declarative vhost config";
|
||||
description = "Declarative vhost config";
|
||||
};
|
||||
|
||||
extraGlobalDefs = mkOption {
|
||||
type = types.lines;
|
||||
default = "";
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Extra lines to be added verbatim to the 'global_defs' block of the
|
||||
configuration file
|
||||
'';
|
||||
|
|
@ -268,7 +268,7 @@ in
|
|||
extraConfig = mkOption {
|
||||
type = types.lines;
|
||||
default = "";
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Extra lines to be added verbatim to the configuration file.
|
||||
'';
|
||||
};
|
||||
|
|
@ -277,7 +277,7 @@ in
|
|||
type = types.nullOr types.path;
|
||||
default = null;
|
||||
example = "/run/keys/keepalived.env";
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Environment variables from this file will be interpolated into the
|
||||
final config file using envsubst with this syntax: `$ENVIRONMENT`
|
||||
or `''${VARIABLE}`.
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ with lib;
|
|||
|
||||
addr = mkOption {
|
||||
type = types.str;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
IP address, optionally with a netmask: IPADDR[/MASK]
|
||||
'';
|
||||
};
|
||||
|
|
@ -14,7 +14,7 @@ with lib;
|
|||
brd = mkOption {
|
||||
type = types.nullOr types.str;
|
||||
default = null;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
The broadcast address on the interface.
|
||||
'';
|
||||
};
|
||||
|
|
@ -22,7 +22,7 @@ with lib;
|
|||
dev = mkOption {
|
||||
type = types.nullOr types.str;
|
||||
default = null;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
The name of the device to add the address to.
|
||||
'';
|
||||
};
|
||||
|
|
@ -30,7 +30,7 @@ with lib;
|
|||
scope = mkOption {
|
||||
type = types.nullOr types.str;
|
||||
default = null;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
The scope of the area where this address is valid.
|
||||
'';
|
||||
};
|
||||
|
|
@ -38,7 +38,7 @@ with lib;
|
|||
label = mkOption {
|
||||
type = types.nullOr types.str;
|
||||
default = null;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Each address may be tagged with a label string. In order to preserve
|
||||
compatibility with Linux-2.0 net aliases, this string must coincide with
|
||||
the name of the device or must be prefixed with the device name followed
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ with lib;
|
|||
|
||||
interface = mkOption {
|
||||
type = types.str;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Interface for inside_network, bound by vrrp.
|
||||
'';
|
||||
};
|
||||
|
|
@ -14,7 +14,7 @@ with lib;
|
|||
state = mkOption {
|
||||
type = types.enum [ "MASTER" "BACKUP" ];
|
||||
default = "BACKUP";
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Initial state. As soon as the other machine(s) come up, an election will
|
||||
be held and the machine with the highest "priority" will become MASTER.
|
||||
So the entry here doesn't matter a whole lot.
|
||||
|
|
@ -23,7 +23,7 @@ with lib;
|
|||
|
||||
virtualRouterId = mkOption {
|
||||
type = types.ints.between 1 255;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Arbitrary unique number 1..255. Used to differentiate multiple instances
|
||||
of vrrpd running on the same NIC (and hence same socket).
|
||||
'';
|
||||
|
|
@ -32,7 +32,7 @@ with lib;
|
|||
priority = mkOption {
|
||||
type = types.int;
|
||||
default = 100;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
For electing MASTER, highest priority wins. To be MASTER, make 50 more
|
||||
than other machines.
|
||||
'';
|
||||
|
|
@ -41,7 +41,7 @@ with lib;
|
|||
noPreempt = mkOption {
|
||||
type = types.bool;
|
||||
default = false;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
VRRP will normally preempt a lower priority machine when a higher
|
||||
priority machine comes online. "nopreempt" allows the lower priority
|
||||
machine to maintain the master role, even when a higher priority machine
|
||||
|
|
@ -53,7 +53,7 @@ with lib;
|
|||
useVmac = mkOption {
|
||||
type = types.bool;
|
||||
default = false;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Use VRRP Virtual MAC.
|
||||
'';
|
||||
};
|
||||
|
|
@ -61,7 +61,7 @@ with lib;
|
|||
vmacInterface = mkOption {
|
||||
type = types.nullOr types.str;
|
||||
default = null;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Name of the vmac interface to use. keepalived will come up with a name
|
||||
if you don't specify one.
|
||||
'';
|
||||
|
|
@ -70,7 +70,7 @@ with lib;
|
|||
vmacXmitBase = mkOption {
|
||||
type = types.bool;
|
||||
default = false;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Send/Recv VRRP messages from base interface instead of VMAC interface.
|
||||
'';
|
||||
};
|
||||
|
|
@ -78,7 +78,7 @@ with lib;
|
|||
unicastSrcIp = mkOption {
|
||||
type = types.nullOr types.str;
|
||||
default = null;
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Default IP for binding vrrpd is the primary IP on interface. If you
|
||||
want to hide location of vrrpd, use this IP as src_addr for unicast
|
||||
vrrp packets.
|
||||
|
|
@ -88,7 +88,7 @@ with lib;
|
|||
unicastPeers = mkOption {
|
||||
type = types.listOf types.str;
|
||||
default = [];
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Do not send VRRP adverts over VRRP multicast group. Instead it sends
|
||||
adverts to the following list of ip addresses using unicast design
|
||||
fashion. It can be cool to use VRRP FSM and features in a networking
|
||||
|
|
@ -103,27 +103,27 @@ with lib;
|
|||
}));
|
||||
default = [];
|
||||
# TODO: example
|
||||
description = lib.mdDoc "Declarative vhost config";
|
||||
description = "Declarative vhost config";
|
||||
};
|
||||
|
||||
trackScripts = mkOption {
|
||||
type = types.listOf types.str;
|
||||
default = [];
|
||||
example = [ "chk_cmd1" "chk_cmd2" ];
|
||||
description = lib.mdDoc "List of script names to invoke for health tracking.";
|
||||
description = "List of script names to invoke for health tracking.";
|
||||
};
|
||||
|
||||
trackInterfaces = mkOption {
|
||||
type = types.listOf types.str;
|
||||
default = [];
|
||||
example = [ "eth0" "eth1" ];
|
||||
description = lib.mdDoc "List of network interfaces to monitor for health tracking.";
|
||||
description = "List of network interfaces to monitor for health tracking.";
|
||||
};
|
||||
|
||||
extraConfig = mkOption {
|
||||
type = types.lines;
|
||||
default = "";
|
||||
description = lib.mdDoc ''
|
||||
description = ''
|
||||
Extra lines to be added verbatim to the vrrp_instance section.
|
||||
'';
|
||||
};
|
||||
|
|
|
|||
|
|
@ -8,55 +8,55 @@ with lib.types;
|
|||
script = mkOption {
|
||||
type = str;
|
||||
example = literalExpression ''"''${pkgs.curl} -f http://localhost:80"'';
|
||||
description = lib.mdDoc "(Path of) Script command to execute followed by args, i.e. cmd [args]...";
|
||||
description = "(Path of) Script command to execute followed by args, i.e. cmd [args]...";
|
||||
};
|
||||
|
||||
interval = mkOption {
|
||||
type = int;
|
||||
default = 1;
|
||||
description = lib.mdDoc "Seconds between script invocations.";
|
||||
description = "Seconds between script invocations.";
|
||||
};
|
||||
|
||||
timeout = mkOption {
|
||||
type = int;
|
||||
default = 5;
|
||||
description = lib.mdDoc "Seconds after which script is considered to have failed.";
|
||||
description = "Seconds after which script is considered to have failed.";
|
||||
};
|
||||
|
||||
weight = mkOption {
|
||||
type = int;
|
||||
default = 0;
|
||||
description = lib.mdDoc "Following a failure, adjust the priority by this weight.";
|
||||
description = "Following a failure, adjust the priority by this weight.";
|
||||
};
|
||||
|
||||
rise = mkOption {
|
||||
type = int;
|
||||
default = 5;
|
||||
description = lib.mdDoc "Required number of successes for OK transition.";
|
||||
description = "Required number of successes for OK transition.";
|
||||
};
|
||||
|
||||
fall = mkOption {
|
||||
type = int;
|
||||
default = 3;
|
||||
description = lib.mdDoc "Required number of failures for KO transition.";
|
||||
description = "Required number of failures for KO transition.";
|
||||
};
|
||||
|
||||
user = mkOption {
|
||||
type = str;
|
||||
default = "keepalived_script";
|
||||
description = lib.mdDoc "Name of user to run the script under.";
|
||||
description = "Name of user to run the script under.";
|
||||
};
|
||||
|
||||
group = mkOption {
|
||||
type = nullOr str;
|
||||
default = null;
|
||||
description = lib.mdDoc "Name of group to run the script under. Defaults to user group.";
|
||||
description = "Name of group to run the script under. Defaults to user group.";
|
||||
};
|
||||
|
||||
extraConfig = mkOption {
|
||||
type = lines;
|
||||
default = "";
|
||||
description = lib.mdDoc "Extra lines to be added verbatim to the vrrp_script section.";
|
||||
description = "Extra lines to be added verbatim to the vrrp_script section.";
|
||||
};
|
||||
|
||||
};
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue