diff options
Diffstat (limited to 'nixos')
-rw-r--r-- | nixos/modules/services/networking/wireguard.nix | 16 | ||||
-rw-r--r-- | nixos/modules/tasks/network-interfaces.nix | 4 |
2 files changed, 18 insertions, 2 deletions
diff --git a/nixos/modules/services/networking/wireguard.nix b/nixos/modules/services/networking/wireguard.nix index 6a5d7c6b04103..3f6fa3c864026 100644 --- a/nixos/modules/services/networking/wireguard.nix +++ b/nixos/modules/services/networking/wireguard.nix @@ -465,7 +465,13 @@ in networking.wireguard = { enable = mkOption { - description = lib.mdDoc "Whether to enable WireGuard."; + description = lib.mdDoc '' + Whether to enable WireGuard. + + Please note that {option}`systemd.network.netdevs` has more features + and is better maintained. When building new things, it is advised to + use that instead. + ''; type = types.bool; # 2019-05-25: Backwards compatibility. default = cfg.interfaces != {}; @@ -474,7 +480,13 @@ in }; interfaces = mkOption { - description = lib.mdDoc "WireGuard interfaces."; + description = lib.mdDoc '' + WireGuard interfaces. + + Please note that {option}`systemd.network.netdevs` has more features + and is better maintained. When building new things, it is advised to + use that instead. + ''; default = {}; example = { wg0 = { diff --git a/nixos/modules/tasks/network-interfaces.nix b/nixos/modules/tasks/network-interfaces.nix index e2a17c246bd94..6f01917bcc59f 100644 --- a/nixos/modules/tasks/network-interfaces.nix +++ b/nixos/modules/tasks/network-interfaces.nix @@ -604,6 +604,10 @@ in The configuration for each network interface. If {option}`networking.useDHCP` is true, then every interface not listed here will be configured using DHCP. + + Please note that {option}`systemd.network.netdevs` has more features + and is better maintained. When building new things, it is advised to + use that instead. ''; type = with types; attrsOf (submodule interfaceOpts); }; |