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

haskell: add comment to default-package-overrides in configuration-hackage2nix.yaml #76912

Conversation

cdepillabout
Copy link
Member

Motivation for this change

This PR adds a comment explaining the default-package-overrides section in configuration-hackge2nix.yaml.

Occasionally we get PRs trying to add packages to this list that don't come from the Stackage LTS releases, so I think it is nice to have some documentation saying not to do this.

Ping @peti.

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.
Notify maintainers

cc @

@cdepillabout cdepillabout requested a review from peti January 4, 2020 01:11
@peti peti merged this pull request into NixOS:haskell-updates Jan 5, 2020
@cdepillabout cdepillabout deleted the add-comment-on-default-package-overrides branch January 6, 2020 00:31
@cdepillabout
Copy link
Member Author

cdepillabout commented Jan 6, 2020

@peti Thanks for cleaning this up and merging it in.

I saw your additional commit in 3ab6627, and your message about this here: #76883 (comment).

I'm wondering if you had any policies in mind for when we allow/disallow things to be added default-package-overrides?

For instance, #76883 is a problem because it appears that a newer version of gi-gdkx11 causes taffybar to fail to build. I think taffybar is used by a non-trivial number of users, so ideally we should try to keep it working. (The same way we try to keep things like cabal-install, stack, xmonad, etc working.)

#76883 could be solved by adding gi-gdkx11 to default-package-overrides. Or, it could be solved by adding gi-gdkx11 to extra-packages, getting hackage2nix to generate gi-gdkx11_3_0_9, and overriding all the derivations that need it (like taffybar).

Do you have a preference for how to handle these types of problems?

@cdepillabout
Copy link
Member Author

ping @peti. I'd like to come up with a loose set policies for when we allow/disallow things to be added to default-package-overrides.

Although for now I'd be completely happy with that policy being "take it on a case-by-case basis".

@peti
Copy link
Member

peti commented Jan 12, 2020

I believe that we'll have to judge it case by case. Personally, I would add overrides to default-package-overrides if the change fixes many packages and breaks only few. :-)

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

2 participants