git.iko.soy/haskell.nix
on iko/ghcjs-patch-master help sign in
docs: Add note about shellFor and CABAL_CONFIG (#247)
commitad640fa02d8d9a99d33da3dff5d87b6e2a7b47de authorRodney Lorrimar <rodney.lorrimar@iohk.io> dateTue 24 Sep 2019, 08:53 (7 years ago) parent2af9b16
3 files changed+15−3
compare with iko/ghcjs-patch-master
unifiedsplit
docs/reference/library.md+9−1 docs/user-guide/development.md+5−1 mkdocs.yml+1−1
docs/reference/library.md+9−1
@@ -281,7 +281,7 @@ These functions exist within the `hsPkgs` package set.
281281
282282Create a `nix-shell` [development
283283environment](../user-guide/development.md) for developing one or more
284−packages.
284+packages with `ghci` or `cabal v2-build` (but not Stack).
285285
286286```
287287shellFor =
@@ -297,6 +297,14 @@ shellFor =
297297
298298**Return value**: a derivation
299299
300+!!! warning
301+
302+ `shellFor` will set the `CABAL_CONFIG` environment variable to disable
303+ remote package servers. This is a [known
304+ limitation](../dev/removing-with-package-wrapper.md) which we would
305+ like to solve.
306+
307+
300308## ghcWithPackages
301309
302310Creates a `nix-shell` [development
docs/user-guide/development.md+5−1
@@ -45,7 +45,7 @@ If you have a Cabal or Stack project with multiple packages
4545(i.e. multiple `.cabal` files, not a single package with multiple
4646components), then you will need a development environment that
4747contains the _dependencies_ of your packages, but not the packages
48−themselves. This is what the `shellFor` function does.
48+themselves. This is what the [`shellFor`][shellFor] function does.
4949
5050```nix
5151# shell.nix
@@ -71,6 +71,10 @@ in
7171 }
7272```
7373
74+See also: [Haskell.nix Library Reference: `shellFor`][shellFor]
75+
76+[shellFor]: ../reference/library.md#shellfor
77+
7478## How to get a local Hoogle index
7579
7680If you need a local Hoogle for all the dependencies of your project create this file
mkdocs.yml+1−1
@@ -33,7 +33,7 @@ pages:
3333 - 'How to cross-compile your project': user-guide/cross-compilation.md
3434 - 'Reference':
3535 - 'Command-line tools': reference/commands.md
36− - 'Haskell.nix Libary': reference/library.md
36+ - 'Haskell.nix Library': reference/library.md
3737 - 'Module options': reference/modules.md
3838 - 'Templates / Abstraction':
3939 - 'IOHKs nix library': iohk-nix.md