8328627: JShell documentation should be clearer about "remote runtime system"

Co-authored-by: Alex Buckley <abuckley@openjdk.org>
Reviewed-by: asotona
This commit is contained in:
Jan Lahoda 2024-04-08 12:13:52 +00:00
parent 8648890f86
commit be45de1f93
2 changed files with 28 additions and 14 deletions
src/jdk.jshell/share
classes/jdk/internal/jshell/tool/resources
man

@ -218,11 +218,19 @@ where possible options include:\n\
\ -q Quiet feedback. Same as: --feedback concise\n\
\ -s Really quiet feedback. Same as: --feedback silent\n\
\ -v Verbose feedback. Same as: --feedback verbose\n\
\ -J<flag> Pass <flag> directly to the runtime system.\n\
\ Use one -J for each runtime flag or flag argument\n\
\ -R<flag> Pass <flag> to the remote runtime system.\n\
\ Use one -R for each remote flag or flag argument\n\
\ -C<flag> Pass <flag> to the compiler.\n\
\ -J<flag> passes <flag> to the runtime system, but has no effect\n\
\ on the execution of code snippets. To specify flags\n\
\ that affect the execution of code snippets, use\n\
\ -R<flag>. Alternatively, use -J<flag> with\n\
\ --execution local.\n\
\ -R<flag> passes <flag> to the runtime system only when code\n\
\ snippets are executed. For example, -R-Dfoo=bar\n\
\ means that execution of the snippet\n\
\ System.getProperty("foo") will return "bar".\n\
\ -C<flag> passes <flag> to the Java compiler inside JShell.\n\
\ For example, -C-Xlint enables all the recommended\n\
\ lint warnings, and -C--release=<N> compiles for\n\
\ Java SE N, as if --release N was specified.\n\
\ Use one -C for each compiler flag or flag argument\n\
\ --version Print version information and exit\n\
\ --show-version Print version information and continue\n\

@ -122,9 +122,10 @@ module.
Specifies the root modules to resolve in addition to the initial module.
.TP
\f[V]-C\f[R]\f[I]flag\f[R]
Provides a flag to pass to the compiler.
To pass more than one flag, provide an instance of this option for each
flag or flag argument needed.
passes \f[I]flag\f[R] to the Java compiler inside JShell.
For example, \f[V]-C-Xlint\f[R] enables all the recommended lint
warnings, and \f[V]-C--release=<N>\f[R] compiles for Java SE N, as if
--release N was specified.
.TP
\f[V]--class-path\f[R] \f[I]path\f[R]
Specifies the directories and archives that are searched to locate class
@ -187,9 +188,12 @@ Prints a summary of nonstandard options and exits the tool.
Nonstandard options are subject to change without notice.
.TP
\f[V]-J\f[R]\f[I]flag\f[R]
Provides a flag to pass to the runtime system.
To pass more than one flag, provide an instance of this option for each
flag or flag argument needed.
passes \f[I]flag\f[R] to the runtime system, but has no effect on the
execution of code snippets.
To specify flags that affect the execution of code snippets, use
\f[V]-R\f[R]\f[I]flag\f[R].
Alternatively, use \f[V]-J\f[R]\f[I]flag\f[R] with
\f[V]--execution local\f[R].
.TP
\f[V]--module-path\f[R] \f[I]modulepath\f[R]
Specifies where to find application modules.
@ -208,9 +212,11 @@ Sets the feedback mode to \f[V]concise\f[R], which is the same as
entering \f[V]--feedback concise\f[R].
.TP
\f[V]-R\f[R]\f[I]flag\f[R]
Provides a flag to pass to the remote runtime system.
To pass more than one flag, provide an instance of this option for each
flag or flag argument to pass.
passes \f[I]flag\f[R] to the runtime system only when code snippets are
executed.
For example, \f[V]-R-Dfoo=bar\f[R] means that execution of the snippet
\f[V]System.getProperty(\[dq]foo\[dq])\f[R] will return
\f[V]\[dq]bar\[dq]\f[R].
.TP
\f[V]-s\f[R]
Sets the feedback mode to \f[V]silent\f[R], which is the same as