git.iko.soy/haskell.nix
on 899e933 help sign in
haskell.nix/docs/tutorials/pkg-map.md
42 lines 1.8 kB history raw
1# Mapping non-Haskell dependencies to Nixpkgs
3Cabal files may contain dependencies to external non-Haskell
4dependencies via:
6* [`build-tool-depends`](https://cabal.readthedocs.io/en/latest/developing-packages.html#pkg-field-build-tool-depends)
7* [`pkgconfig-depends`](https://cabal.readthedocs.io/en/latest/developing-packages.html#pkg-field-pkgconfig-depends)
8* [`frameworks`](https://cabal.readthedocs.io/en/latest/developing-packages.html#pkg-field-frameworks)
9* [`extra-libraries`](https://cabal.readthedocs.io/en/latest/developing-packages.html#pkg-field-extra-libraries)
11If there is a `pkgs` attribute in Nixpkgs that matches the name given
12in the Cabal file, then it will be added as a dependency (see the
13output of `cabal-to-nix`). Otherwise, there needs to be a mapping from
14Cabal file names (decided by the package author) to Nix package
15identifiers.
17### Nixpkgs overlay
19The user may solve it by themself by overriding Nixpkgs and adding a
20package alias. For example:
22```nix
23nixpkgs.overlays = [
24 (self: super: {
25 icuuc = self.icu;
26 icui18n = self.icu;
27 icudata = self.icu;
28 })
29];
30```
32### Mapping in Haskell.nix
34Alternatively, if the name is commonly used, an alias can be added to
35the Haskell.nix sources, so that it's solved for all users.
37* [`lib/pkgconf-nixpkgs-map.nix`](https://github.com/input-output-hk/haskell.nix/blob/master/lib/pkgconf-nixpkgs-map.nix) - for `pkgconfig-depends`
38* [`lib/system-nixpkgs-map.nix`](https://github.com/input-output-hk/haskell.nix/blob/master/lib/system-nixpkgs-map.nix) - for `build-tool-depends`, `frameworks`, `extra-libraries`, etc.
40!!! tip "Open a PR"
41 Please go ahead and open a [pull request](https://github.com/input-output-hk/haskell.nix/pulls)
42 to improve the package mappings.