-
-
Notifications
You must be signed in to change notification settings - Fork 14.2k
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/stdenv/meta.chapter.md: explain difference between broken and badPlatforms #225272
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please amend all your subsequent commits in the first.
…Platforms There has been a longstanding ambiguity between `broken` and `badPlatforms`, which seem to serve overlapping purposes. This commit adds to the documentation two examples of constraints which cannot be expressed by `platforms` and `badPlatforms`. This commit also mentions `NIXPKGS_ALLOW_BROKEN=1` for overriding `broken`.
Done. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, yet again great stuff. Also makes me a bit sad that conventions seem to be all over the place – but that's one point of improved documentation: making such warts more visible and thus easier to address. Related: #140325
This issue has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/tweag-nix-dev-update-47/27387/1 |
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
The commits in this PR don't follow the commit format in https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md |
|
Neither of these applies to documentation updates (except for a few cases where the commit updates the documentation about a specific package or module). Based on reviewing the commit history, most people seem to be using
so I followed that convention. Do you have a different recommendation? |
This PR should have been merge as one commit, not four. These are not acceptable commit messages. Update doc/stdenv/meta.chapter.md |
@zowoq, a more helpful comment would have been "please remember to squash before merging". |
It is easier for everyone if the PR is rebased and kept in a mergable state as people forget to squash. Also sometimes squash should be avoided anyway:
|
Description of changes
There has been a longstanding ambiguity between
broken
andbadPlatforms
, which seem to serve overlapping purposes.This commit adds to the documentation two examples of constraints which cannot be expressed by
platforms
andbadPlatforms
.This commit also mentions
NIXPKGS_ALLOW_BROKEN=1
for overridingbroken
.Things done