docs: document Scala Native flag options

VirtusLab · Dec 20, 2024 · 29f790e · 29f790e
1 parent 4ab3227
commit 29f790e
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 36 deletions.
diff --git a/modules/cli/src/main/scala/scala/cli/commands/shared/ScalaNativeOptions.scala b/modules/cli/src/main/scala/scala/cli/commands/shared/ScalaNativeOptions.scala
@@ -19,15 +19,15 @@ final case class ScalaNativeOptions(
   @HelpMessage(s"Set the Scala Native version (${Constants.scalaNativeVersion} by default).")
     nativeVersion: Option[String] = None,
   @Group(HelpGroup.ScalaNative.toString)
-  @HelpMessage("Set Scala Native compilation mode")
+  @HelpMessage("Set Scala Native compilation mode (debug by default): debug, release-fast, release-size, release-full")
   @Tag(tags.should)
     nativeMode: Option[String] = None,
   @Group(HelpGroup.ScalaNative.toString)
-  @HelpMessage("Link-time optimisation mode")
+  @HelpMessage("Link-time optimisation mode (none by default): none, full, thin")
   @Tag(tags.should)
     nativeLto: Option[String] = None,
   @Group(HelpGroup.ScalaNative.toString)
-  @HelpMessage("Set the Scala Native garbage collector")
+  @HelpMessage("Set the Scala Native garbage collector (immix by default): immix, commix, boehm, none")
   @Tag(tags.should)
     nativeGc: Option[String] = None,
 

diff --git a/website/docs/reference/cli-options.md b/website/docs/reference/cli-options.md
@@ -1392,15 +1392,15 @@ Set the Scala Native version (0.5.6 by default).
 
 ### `--native-mode`
 
-Set Scala Native compilation mode
+Set Scala Native compilation mode (debug by default): debug, release-fast, release-size, release-full
 
 ### `--native-lto`
 
-Link-time optimisation mode
+Link-time optimisation mode (none by default): none, full, thin
 
 ### `--native-gc`
 
-Set the Scala Native garbage collector
+Set the Scala Native garbage collector (immix by default): immix, commix, boehm, none
 
 ### `--native-clang`
 

diff --git a/website/docs/reference/scala-command/cli-options.md b/website/docs/reference/scala-command/cli-options.md
@@ -852,19 +852,19 @@ Set the Scala Native version (0.5.6 by default).
 
 `SHOULD have` per Scala Runner specification
 
-Set Scala Native compilation mode
+Set Scala Native compilation mode (debug by default): debug, release-fast, release-size, release-full
 
 ### `--native-lto`
 
 `SHOULD have` per Scala Runner specification
 
-Link-time optimisation mode
+Link-time optimisation mode (none by default): none, full, thin
 
 ### `--native-gc`
 
 `SHOULD have` per Scala Runner specification
 
-Set the Scala Native garbage collector
+Set the Scala Native garbage collector (immix by default): immix, commix, boehm, none
 
 ### `--native-clang`
 

diff --git a/website/docs/reference/scala-command/runner-specification.md b/website/docs/reference/scala-command/runner-specification.md
@@ -182,15 +182,15 @@ Set the Scala Native version (0.5.6 by default).
 
 **--native-mode**
 
-Set Scala Native compilation mode
+Set Scala Native compilation mode (debug by default): debug, release-fast, release-size, release-full
 
 **--native-lto**
 
-Link-time optimisation mode
+Link-time optimisation mode (none by default): none, full, thin
 
 **--native-gc**
 
-Set the Scala Native garbage collector
+Set the Scala Native garbage collector (immix by default): immix, commix, boehm, none
 
 **--native-linking**
 
@@ -963,15 +963,15 @@ Set the Scala Native version (0.5.6 by default).
 
 **--native-mode**
 
-Set Scala Native compilation mode
+Set Scala Native compilation mode (debug by default): debug, release-fast, release-size, release-full
 
 **--native-lto**
 
-Link-time optimisation mode
+Link-time optimisation mode (none by default): none, full, thin
 
 **--native-gc**
 
-Set the Scala Native garbage collector
+Set the Scala Native garbage collector (immix by default): immix, commix, boehm, none
 
 **--native-linking**
 
@@ -1546,15 +1546,15 @@ Set the Scala Native version (0.5.6 by default).
 
 **--native-mode**
 
-Set Scala Native compilation mode
+Set Scala Native compilation mode (debug by default): debug, release-fast, release-size, release-full
 
 **--native-lto**
 
-Link-time optimisation mode
+Link-time optimisation mode (none by default): none, full, thin
 
 **--native-gc**
 
-Set the Scala Native garbage collector
+Set the Scala Native garbage collector (immix by default): immix, commix, boehm, none
 
 **--native-linking**
 
@@ -2161,15 +2161,15 @@ Set the Scala Native version (0.5.6 by default).
 
 **--native-mode**
 
-Set Scala Native compilation mode
+Set Scala Native compilation mode (debug by default): debug, release-fast, release-size, release-full
 
 **--native-lto**
 
-Link-time optimisation mode
+Link-time optimisation mode (none by default): none, full, thin
 
 **--native-gc**
 
-Set the Scala Native garbage collector
+Set the Scala Native garbage collector (immix by default): immix, commix, boehm, none
 
 **--native-linking**
 
@@ -2789,15 +2789,15 @@ Set the Scala Native version (0.5.6 by default).
 
 **--native-mode**
 
-Set Scala Native compilation mode
+Set Scala Native compilation mode (debug by default): debug, release-fast, release-size, release-full
 
 **--native-lto**
 
-Link-time optimisation mode
+Link-time optimisation mode (none by default): none, full, thin
 
 **--native-gc**
 
-Set the Scala Native garbage collector
+Set the Scala Native garbage collector (immix by default): immix, commix, boehm, none
 
 **--native-linking**
 
@@ -3393,15 +3393,15 @@ Set the Scala Native version (0.5.6 by default).
 
 **--native-mode**
 
-Set Scala Native compilation mode
+Set Scala Native compilation mode (debug by default): debug, release-fast, release-size, release-full
 
 **--native-lto**
 
-Link-time optimisation mode
+Link-time optimisation mode (none by default): none, full, thin
 
 **--native-gc**
 
-Set the Scala Native garbage collector
+Set the Scala Native garbage collector (immix by default): immix, commix, boehm, none
 
 **--native-linking**
 
@@ -4034,15 +4034,15 @@ Set the Scala Native version (0.5.6 by default).
 
 **--native-mode**
 
-Set Scala Native compilation mode
+Set Scala Native compilation mode (debug by default): debug, release-fast, release-size, release-full
 
 **--native-lto**
 
-Link-time optimisation mode
+Link-time optimisation mode (none by default): none, full, thin
 
 **--native-gc**
 
-Set the Scala Native garbage collector
+Set the Scala Native garbage collector (immix by default): immix, commix, boehm, none
 
 **--native-linking**
 
@@ -4726,15 +4726,15 @@ Set the Scala Native version (0.5.6 by default).
 
 **--native-mode**
 
-Set Scala Native compilation mode
+Set Scala Native compilation mode (debug by default): debug, release-fast, release-size, release-full
 
 **--native-lto**
 
-Link-time optimisation mode
+Link-time optimisation mode (none by default): none, full, thin
 
 **--native-gc**
 
-Set the Scala Native garbage collector
+Set the Scala Native garbage collector (immix by default): immix, commix, boehm, none
 
 **--native-linking**
 
@@ -5659,15 +5659,15 @@ Set the Scala Native version (0.5.6 by default).
 
 **--native-mode**
 
-Set Scala Native compilation mode
+Set Scala Native compilation mode (debug by default): debug, release-fast, release-size, release-full
 
 **--native-lto**
 
-Link-time optimisation mode
+Link-time optimisation mode (none by default): none, full, thin
 
 **--native-gc**
 
-Set the Scala Native garbage collector
+Set the Scala Native garbage collector (immix by default): immix, commix, boehm, none
 
 **--native-linking**