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

doc: clarify building-nixos CD/DVD instructions #26341

Closed
wants to merge 1 commit into from

Conversation

emmanuelrosa
Copy link
Contributor

This change updates the instructions for building a NixOS ISO so that it's clear how to do it.

Previously, the instructions stated to set NIXOS_CONFIG prior to running nix-build, yet the example provided by-passed NIXOS_CONFIG anyway. But the really important missing piece is the need for nixos/default.nix. See #21840.

This change removes the NIXOS_CONFIG verbiage, and adds steps to clone nixpkgs and (most importantly) cd'ing into nixpkgs/nixos. That way, the reader may think: Oh, so I need a default.nix and a configuration.nix. Ahhh, OK.

I purposely added the redundant default.nix argument.

Motivation for this change
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 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.

This change updates the instructions for building a NixOS ISO so that it's clear how to do it.

Previously, the instructions stated to set NIXOS_CONFIG prior to running `nix-build`, yet the example provided by-passed NIXOS_CONFIG anyway. But the *really* important missing piece is the need for nixos/default.nix. See NixOS#21840.

This change removes the NIXOS_CONFIG verbiage, and adds steps to clone nixpkgs and (most importantly) cd'ing into nixpkgs/nixos. That way, the reader may think: *Oh, so I need a default.nix and a configuration.nix. Ahhh, OK.*

I purposely added the redundant default.nix argument.
@mention-bot
Copy link

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

@grahamc
Copy link
Member

grahamc commented Jun 3, 2017

This looks great, thank you so much! I think it makes sense to use the more common -I method of specifying the config in the docs, despite both methods working correctly.

  • great commit message, thank you for reading the CONTRIBUTING doc so carefully
  • I quite like that you started with cloning the repo, as someone following these instructions are quite likely new users.
  • great job finding and correcting the docs. A lot of people seem to have trouble with docbook, I'm glad you made it through.

Typically contributions start by going to the master branch and then are cherry-picked to the release branch. This time, I've applied your commit to master (4bee34d) and cherry-picked it to the release (f82bbc9). Next time though, please open the PR against master and ask in the issue to have it cherry-picked to stable.

Thank you again for such a wonderful first contribution, I look forward to your second!

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

4 participants