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/boot: some documentation improvements #93942

Merged

Conversation

kini
Copy link
Member

@kini kini commented Jul 27, 2020

Motivation for this change
  • Give a more accurate description of how fileSystems.<name?>.neededForBoot works

  • Give a more detailed description of how fileSystems.<name?>.encrypted.keyFile works

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • 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 nixpkgs-review --run "nixpkgs-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.

Sorry, something went wrong.

@ofborg ofborg bot added 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10 10.rebuild-linux: 1 labels Jul 27, 2020
@kini kini requested a review from danbst July 27, 2020 01:05
@kini kini force-pushed the nixos/boot/documentation-improvements branch 2 times, most recently from 17123de to e6502c0 Compare July 27, 2020 03:45
@kini kini requested a review from worldofpeace July 29, 2020 20:36
- Give a more accurate description of how fileSystems.<name/>.neededForBoot
  works

- Give a more detailed description of how fileSystems.<name/>.encrypted.keyFile
  works
@kini kini force-pushed the nixos/boot/documentation-improvements branch from e6502c0 to 5e86bba Compare July 29, 2020 21:39
@worldofpeace worldofpeace merged commit b69c61e into NixOS:master Jul 30, 2020
@kini kini deleted the nixos/boot/documentation-improvements branch July 30, 2020 10:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10 10.rebuild-linux: 1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants