Skip to content

Commit 16557d3

Browse files
scarf005scarf005
authored
docs: document Scala Native flag options (#3386)
1 parent 4ab3227 commit 16557d3

File tree

4 files changed

+36
-36
lines changed

4 files changed

+36
-36
lines changed

‎modules/cli/src/main/scala/scala/cli/commands/shared/ScalaNativeOptions.scala

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ final case class ScalaNativeOptions(
1919
@HelpMessage(s"Set the Scala Native version (${Constants.scalaNativeVersion} by default).")
2020
nativeVersion: Option[String] = None,
2121
@Group(HelpGroup.ScalaNative.toString)
22-
@HelpMessage("Set Scala Native compilation mode")
22+
@HelpMessage("Set Scala Native compilation mode (debug by default): debug, release-fast, release-size, release-full")
2323
@Tag(tags.should)
2424
nativeMode: Option[String] = None,
2525
@Group(HelpGroup.ScalaNative.toString)
26-
@HelpMessage("Link-time optimisation mode")
26+
@HelpMessage("Link-time optimisation mode (none by default): none, full, thin")
2727
@Tag(tags.should)
2828
nativeLto: Option[String] = None,
2929
@Group(HelpGroup.ScalaNative.toString)
30-
@HelpMessage("Set the Scala Native garbage collector")
30+
@HelpMessage("Set the Scala Native garbage collector (immix by default): immix, commix, boehm, none")
3131
@Tag(tags.should)
3232
nativeGc: Option[String] = None,
3333

‎website/docs/reference/cli-options.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1392,15 +1392,15 @@ Set the Scala Native version (0.5.6 by default).
13921392

13931393
### `--native-mode`
13941394

1395-
Set Scala Native compilation mode
1395+
Set Scala Native compilation mode (debug by default): debug, release-fast, release-size, release-full
13961396

13971397
### `--native-lto`
13981398

1399-
Link-time optimisation mode
1399+
Link-time optimisation mode (none by default): none, full, thin
14001400

14011401
### `--native-gc`
14021402

1403-
Set the Scala Native garbage collector
1403+
Set the Scala Native garbage collector (immix by default): immix, commix, boehm, none
14041404

14051405
### `--native-clang`
14061406

‎website/docs/reference/scala-command/cli-options.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -852,19 +852,19 @@ Set the Scala Native version (0.5.6 by default).
852852

853853
`SHOULD have` per Scala Runner specification
854854

855-
Set Scala Native compilation mode
855+
Set Scala Native compilation mode (debug by default): debug, release-fast, release-size, release-full
856856

857857
### `--native-lto`
858858

859859
`SHOULD have` per Scala Runner specification
860860

861-
Link-time optimisation mode
861+
Link-time optimisation mode (none by default): none, full, thin
862862

863863
### `--native-gc`
864864

865865
`SHOULD have` per Scala Runner specification
866866

867-
Set the Scala Native garbage collector
867+
Set the Scala Native garbage collector (immix by default): immix, commix, boehm, none
868868

869869
### `--native-clang`
870870

‎website/docs/reference/scala-command/runner-specification.md

+27-27
Original file line numberDiff line numberDiff line change
@@ -182,15 +182,15 @@ Set the Scala Native version (0.5.6 by default).
182182

183183
**--native-mode**
184184

185-
Set Scala Native compilation mode
185+
Set Scala Native compilation mode (debug by default): debug, release-fast, release-size, release-full
186186

187187
**--native-lto**
188188

189-
Link-time optimisation mode
189+
Link-time optimisation mode (none by default): none, full, thin
190190

191191
**--native-gc**
192192

193-
Set the Scala Native garbage collector
193+
Set the Scala Native garbage collector (immix by default): immix, commix, boehm, none
194194

195195
**--native-linking**
196196

@@ -963,15 +963,15 @@ Set the Scala Native version (0.5.6 by default).
963963

964964
**--native-mode**
965965

966-
Set Scala Native compilation mode
966+
Set Scala Native compilation mode (debug by default): debug, release-fast, release-size, release-full
967967

968968
**--native-lto**
969969

970-
Link-time optimisation mode
970+
Link-time optimisation mode (none by default): none, full, thin
971971

972972
**--native-gc**
973973

974-
Set the Scala Native garbage collector
974+
Set the Scala Native garbage collector (immix by default): immix, commix, boehm, none
975975

976976
**--native-linking**
977977

@@ -1546,15 +1546,15 @@ Set the Scala Native version (0.5.6 by default).
15461546

15471547
**--native-mode**
15481548

1549-
Set Scala Native compilation mode
1549+
Set Scala Native compilation mode (debug by default): debug, release-fast, release-size, release-full
15501550

15511551
**--native-lto**
15521552

1553-
Link-time optimisation mode
1553+
Link-time optimisation mode (none by default): none, full, thin
15541554

15551555
**--native-gc**
15561556

1557-
Set the Scala Native garbage collector
1557+
Set the Scala Native garbage collector (immix by default): immix, commix, boehm, none
15581558

15591559
**--native-linking**
15601560

@@ -2161,15 +2161,15 @@ Set the Scala Native version (0.5.6 by default).
21612161

21622162
**--native-mode**
21632163

2164-
Set Scala Native compilation mode
2164+
Set Scala Native compilation mode (debug by default): debug, release-fast, release-size, release-full
21652165

21662166
**--native-lto**
21672167

2168-
Link-time optimisation mode
2168+
Link-time optimisation mode (none by default): none, full, thin
21692169

21702170
**--native-gc**
21712171

2172-
Set the Scala Native garbage collector
2172+
Set the Scala Native garbage collector (immix by default): immix, commix, boehm, none
21732173

21742174
**--native-linking**
21752175

@@ -2789,15 +2789,15 @@ Set the Scala Native version (0.5.6 by default).
27892789

27902790
**--native-mode**
27912791

2792-
Set Scala Native compilation mode
2792+
Set Scala Native compilation mode (debug by default): debug, release-fast, release-size, release-full
27932793

27942794
**--native-lto**
27952795

2796-
Link-time optimisation mode
2796+
Link-time optimisation mode (none by default): none, full, thin
27972797

27982798
**--native-gc**
27992799

2800-
Set the Scala Native garbage collector
2800+
Set the Scala Native garbage collector (immix by default): immix, commix, boehm, none
28012801

28022802
**--native-linking**
28032803

@@ -3393,15 +3393,15 @@ Set the Scala Native version (0.5.6 by default).
33933393

33943394
**--native-mode**
33953395

3396-
Set Scala Native compilation mode
3396+
Set Scala Native compilation mode (debug by default): debug, release-fast, release-size, release-full
33973397

33983398
**--native-lto**
33993399

3400-
Link-time optimisation mode
3400+
Link-time optimisation mode (none by default): none, full, thin
34013401

34023402
**--native-gc**
34033403

3404-
Set the Scala Native garbage collector
3404+
Set the Scala Native garbage collector (immix by default): immix, commix, boehm, none
34053405

34063406
**--native-linking**
34073407

@@ -4034,15 +4034,15 @@ Set the Scala Native version (0.5.6 by default).
40344034

40354035
**--native-mode**
40364036

4037-
Set Scala Native compilation mode
4037+
Set Scala Native compilation mode (debug by default): debug, release-fast, release-size, release-full
40384038

40394039
**--native-lto**
40404040

4041-
Link-time optimisation mode
4041+
Link-time optimisation mode (none by default): none, full, thin
40424042

40434043
**--native-gc**
40444044

4045-
Set the Scala Native garbage collector
4045+
Set the Scala Native garbage collector (immix by default): immix, commix, boehm, none
40464046

40474047
**--native-linking**
40484048

@@ -4726,15 +4726,15 @@ Set the Scala Native version (0.5.6 by default).
47264726

47274727
**--native-mode**
47284728

4729-
Set Scala Native compilation mode
4729+
Set Scala Native compilation mode (debug by default): debug, release-fast, release-size, release-full
47304730

47314731
**--native-lto**
47324732

4733-
Link-time optimisation mode
4733+
Link-time optimisation mode (none by default): none, full, thin
47344734

47354735
**--native-gc**
47364736

4737-
Set the Scala Native garbage collector
4737+
Set the Scala Native garbage collector (immix by default): immix, commix, boehm, none
47384738

47394739
**--native-linking**
47404740

@@ -5659,15 +5659,15 @@ Set the Scala Native version (0.5.6 by default).
56595659

56605660
**--native-mode**
56615661

5662-
Set Scala Native compilation mode
5662+
Set Scala Native compilation mode (debug by default): debug, release-fast, release-size, release-full
56635663

56645664
**--native-lto**
56655665

5666-
Link-time optimisation mode
5666+
Link-time optimisation mode (none by default): none, full, thin
56675667

56685668
**--native-gc**
56695669

5670-
Set the Scala Native garbage collector
5670+
Set the Scala Native garbage collector (immix by default): immix, commix, boehm, none
56715671

56725672
**--native-linking**
56735673

0 commit comments

Comments
 (0)