Unverified Commit 10dc4ab4 authored by ttuegel's avatar ttuegel
Browse files

Nix: document shell expression filenames

Mention that we allow `shell.nix` or `default.nix`, the same as
`nix-shell`.
parent df6b57ad
...@@ -12,7 +12,7 @@ To enable Nix integration, simply pass the ``--enable-nix`` global option when y ...@@ -12,7 +12,7 @@ To enable Nix integration, simply pass the ``--enable-nix`` global option when y
nix: True nix: True
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: 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:
- ``cabal configure`` - ``cabal configure``
- ``cabal build`` - ``cabal build``
...@@ -23,7 +23,7 @@ If the package (which must be locally unpacked) provides a ``shell.nix`` file, t ...@@ -23,7 +23,7 @@ If the package (which must be locally unpacked) provides a ``shell.nix`` file, t
- ``cabal gen-bounds`` - ``cabal gen-bounds``
- ``cabal run`` - ``cabal run``
If the package does not provide a ``shell.nix``, ``cabal`` runs normally. If the package does not provide an expression, ``cabal`` runs normally.
Creating Nix Expressions Creating Nix Expressions
------------------------ ------------------------
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment