summaryrefslogtreecommitdiffstats
path: root/nixos
diff options
context:
space:
mode:
authordigital <git-voopaipa@dinid.net>2022-09-15 18:07:24 +0200
committerdigital <git-voopaipa@dinid.net>2022-09-15 18:07:24 +0200
commit12d64e041b4f97e936a560fe624695a57d8338f3 (patch)
treece7ea1ac55635a21a8108d8d17194cc1b113adfd /nixos
parent1637945189070199494480264357738cc946c70c (diff)
nixos/networking: add a suggestion to use networkd options
Diffstat (limited to 'nixos')
-rw-r--r--nixos/modules/services/networking/wireguard.nix16
-rw-r--r--nixos/modules/tasks/network-interfaces.nix4
2 files changed, 18 insertions, 2 deletions
diff --git a/nixos/modules/services/networking/wireguard.nix b/nixos/modules/services/networking/wireguard.nix
index 23b3008f02d0..14145cec25ed 100644
--- a/nixos/modules/services/networking/wireguard.nix
+++ b/nixos/modules/services/networking/wireguard.nix
@@ -436,7 +436,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 != {};
@@ -445,7 +451,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 e2a17c246bd9..6f01917bcc59 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);
};