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: correct improper uses of mkEnableOption, clarify service descr… #47902

Merged
merged 1 commit into from Oct 11, 2018

Conversation

pvgoran
Copy link
Contributor

@pvgoran pvgoran commented Oct 5, 2018

…iptions

Motivation for this change

Several service definitions used mkEnableOption with text starting with "Whether to", which produced funny option descriptions like "Whether to enable Whether to run the rspamd daemon..".

This commit corrects this, and adds short descriptions of services to affected service definitions.

I didn't test this change at all, but since it's trivial one-line documentation changes, I figured this won't be required.

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 nox --run "nox-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)
  • Fits CONTRIBUTING.md.

…iptions

Several service definitions used `mkEnableOption` with text starting
with "Whether to", which produced funny option descriptions like
"Whether to enable Whether to run the rspamd daemon..".

This commit corrects this, and adds short descriptions of services
to affected service definitions.
@pvgoran
Copy link
Contributor Author

pvgoran commented Oct 5, 2018

One thing that I'm not sure about is the description for services.krb5. It's not a "real" service, so I don't know a standard way of describing it.

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.

None yet

5 participants