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

Jump to bottom

Doc: Tips on how to list available JVMs using coursier #3129

Merged
merged 5 commits into from
Aug 30, 2024
Merged

Doc: Tips on how to list available JVMs using coursier #3129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
acc8226
Tips on how to list available JVMs
jatcwang Aug 26, 2024
e14d5d9
add link
jatcwang Aug 27, 2024
dd1ee7c
try
jatcwang Aug 27, 2024
17b4443
Generate docs
jatcwang Aug 28, 2024
3fa3909
scalafmt
jatcwang Aug 28, 2024
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
3 changes: 2 additions & 1 deletion modules/cli/src/main/scala/scala/cli/commands/shared/SharedJvmOptions.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ final case class SharedJvmOptions(
javaHome: Option[String] = None,

@Group(HelpGroup.Java.toString)
@HelpMessage("Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`")
@HelpMessage("Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`. " +
"scala-cli uses [coursier](https://get-coursier.io/) to fetch JVMs, so you can use `cs java --available` to list the available JVMs.")
@ValueDescription("jvm-name")
@Tag(tags.should)
@Name("j")
Expand Down
5 changes: 4 additions & 1 deletion modules/directives/src/main/scala/scala/build/preprocessing/directives/Jvm.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,10 @@ import scala.cli.commands.SpecificationLevel
"//> using jvm _value_",
"`//> using jvm` _value_"
)
@DirectiveDescription("Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`")
@DirectiveDescription(
"Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`. " +
"scala-cli uses [coursier](https://get-coursier.io/) to fetch JVMs, so you can use `cs java --available` to list the available JVMs."
)
@DirectiveLevel(SpecificationLevel.SHOULD)
// format: off
final case class Jvm(
Expand Down
2 changes: 1 addition & 1 deletion website/docs/reference/cli-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -639,7 +639,7 @@ Set the Java home directory

Aliases: `-j`

Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`
Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`. scala-cli uses [coursier](https://get-coursier.io/) to fetch JVMs, so you can use `cs java --available` to list the available JVMs.

### `--jvm-index`

Expand Down
2 changes: 1 addition & 1 deletion website/docs/reference/directives.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Exclude sources from the project

### JVM version

Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`
Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`. scala-cli uses [coursier](https://get-coursier.io/) to fetch JVMs, so you can use `cs java --available` to list the available JVMs.

`//> using jvm` _value_

Expand Down
2 changes: 1 addition & 1 deletion 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 @@ -570,7 +570,7 @@ Aliases: `-j`

`SHOULD have` per Scala Runner specification

Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`
Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`. scala-cli uses [coursier](https://get-coursier.io/) to fetch JVMs, so you can use `cs java --available` to list the available JVMs.

### `--jvm-index`

Expand Down
2 changes: 1 addition & 1 deletion website/docs/reference/scala-command/directives.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ Exclude sources from the project

### JVM version

Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`
Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`. scala-cli uses [coursier](https://get-coursier.io/) to fetch JVMs, so you can use `cs java --available` to list the available JVMs.

`//> using jvm` _value_

Expand Down
20 changes: 10 additions & 10 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 @@ -238,7 +238,7 @@ Set the Java home directory

**--jvm**

Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`
Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`. scala-cli uses [coursier](https://get-coursier.io/) to fetch JVMs, so you can use `cs java --available` to list the available JVMs.

Aliases: `-j`

Expand Down Expand Up @@ -706,7 +706,7 @@ Set the Java home directory

**--jvm**

Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`
Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`. scala-cli uses [coursier](https://get-coursier.io/) to fetch JVMs, so you can use `cs java --available` to list the available JVMs.

Aliases: `-j`

Expand Down Expand Up @@ -1019,7 +1019,7 @@ Set the Java home directory

**--jvm**

Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`
Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`. scala-cli uses [coursier](https://get-coursier.io/) to fetch JVMs, so you can use `cs java --available` to list the available JVMs.

Aliases: `-j`

Expand Down Expand Up @@ -1602,7 +1602,7 @@ Set the Java home directory

**--jvm**

Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`
Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`. scala-cli uses [coursier](https://get-coursier.io/) to fetch JVMs, so you can use `cs java --available` to list the available JVMs.

Aliases: `-j`

Expand Down Expand Up @@ -2217,7 +2217,7 @@ Set the Java home directory

**--jvm**

Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`
Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`. scala-cli uses [coursier](https://get-coursier.io/) to fetch JVMs, so you can use `cs java --available` to list the available JVMs.

Aliases: `-j`

Expand Down Expand Up @@ -2845,7 +2845,7 @@ Set the Java home directory

**--jvm**

Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`
Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`. scala-cli uses [coursier](https://get-coursier.io/) to fetch JVMs, so you can use `cs java --available` to list the available JVMs.

Aliases: `-j`

Expand Down Expand Up @@ -3449,7 +3449,7 @@ Set the Java home directory

**--jvm**

Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`
Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`. scala-cli uses [coursier](https://get-coursier.io/) to fetch JVMs, so you can use `cs java --available` to list the available JVMs.

Aliases: `-j`

Expand Down Expand Up @@ -4090,7 +4090,7 @@ Set the Java home directory

**--jvm**

Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`
Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`. scala-cli uses [coursier](https://get-coursier.io/) to fetch JVMs, so you can use `cs java --available` to list the available JVMs.

Aliases: `-j`

Expand Down Expand Up @@ -4782,7 +4782,7 @@ Set the Java home directory

**--jvm**

Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`
Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`. scala-cli uses [coursier](https://get-coursier.io/) to fetch JVMs, so you can use `cs java --available` to list the available JVMs.

Aliases: `-j`

Expand Down Expand Up @@ -5715,7 +5715,7 @@ Set the Java home directory

**--jvm**

Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`
Use a specific JVM, such as `14`, `adopt:11`, or `graalvm:21`, or `system`. scala-cli uses [coursier](https://get-coursier.io/) to fetch JVMs, so you can use `cs java --available` to list the available JVMs.

Aliases: `-j`

Expand Down
Loading