Skip to content

Commit

Permalink
Make purpose of the options clearer in the internal docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jchyb committed Sep 4, 2024
1 parent 1e166cb commit a8970a8
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/_docs/internals/best-effort-compilation.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ It is composed of two experimental compiler options:
* `-Ywith-best-effort-tasty` allows to read Best Effort TASTy files, and if such file is read from the classpath then
limits compilation to the frontend phases

IMPORTANT: These options are meant to by used by an IDE and should never be used on the user side, in the project definition.
This is why they are hidden behind a private `-Y` option specifier.

This feature aims to force through to the typer phase regardless of errors, and then serialize tasty-like files
obtained from the error trees into the best effort directory (`META-INF/best-effort`) and also serialize semanticdb as normal.

Expand Down

0 comments on commit a8970a8

Please sign in to comment.