JakeHillion/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc/by-name: explain better callPackage and xWithY=x.override transition

Browse Source
This commit is contained in:
Doron Behar 2024-09-17 22:28:33 +03:00
parent 3a0d864123
commit 52b55691c1
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
pkgs/by-name/README.md
View File

@ -90,11 +90,29 @@ if package maintainers would like to use this feature, they are welcome to migra
To lessen PR traffic, they're encouraged to also perform some more general maintenance on the package in the same PR,
though this is not required and must not be expected.
Note that definitions in `all-packages.nix` with custom arguments should not be removed.
Note that `callPackage` definitions in `all-packages.nix` with custom arguments should not be removed.
That is a backwards-incompatible change because it changes the `.override` interface.
Such packages may still be moved to `pkgs/by-name` however, in order to avoid the slightly superficial choice of directory / category in which the `default.nix` file was placed, but please keep the definition in `all-packages.nix` using `callPackage`.
See also [changing implicit attribute defaults](#changing-implicit-attribute-defaults).
Definitions like the following however, _can_ be transitioned:
```nix
# all-packages.nix
fooWithBaz = foo.override {
bar = baz;
};
# turned into pkgs/by-name/fo/fooWithBaz/package.nix with:
{
foo,
baz,
}:
foo.override {
bar = baz;
}
```
## Limitations
There's some limitations as to which packages can be defined using this structure: