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

nixpkgs manual : clearer meta.platforms description #31246

Merged
merged 1 commit into from Nov 4, 2017

Conversation

c0bw3b
Copy link
Contributor

@c0bw3b c0bw3b commented Nov 4, 2017

Motivation for this change

Follow-up to #31217
Refer to doubles.nix for a list of common platforms types usually seen in package definitions

@BlessJah @grahamc

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
    • 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 nox --run "nox-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Fits CONTRIBUTING.md.

@NeQuissimus
Copy link
Member

I am unsure about linking specific lines, the file may change and we'd need to adjust the line numbers then.
On the flipside, double should not require updates very often...

@BlessJah
Copy link
Contributor

BlessJah commented Nov 4, 2017

+1 on removing specific lines. This kind of adjustments tend to be forgotten.

@c0bw3b
Copy link
Contributor Author

c0bw3b commented Nov 4, 2017

Thought about it and considered this particular file isn't going to change too often.
But yes it can be a (minor cosmetic) issue down the road.

I'm not against removing the line anchors.
@grahamc do you have an opinion here?

@grahamc
Copy link
Member

grahamc commented Nov 4, 2017

I'd remove them, it'll become wrong and cause more PRs fixing the lines later on. Meanwhile, people familiar with platform names will (probably) have no trouble finding familiarity at the bottom of the file.

Refer to doubles.nix for a list of common platforms types used in packages
@c0bw3b
Copy link
Contributor Author

c0bw3b commented Nov 4, 2017

Done deal. 🐈

@NeQuissimus NeQuissimus merged commit 9691c3e into NixOS:master Nov 4, 2017
@c0bw3b c0bw3b deleted the doc/meta-platforms branch November 4, 2017 18:48
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

5 participants