Merge pull request #191352 from maifel-maifel/mr-networking-deprecation-note

nixos/networking: add a suggestion to use networkd options
This commit is contained in:
Christian Kögler 2022-10-01 09:10:30 +02:00 committed by GitHub
commit d3fc91e579
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 2 deletions

View File

@ -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 = {

View File

@ -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);
};