summaryrefslogtreecommitdiffstats
path: root/nixos
diff options
context:
space:
mode:
authorChristian Kögler <ck3d@gmx.de>2022-10-01 09:10:30 +0200
committerGitHub <noreply@github.com>2022-10-01 09:10:30 +0200
commitd3fc91e579dadbf4a3ad30308b27dfd1b05c0282 (patch)
tree8ff674ed14763e62585074827e5b6e70cf6811ab /nixos
parentd4572a24bc215d445ab05e83014ae23c82266b1c (diff)
parent12d64e041b4f97e936a560fe624695a57d8338f3 (diff)
Merge pull request #191352 from maifel-maifel/mr-networking-deprecation-note
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 6a5d7c6b0410..3f6fa3c86402 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 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);
};