lib: Discourage use of extend (#376033)

This commit is contained in:
Robert Hensing
2025-02-09 21:04:55 +01:00
committed by GitHub
3 changed files with 45 additions and 2 deletions

View File

@@ -5,9 +5,41 @@
*/
let
inherit (import ./fixed-points.nix { inherit lib; }) makeExtensible;
# A copy of `lib.makeExtensible'` in order to document `extend`.
# It has been leading to some trouble, so we have to document it specially.
makeExtensible' =
rattrs:
let self = rattrs self // {
/**
Patch the Nixpkgs library
lib = makeExtensible (self: let
A function that applies patches onto the nixpkgs library.
Usage is discouraged for most scenarios.
:::{.note}
The name `extends` is a bit misleading, as it doesn't actually extend the library, but rather patches it.
It is merely a consequence of being implemented by `makeExtensible`.
:::
# Inputs
- An "extension function" `f` that returns attributes that will be updated in the returned Nixpkgs library.
# Output
A patched Nixpkgs library.
:::{.warning}
This functionality is intended as an escape hatch for when the provided version of the Nixpkgs library has a flaw.
If you were to use it to add new functionality, you will run into compatibility and interoperability issues.
:::
*/
extend = f: lib.makeExtensible (lib.extends f rattrs);
};
in self;
lib = makeExtensible' (self: let
callLibs = file: import file { lib = self; };
in {