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 Manual: document assertions and warnings #29206

Merged
merged 2 commits into from Sep 11, 2017

Conversation

roberth
Copy link
Member

@roberth roberth commented Sep 10, 2017

Motivation for this change

assertions and warnings in NixOS modules were not documented yet.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option build-use-sandbox in nix.conf on non-NixOS)
  • Built on platform(s)
    • NixOS
    • macOS
    • Linux
  • 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/)
  • Fits CONTRIBUTING.md.

@mention-bot
Copy link

@roberth, thanks for your PR! By analyzing the history of the files in this pull request, we identified @thatdocslady, @copumpkin and @ericsagnes to be potential reviewers.

"Importing <nixpkgs/nixos/modules/programs/virtualbox.nix> is "
+ "deprecated, please use `virtualisation.virtualbox.host.enable = true' "
+ "instead." ];
config.virtualisation.virtualbox.host.enable = true;
Copy link
Member

Choose a reason for hiding this comment

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

Even though this is example is very concise, having the same structure here as below for assertions would be more clearer I think.

Copy link
Member

@fpletz fpletz left a comment

Choose a reason for hiding this comment

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

Thanks a lot! Docs are always very welcome! Looks good to me except the comment.

@fpletz fpletz added this to the 17.09 milestone Sep 10, 2017
@fpletz fpletz added 6.topic: nixos 8.has: documentation 9.needs: port to stable A PR needs a backport to the stable release. labels Sep 10, 2017
@roberth roberth force-pushed the nixos-manual-assertions-warnings branch from 552a924 to 5bb059b Compare September 10, 2017 19:53
@roberth
Copy link
Member Author

roberth commented Sep 10, 2017

Ok, I have simplified the assertion example and I have adapted the warning example to match the assertion example more closely. In doing so, the warning example is not a real world example any more. It turns out that they are not used very often. Most of the warnings seem to be deprecations, moves and such, which are modeled differently.

@Mic92
Copy link
Member

Mic92 commented Sep 11, 2017

Thanks!

@Mic92 Mic92 merged commit 1b1fc65 into NixOS:master Sep 11, 2017
fpletz pushed a commit that referenced this pull request Sep 17, 2017
* NixOS Manual: document assertions and warnings

* NixOS manual: re-wrap assertions text

(cherry picked from commit 1b1fc65)
@samueldr samueldr removed the 9.needs: port to stable A PR needs a backport to the stable release. label Apr 17, 2019
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

6 participants