From a8970a8fbec2ce16a8bdabcddb3332f05df5a734 Mon Sep 17 00:00:00 2001 From: Jan Chyb Date: Wed, 4 Sep 2024 16:30:45 +0200 Subject: [PATCH] Make purpose of the options clearer in the internal docs --- docs/_docs/internals/best-effort-compilation.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/_docs/internals/best-effort-compilation.md b/docs/_docs/internals/best-effort-compilation.md index 2fed951c3fd8..248203883a3c 100644 --- a/docs/_docs/internals/best-effort-compilation.md +++ b/docs/_docs/internals/best-effort-compilation.md @@ -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.