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.composeExtensions: unify the api to use overlays #333389

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

hsjobeki
Copy link
Contributor

@hsjobeki hsjobeki commented Aug 9, 2024

Description of changes

This PR tries to unify the API to use and apply overlays.

composeExtensions a b is equivalent to:
composeManyExtensions [a b]

But composeManyExtensions is more generic since it can be extended composeManyExtensions [a b ...]

Due to lacking documentation and inherent API for overlays some package set maintainers re-implemented composeManyExtensions as:

lib.foldr  (composeExtensions [ ... ] (final: prev: {});

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 24.11 Release Notes (or backporting 23.11 and 24.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

Add a 👍 reaction to pull requests you find important.

@@ -16,7 +16,7 @@ let

py = python3.override {
self = py;
packageOverrides = lib.foldr lib.composeExtensions (self: super: { }) ([
Copy link
Contributor Author

@hsjobeki hsjobeki Aug 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

example for an identical re-implementation of composeManyExtensions

-> lib.foldr lib.composeExtensions (self: super: { }) ([ ...])

Is literally the same as composeManyExtensions (minus the lambda reduction).

composeManyExtensions = overlays: lib.foldr (x: y: composeExtensions x y) (final: prev: {}) overlays;

@hsjobeki hsjobeki force-pushed the lib-composeExtensions/refactor-api-surface branch from 7c20e82 to 7dfbdaa Compare August 9, 2024 11:23
@hsjobeki
Copy link
Contributor Author

hsjobeki commented Aug 9, 2024

cc @roberth This is what i proposed in #325479.
If we have to maintain duplicate documentation, this is because we have two api functions that do the same thing basically. (or one is a strict superset of the other)

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.

2 participants