Skip to content

Commit da0933a

Browse files
authored
Added nix/README.md (#6811)
1 parent 89367c5 commit da0933a

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

nix/README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# DevEnv & CI - Maintenance Guide & Troubleshooting
2+
3+
This document is intended both for maintainers of the nix code and for developers facing issues with their development environment or with the CI system.
4+
5+
# Troubleshooting
6+
7+
8+
<div style="background-color: #FFFF0033; padding: 5px;">
9+
10+
`nix develop` fails to enter the shell, `cabal build` fails when it shouldn't.
11+
12+
</div>
13+
14+
In general when facing any problem related to the nix shell or cabal failing to build when it shouldn't, the first step is to make sure you are using the latest shell from master: first exit the nix shell, then `git pull --rebase origin master`, then re-enter the nix shell (i.e. run `nix develop`).
15+
16+
If that fails, you might be facing a caching issue. In that case, try this before exiting and re-entering the nix shell:
17+
18+
```
19+
rm -r ~/.cabal/{store,packages} plutus-metatheory/_build dist dist-newstyle
20+
```
21+
22+
<div style="background-color: #FFFF0033; padding: 5px;">
23+
24+
`nix develop` is updating the `flake.lock` file.
25+
</div>
26+
27+
This should never happen, it is a bug in nix, and has been observed in version `2.26.1`.
28+
Downgrade your nix installation to fix this issue.
29+

0 commit comments

Comments
 (0)