Skip to content

Commit d498460

Browse files
authored
Update docs (#107)
1 parent 515c88e commit d498460

File tree

3 files changed

+17
-10
lines changed

3 files changed

+17
-10
lines changed

changelog.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Mar 15, 2019
2+
* overlays was renamed to extras (#79)
3+
See docs/migration.md

docs/iohk-nix.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -52,14 +52,6 @@ let
5252
# our packages
5353
stack-pkgs = import ./.stack-pkgs.nix;
5454
55-
# packages which will require TH and thus
56-
# will need -fexternal-interpreter treatment
57-
# when cross compiling.
58-
th-packages = [
59-
"hedgehog" "cardano-crypto-wrapper"
60-
"cardano-crypto-test" "cardano-chain"
61-
"small-steps" "cs-ledger" ];
62-
6355
# Build the packageset with module support.
6456
# We can essentially override anything in the modules
6557
# section.
@@ -93,8 +85,7 @@ let
9385
# work when cross compiling. For now we need to
9486
# list the packages that require template haskell
9587
# explicity here.
96-
(iohk-module { nixpkgs = pkgs;
97-
inherit th-packages; })
88+
iohk-module
9889
];
9990
};
10091
in

docs/migrations.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# `overlay` to `extras`
2+
3+
`overlay` was renamed to `extras` in #79 to prevent confusion between the notion of nix overlays.
4+
Therefore `plan-pkgs` and `stack-pkgs` as generated by `plan-to-nix` and `stack-to-nix` will
5+
expose `extras` instead of `overlay`. Similarly `mkStackPkgSet`, `mkPkgSet` and `mkCabalProjectPkgSet`
6+
take a `pkg-def-extras` instead of `pkg-def-overlay` argument. If you are using `iohk-nix`, the
7+
`iohk-overlay` was parameter was renamed to `iohk-extras`.
8+
9+
# Drop `th-packages`
10+
11+
When using `iohk-nix` to facility cross compilation, we used to require explicit listing of packages
12+
that required `TemplateHaskell`, this was dropped in [iohk-nix@da7c1ed](https://github.com/input-output-hk/iohk-nix/commit/da7c1edc31d24ff4a211b7dc2361c71af7c3bda4), see #92.
13+
As such the `th-packages` and `nixpkgs` argument were dropped from the `iohk-module`.

0 commit comments

Comments
 (0)