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.

Sign up for GitHub

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

Jump to bottom

doc: Remove comment advising to install build tooling system-wide #78383

Merged
merged 1 commit into from
Jan 23, 2020
Merged

doc: Remove comment advising to install build tooling system-wide #78383

merged 1 commit into from
Jan 23, 2020

Conversation

adisbladis
Copy link
Member

@adisbladis adisbladis commented Jan 23, 2020 •
edited
Loading

doc: Remove comment advising to install build tooling system-wide

We should not encourage installing build-tooling system-wide but instead promote nix-shell.

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

@grahamc
Copy link
Member

grahamc commented Jan 23, 2020

Side note: Should we really document this kind of advice which is arguably bad?

No.

@adisbladis
Copy link
Member Author

@grahamc Should we just outright the changed bits then?

@ofborg ofborg bot added 8.has: documentation 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 0 This PR does not cause any packages to rebuild on Linux labels Jan 23, 2020
@grahamc
Copy link
Member

grahamc commented Jan 23, 2020

Yep, I think so

@adisbladis
doc: Remove comment advising to install build tooling system-wide
fece3e5 
We should not encourage installing build-tooling system-wide but
instead promote nix-shell.
@adisbladis adisbladis changed the title doc: Remove blockquote from rust section doc: Remove comment advising to install build tooling system-wide Jan 23, 2020
@adisbladis adisbladis merged commit 9127ca2 into NixOS:master Jan 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
8.has: documentation 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 0 This PR does not cause any packages to rebuild on Linux
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@adisbladis @grahamc