Skip to content

Update docs #107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 7, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Mar 15, 2019
* overlays was renamed to extras (#79)
See docs/migration.md
11 changes: 1 addition & 10 deletions docs/iohk-nix.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,14 +52,6 @@ let
# our packages
stack-pkgs = import ./.stack-pkgs.nix;

# packages which will require TH and thus
# will need -fexternal-interpreter treatment
# when cross compiling.
th-packages = [
"hedgehog" "cardano-crypto-wrapper"
"cardano-crypto-test" "cardano-chain"
"small-steps" "cs-ledger" ];

# Build the packageset with module support.
# We can essentially override anything in the modules
# section.
Expand Down Expand Up @@ -93,8 +85,7 @@ let
# work when cross compiling. For now we need to
# list the packages that require template haskell
# explicity here.
(iohk-module { nixpkgs = pkgs;
inherit th-packages; })
iohk-module
];
};
in
Expand Down
13 changes: 13 additions & 0 deletions docs/migrations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# `overlay` to `extras`

`overlay` was renamed to `extras` in #79 to prevent confusion between the notion of nix overlays.
Therefore `plan-pkgs` and `stack-pkgs` as generated by `plan-to-nix` and `stack-to-nix` will
expose `extras` instead of `overlay`. Similarly `mkStackPkgSet`, `mkPkgSet` and `mkCabalProjectPkgSet`
take a `pkg-def-extras` instead of `pkg-def-overlay` argument. If you are using `iohk-nix`, the
`iohk-overlay` was parameter was renamed to `iohk-extras`.

# Drop `th-packages`

When using `iohk-nix` to facility cross compilation, we used to require explicit listing of packages
that required `TemplateHaskell`, this was dropped in [iohk-nix@da7c1ed](https://github.com/input-output-hk/iohk-nix/commit/da7c1edc31d24ff4a211b7dc2361c71af7c3bda4), see #92.
As such the `th-packages` and `nixpkgs` argument were dropped from the `iohk-module`.