Incorrect documentation for networking.wireless.iwd.settings option

[mfsch]

Describe the bug

From what I understand, the documentation of the new networking.wireless.iwd.settings option is not quite correct.

The linked wiki page describes configuration options for individual networks in /var/lib/iwd/* while the derivation creates /etc/iwd/main.conf. I don’t think there’s a wiki page for those options, but they are described on a man page.

In the provided examples, I think the AutoConnect option only applies to individual networks and doesn’t do anything in main.conf.

Notify maintainers

@mic92 @dtzWill

[Lord-Valen]

First, I don't see how this is a NixOS issue, it is an upstream documentation issue. It is also not a bug (it's probably better labelled as an enhancement). Now, main.conf does not have its own page, but is referenced in the wiki when relevant settings are mentioned. You are correct, AutoConnect applies to individual networks (if it isn't in that man page, it isn't a main.conf option). We set AutoConnect in /var/lib/iwd/<SSID>. The files generated by iwctl have different suffixes: .psk, .open, and probably a few more. Normally, those files' numeric permissions = 600 and are owned by root. As root, you can customize and add files there, using the settings on the wiki page. Something to note, as they don't mention it in the wiki, default values are in bold.

[mfsch]

Maybe my explanation was not very clear, but I’m talking about the documentation strings in iwd.nix, which do not make it clear that networking.wireless.iwd.settings is written to main.conf, link to “supported options” that do not belong in main.conf, and provide an example that (afaik) has no effect in main.conf. So I do think this should be categorized as an issue with the NixOS documentation.

[stale[bot]]

I marked this as stale due to inactivity. → More info