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

docs: add in some HelpMessages for Java/JavaHome #2771

Merged
merged 1 commit into from
May 30, 2023
Merged

docs: add in some HelpMessages for Java/JavaHome #2771

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
2 changes: 2 additions & 0 deletions modules/cli/src/main/scala/coursier/cli/jvm/JavaOptions.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,10 @@ import caseapp.Group
)
final case class JavaOptions(
@Group(OptionGroup.java)
@HelpMessage("List all available JVMs")
available: Boolean = false,
@Group(OptionGroup.java)
@HelpMessage("List all the installed JVMs")
installed: Boolean = false,
@Recurse
sharedJavaOptions: SharedJavaOptions = SharedJavaOptions(),
Expand Down
2 changes: 2 additions & 0 deletions modules/cli/src/main/scala/coursier/cli/jvm/SharedJavaOptions.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import coursier.cli.options.OptionGroup
final case class SharedJavaOptions(

@Group(OptionGroup.java)
@HelpMessage("The JVM you're targeting (e.g. --jvm temurin:1.17)")
jvm: Option[String] = None,

@Group(OptionGroup.java)
Expand All @@ -18,6 +19,7 @@ final case class SharedJavaOptions(
update: Boolean = false,

@Group(OptionGroup.java)
@HelpMessage("Location of the JVM index that you'd like to use")
jvmIndex: Option[String] = None,

@Group(OptionGroup.java)
Expand Down
2 changes: 2 additions & 0 deletions modules/cli/src/main/scala/coursier/cli/options/EnvOptions.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import scala.util.Properties
final case class EnvOptions(

@Group(OptionGroup.scripting)
@HelpMessage("Prints out a script that can be used to setup the env")
env: Boolean = false,

@Group(OptionGroup.scripting)
Expand All @@ -20,6 +21,7 @@ final case class EnvOptions(
windowsScript: Boolean = Properties.isWin,

@Group(OptionGroup.scripting)
@HelpMessage("Sets the default JVM to be used")
setup: Boolean = false,

@Group(OptionGroup.scripting)
Expand Down