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

lib: add makeOverridableWithName + build*Package overrides #87394

Closed
wants to merge 6 commits into from

Conversation

@B4dM4n
Copy link
Contributor

B4dM4n commented May 9, 2020

Motivation for this change

Improve the extensibility of language specific package builders.

Some of current build*Package functions support more overriding capabilities than others:

  • buildPythonPackage supports overriding packages via makeOverridable and overridePythonAttrs
  • buildLuarocksPackage and buildRubyGem support overriding packages via makeOverridable
  • buildRustPackage and buildPerlPackage supports no overriding

In theory makeOverridable should be enough to make a builder function overridable, but in practice this doesn't always work, because another callPackage might shadow the wanted override function.

buildPythonPackage works around this by providing a overridePythonAttrs function which is essentially a override with a custom name.

Things done

This PR adds a lib.makeOverridableWithName function, which is just lib.makeOverridable with a additional named override function.

It also adjusts the build*Package functions that I'm familiar with to use the new helper.

  • 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.
B4dM4n added 6 commits Apr 28, 2020
@FRidh
Copy link
Member

FRidh commented May 9, 2020

Good initiative! But.... Do we actually need another override option? Maybe we should just ensure the custom builders use .overrideAttrs?

I still need to extend this, but please have a look at the RFC regarding this topic NixOS/rfcs#67. Please also have a look at the links in the PR which may give more context.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.