docs(nixos): clarify VLAN option descriptions

This commit is contained in:
2026-10-07 21:26:32 -04:00
parent 61aa476ae8
commit 3c80edd3c2

View File

@@ -4,7 +4,7 @@
util, util,
... ...
}: }:
# Configures bridges for tagged VLANs on a DHCP-managed physical interface. # Configures bridges for tagged VLANs on a physical interface that uses DHCP.
let let
cfg = config.modules.network.vlans; # NOLINT(let_order) cfg = config.modules.network.vlans; # NOLINT(let_order)
vlanName = id: "vlan${toString id}"; vlanName = id: "vlan${toString id}";
@@ -15,7 +15,7 @@ in
type = lib.types.str; type = lib.types.str;
example = "enp1s0"; example = "enp1s0";
description = '' description = ''
Physical interface that carries untagged DHCP traffic and tagged VLANs. Names the physical interface that carries untagged DHCP traffic and tagged VLANs.
''; '';
}; };
@@ -28,7 +28,8 @@ in
30 30
]; ];
description = '' description = ''
Materializes bridges for these tagged VLAN IDs. Creates bridges for the specified tagged VLAN IDs.
VLAN ID N creates bridge `br-vlanN`. VLAN ID N creates bridge `br-vlanN`.
''; '';
}; };