Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

nixos/doc: Clarify wireless examples #66652

Merged
merged 1 commit into from Sep 27, 2019

Conversation

craigem
Copy link
Contributor

@craigem craigem commented Aug 14, 2019

This commits makes it clearer to a novice reader how to configure several
diferent types of SSID connections that were otherwise obscurely documented

Resolves #66650

Motivation for this change

Clarify wireless documentation

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nix-review --run "nix-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.
Notify maintainers

cc @

Copy link
Contributor

@worldofpeace worldofpeace left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about an example for a hidden network?

Also, should the example in the actual NixOS option be updated?

nixos/doc/manual/configuration/wireless.xml Outdated Show resolved Hide resolved
Copy link
Contributor

@worldofpeace worldofpeace left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we have the example in the manual have the same ap names as the options?

So the hidden example in the option has echelon = while in the manual it's echelonHidden.
Similar with the free.wifi and freeWiFi.

This commits makes it clearer to a novice reader how to configure several
diferent types of SSID connections that were otherwise obscurely documented

Resolves NixOS#66650
@worldofpeace worldofpeace changed the title Clarify wireless examples nixos/doc: Clarify wireless examples Sep 27, 2019
@worldofpeace worldofpeace merged commit 985697b into NixOS:master Sep 27, 2019
@worldofpeace
Copy link
Contributor

Thanks @craigem

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Wireless Documention is Unclear and Ambiguous
2 participants