Skip to content

Commit

Permalink
doc/by-name: explain better callPackage and xWithY=x.override tra…
Browse files Browse the repository at this point in the history
…nsition
  • Loading branch information
doronbehar committed Sep 17, 2024
1 parent 4f179ad commit 9602327
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion pkgs/by-name/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

However, definitions like the following, can be transitioned:

```
# 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:
Expand Down

0 comments on commit 9602327

Please sign in to comment.