Skip to content

Commit 8356b9d

Browse files
committed
Update change log entry
1 parent 181931b commit 8356b9d

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

changelog.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,28 @@ that will impact users.
33

44
## Sep 16, 2024
55

6-
Haskell.nix now uses the more granular Unit IDs from the plan.json
6+
Cabal projects now use the more granular Unit IDs from plan.json
77
to identify packages. This allows for different versions of a
8-
package to be used when building `built-tool-depend` and setup
8+
package to be used when building `built-tool-depends` and setup
99
dependencies.
1010

1111
Overrides in the `modules` argument apply to all versions of
1212
the package. However to make this work we needed to make
13-
each `packages.somepackage` an option (instead of using the
14-
`attrsOf` option try).
13+
each `packages.somepackage` an option (instead of using an
14+
`attrsOf` the submodule type).
1515

1616
It is now an error to override a package that is not in the
17-
plan. This can be a problem if you use the same overrides
18-
for multiple plans (different GHC versions, target platforms,
19-
or cabal flag settings). If the package does not exist in
20-
some of the variants you use `package-keys` to tell include
21-
the option anyway:
17+
plan. This can be a problem if different GHC versions, target
18+
platforms, or cabal flag settings cause the package to be
19+
excluded from the plan. Adding `package-keys` can tell
20+
haskell.nix to include the option anyway:
2221

2322
```
2423
modules = [{
2524
# Tell haskell.nix that `somepackage` may exist.
2625
package-keys = ["somepackage"];
26+
# Now the following will not cause an error even
27+
# if `somepackage` is not in the plan
2728
packages.somepackage.flags.someflag = true;
2829
}];
2930
```
@@ -37,10 +38,10 @@ for all of the `builtins.attrNames` of `packages`:
3738
})];
3839
```
3940

40-
Do not use the modules `pkgs` arg to look `addPackageKeys` up
41+
Do not use the module's `pkgs` arg to look `addPackageKeys` up
4142
though or it will result an `infinite recursion` error.
4243

43-
Code that uses `options.packages` will also need to be update.
44+
Code that uses `options.packages` will also need to be updated.
4445
For instance the following code that uses `options.packages`
4546
to set `--Werror` for local packages:
4647

0 commit comments

Comments
 (0)