Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: document Scala Native flag options #3386

Merged
merged 1 commit into from
Dec 20, 2024
Merged

docs: document Scala Native flag options #3386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions modules/cli/src/main/scala/scala/cli/commands/shared/ScalaNativeOptions.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,

Expand Down
6 changes: 3 additions & 3 deletions website/docs/reference/cli-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down
6 changes: 3 additions & 3 deletions website/docs/reference/scala-command/cli-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down
54 changes: 27 additions & 27 deletions website/docs/reference/scala-command/runner-specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,15 +182,15 @@ Set the Scala Native version (0.5.6 by default).

**--native-mode**

Set Scala Native compilation mode
Gedochao marked this conversation as resolved.
Show resolved Hide resolved
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**

Expand Down Expand Up @@ -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**

Expand Down Expand Up @@ -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**

Expand Down Expand Up @@ -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**

Expand Down Expand Up @@ -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**

Expand Down Expand Up @@ -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**

Expand Down Expand Up @@ -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**

Expand Down Expand Up @@ -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**

Expand Down Expand Up @@ -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**

Expand Down