distage: Document that -Yretain-trees option is mandatory for Scala…

… 3 users
7mind · Jun 28, 2023 · f8016bc · f8016bc
1 parent 4e6b8e7
commit f8016bc
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/doc/microsite/src/main/tut/distage/basics.md b/doc/microsite/src/main/tut/distage/basics.md
@@ -53,6 +53,12 @@ Add the `distage-core` library:
   version="$izumi.version$"
 }
 
+If you're using Scala 3 you **must** enable `-Yretain-trees` for this library to work correctly:
+
+```scala
+// REQUIRED options for Scala 3
+scalacOptions += "-Yretain-trees"
+```
 
 ### Hello World example