Skip to content

Commit 024b0ad

Browse files
committed
Add some documentation about troubleshooting spurious unit test failures.
1 parent 678fdc7 commit 024b0ad

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/docs/contributing/testing.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,3 +164,10 @@ The test suite will create a new file if it detects any difference, which can be
164164
original expect file, or if the user wants to globally replace all expect files for semanticdb they can use
165165
`scala3-compiler-bootstrapped/test:runMain dotty.tools.dotc.semanticdb.updateExpect`, and compare the changes via version
166166
control.
167+
168+
## Troubleshooting
169+
170+
Some of the tests depend on temporary state stored in the `out` directory. In rare cases, that directory
171+
can enter an inconsistent state and cause spurious test failures. If you suspect a spurious test failure,
172+
you can run `rm -rf out/*` from the root of the repository and run your tests again. If that fails, you
173+
can try `git clean -xfd`.

0 commit comments

Comments
 (0)