Skip to content

Commit 5449184

Browse files
committed
Nix: document shell expression filenames
Mention that we allow `shell.nix` or `default.nix`, the same as `nix-shell`.
1 parent 7bb8192 commit 5449184

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

Cabal/doc/nix-integration.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ To enable Nix integration, simply pass the ``--enable-nix`` global option when y
1212
1313
nix: True
1414
15-
If the package (which must be locally unpacked) provides a ``shell.nix`` file, this flag will cause ``cabal`` to run most commands through ``nix-shell``. The following commands are affected:
15+
If the package (which must be locally unpacked) provides a ``shell.nix`` or ``default.nix`` file, this flag will cause ``cabal`` to run most commands through ``nix-shell``. If both expressions are present, ``shell.nix`` is preferred. The following commands are affected:
1616

1717
- ``cabal configure``
1818
- ``cabal build``
@@ -23,7 +23,7 @@ If the package (which must be locally unpacked) provides a ``shell.nix`` file, t
2323
- ``cabal gen-bounds``
2424
- ``cabal run``
2525

26-
If the package does not provide a ``shell.nix``, ``cabal`` runs normally.
26+
If the package does not provide an expression, ``cabal`` runs normally.
2727

2828
Creating Nix Expressions
2929
------------------------

0 commit comments

Comments
 (0)