Skip to content
This repository has been archived by the owner on Sep 2, 2022. It is now read-only.
/ jdk16 Public archive

Commit

Permalink
8258378: Final nroff manpage update for JDK 16
Browse files Browse the repository at this point in the history
Reviewed-by: erikj, dholmes
  • Loading branch information
magicus committed Feb 2, 2021
1 parent 21f8bf4 commit ed1a775
Show file tree
Hide file tree
Showing 27 changed files with 127 additions and 140 deletions.
204 changes: 100 additions & 104 deletions src/java.base/share/man/java.1
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
.\"t
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JAVA" "1" "2020" "JDK 16" "JDK Commands"
.TH "JAVA" "1" "2021" "JDK 16" "JDK Commands"
.hy
.SH NAME
.PP
Expand Down Expand Up @@ -1120,72 +1120,6 @@ Updates \f[I]module\f[R] to open \f[I]package\f[R] to
.RS
.RE
.TP
.B \f[CB]\-\-illegal\-access=\f[R]\f[I]parameter\f[R]
When present at run time, \f[CB]\-\-illegal\-access=\f[R] takes a keyword
\f[I]parameter\f[R] to specify a mode of operation:
.RS
.RS
.PP
\f[B]Note:\f[R] This option will be removed in a future release.
.RE
.IP \[bu] 2
\f[CB]permit\f[R]: This mode opens each package in each module in the
run\-time image to code in all unnamed modules ( such as code on the
class path), if that package existed in JDK 8.
This enables both static access, (for example, by compiled bytecode, and
deep reflective access) through the platform\[aq]s various reflection
APIs.
The first reflective\-access operation to any such package causes a
warning to be issued.
However, no warnings are issued after the first occurrence.
This single warning describes how to enable further warnings.
This mode is the default for the current JDK but will change in a future
release.
.IP \[bu] 2
\f[CB]warn\f[R]: This mode is identical to \f[CB]permit\f[R] except that a
warning message is issued for each illegal reflective\-access operation.
.IP \[bu] 2
\f[CB]debug\f[R]: This mode is identical to \f[CB]warn\f[R] except that both
a warning message and a stack trace are issued for each illegal
reflective\-access operation.
.IP \[bu] 2
\f[CB]deny\f[R]: This mode disables all illegal\-access operations except
for those enabled by other command\-line options, such as
\f[CB]\-\-add\-opens\f[R].
This mode will become the default in a future release.
.PP
The default mode, \f[CB]\-\-illegal\-access=permit\f[R], is intended to
make you aware of code on the class path that reflectively accesses any
JDK\-internal APIs at least once.
To learn about all such accesses, you can use the \f[CB]warn\f[R] or the
\f[CB]debug\f[R] modes.
For each library or framework on the class path that requires illegal
access, you have two options:
.IP \[bu] 2
If the component\[aq]s maintainers have already released a fixed version
that no longer uses JDK\-internal APIs then you can consider upgrading
to that version.
.IP \[bu] 2
If the component still needs to be fixed, then you can contact its
maintainers and ask them to replace their use of JDK\-internal APIs with
the proper exported APIs.
.PP
If you must continue to use a component that requires illegal access,
then you can eliminate the warning messages by using one or more
\f[CB]\-\-add\-opens\f[R] options to open only those internal packages to
which access is required.
.PP
To verify that your application is ready for a future version of the
JDK, run it with \f[CB]\-\-illegal\-access=deny\f[R] along with any
necessary \f[CB]\-\-add\-opens\f[R] options.
Any remaining illegal\-access errors will most likely be due to static
references from compiled code to JDK\-internal APIs.
You can identify those by running the \f[B]jdeps\f[R] tool with the
\f[CB]\-\-jdk\-internals\f[R] option.
For performance reasons, the current JDK does not issue warnings for
illegal static\-access operations.
.RE
.TP
.B \f[CB]\-\-limit\-modules\f[R] \f[I]module\f[R][\f[CB],\f[R]\f[I]module\f[R]...]
Specifies the limit of the universe of observable modules.
.RS
Expand Down Expand Up @@ -3937,6 +3871,68 @@ future JDK release.
They\[aq]re still accepted and acted upon, but a warning is issued when
they\[aq]re used.
.TP
.B \f[CB]\-\-illegal\-access=\f[R]\f[I]parameter\f[R]
When present at run time, \f[CB]\-\-illegal\-access=\f[R] takes a keyword
\f[I]parameter\f[R] to specify a mode of operation:
.RS
.RS
.PP
\f[B]Note:\f[R] This option will be removed in a future release.
.RE
.IP \[bu] 2
\f[CB]permit\f[R]: This mode opens each package in each module in the
run\-time image to code in all unnamed modules ( such as code on the
class path), if that package existed in JDK 8.
This enables both static access, (for example, by compiled bytecode, and
deep reflective access) through the platform\[aq]s various reflection
APIs.
The first reflective\-access operation to any such package causes a
warning to be issued.
However, no warnings are issued after the first occurrence.
This single warning describes how to enable further warnings.
.IP \[bu] 2
\f[CB]warn\f[R]: This mode is identical to \f[CB]permit\f[R] except that a
warning message is issued for each illegal reflective\-access operation.
.IP \[bu] 2
\f[CB]debug\f[R]: This mode is identical to \f[CB]warn\f[R] except that both
a warning message and a stack trace are issued for each illegal
reflective\-access operation.
.IP \[bu] 2
\f[CB]deny\f[R]: This mode disables all illegal\-access operations except
for those enabled by other command\-line options, such as
\f[CB]\-\-add\-opens\f[R].
This mode is the default.
.PP
If your application does not work with the default mode of
\f[CB]\-\-illegal\-access=deny\f[R] then you can learn more about what is
going on with the \f[CB]warn\f[R] and \f[CB]debug\f[R] modes.
For each library or framework on the class path that requires illegal
access, you have two options:
.IP \[bu] 2
If the component\[aq]s maintainers have already released a fixed version
that no longer uses JDK\-internal APIs then you can consider upgrading
to that version.
.IP \[bu] 2
If the component still needs to be fixed, then you can contact its
maintainers and ask them to replace their use of JDK\-internal APIs with
the proper exported APIs.
.PP
If you must continue to use a component that requires illegal access,
then you can eliminate the warning messages by using one or more
\f[CB]\-\-add\-opens\f[R] options to open only those internal packages to
which access is required.
.PP
To verify that your application is ready for a future version of the
JDK, run it with \f[CB]\-\-illegal\-access=deny\f[R] along with any
necessary \f[CB]\-\-add\-opens\f[R] options.
Any remaining illegal\-access errors will most likely be due to static
references from compiled code to JDK\-internal APIs.
You can identify those by running the \f[B]jdeps\f[R] tool with the
\f[CB]\-\-jdk\-internals\f[R] option.
For performance reasons, the current JDK does not issue warnings for
illegal static\-access operations.
.RE
.TP
.B \f[CB]\-Xfuture\f[R]
Enables strict class\-file format checks that enforce close conformance
to the class\-file format specification.
Expand Down Expand Up @@ -4006,6 +4002,42 @@ The default value is 2.
Use the option \f[CB]\-XX:MinRAMPercentage\f[R] instead.
.RE
.TP
.B \f[CB]\-XX:+UseBiasedLocking\f[R]
Enables the use of biased locking.
Some applications with significant amounts of uncontended
synchronization may attain significant speedups with this flag enabled,
but applications with certain patterns of locking may see slowdowns.
.RS
.PP
By default, this option is disabled.
.RE
.SH OBSOLETE JAVA OPTIONS
.PP
These \f[CB]java\f[R] options are still accepted but ignored, and a
warning is issued when they\[aq]re used.
.TP
.B \f[CB]\-XX:+UseMembar\f[R]
Enabled issuing membars on thread\-state transitions.
This option was disabled by default on all platforms except ARM servers,
where it was enabled.
.RS
.RE
.TP
.B \f[CB]\-XX:MaxPermSize=\f[R]\f[I]size\f[R]
Sets the maximum permanent generation space size (in bytes).
This option was deprecated in JDK 8 and superseded by the
\f[CB]\-XX:MaxMetaspaceSize\f[R] option.
.RS
.RE
.TP
.B \f[CB]\-XX:PermSize=\f[R]\f[I]size\f[R]
Sets the space (in bytes) allocated to the permanent generation that
triggers a garbage collection if it\[aq]s exceeded.
This option was deprecated in JDK 8 and superseded by the
\f[CB]\-XX:MetaspaceSize\f[R] option.
.RS
.RE
.TP
.B \f[CB]\-XX:+TraceClassLoading\f[R]
Enables tracing of classes as they are loaded.
By default, this option is disabled and classes aren\[aq]t traced.
Expand Down Expand Up @@ -4053,45 +4085,9 @@ The replacement Unified Logging syntax is
\f[CB]\-Xlog:class+loader+constraints=info\f[R].
See \f[B]Enable Logging with the JVM Unified Logging Framework\f[R].
.RE
.TP
.B \f[CB]\-XX:+UseBiasedLocking\f[R]
Enables the use of biased locking.
Some applications with significant amounts of uncontended
synchronization may attain significant speedups with this flag enabled,
but applications with certain patterns of locking may see slowdowns.
.RS
.PP
By default, this option is disabled.
.RE
.SH OBSOLETE JAVA OPTIONS
.PP
These \f[CB]java\f[R] options are still accepted but ignored, and a
warning is issued when they\[aq]re used.
.TP
.B \f[CB]\-XX:+UseMembar\f[R]
Enabled issuing membars on thread\-state transitions.
This option was disabled by default on all platforms except ARM servers,
where it was enabled.
.RS
.RE
.TP
.B \f[CB]\-XX:MaxPermSize=\f[R]\f[I]size\f[R]
Sets the maximum permanent generation space size (in bytes).
This option was deprecated in JDK 8 and superseded by the
\f[CB]\-XX:MaxMetaspaceSize\f[R] option.
.RS
.RE
.TP
.B \f[CB]\-XX:PermSize=\f[R]\f[I]size\f[R]
Sets the space (in bytes) allocated to the permanent generation that
triggers a garbage collection if it\[aq]s exceeded.
This option was deprecated in JDK 8 and superseded by the
\f[CB]\-XX:MetaspaceSize\f[R] option.
.RS
.RE
.SH REMOVED JAVA OPTIONS
.PP
These \f[CB]java\f[R] options have been removed in JDK 15 and using them
These \f[CB]java\f[R] options have been removed in JDK 16 and using them
results in an error of:
.RS
.PP
Expand Down
2 changes: 1 addition & 1 deletion src/java.base/share/man/keytool.1
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
.\"t
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "KEYTOOL" "1" "2020" "JDK 16" "JDK Commands"
.TH "KEYTOOL" "1" "2021" "JDK 16" "JDK Commands"
.hy
.SH NAME
.PP
Expand Down
2 changes: 1 addition & 1 deletion src/java.rmi/share/man/rmid.1
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "RMID" "1" "2020" "JDK 16" "JDK Commands"
.TH "RMID" "1" "2021" "JDK 16" "JDK Commands"
.hy
.SH NAME
.PP
Expand Down
2 changes: 1 addition & 1 deletion src/java.rmi/share/man/rmiregistry.1
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "RMIREGISTRY" "1" "2020" "JDK 16" "JDK Commands"
.TH "RMIREGISTRY" "1" "2021" "JDK 16" "JDK Commands"
.hy
.SH NAME
.PP
Expand Down
2 changes: 1 addition & 1 deletion src/java.scripting/share/man/jrunscript.1
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JRUNSCRIPT" "1" "2020" "JDK 16" "JDK Commands"
.TH "JRUNSCRIPT" "1" "2021" "JDK 16" "JDK Commands"
.hy
.SH NAME
.PP
Expand Down
2 changes: 1 addition & 1 deletion src/jdk.compiler/share/man/javac.1
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JAVAC" "1" "2020" "JDK 16" "JDK Commands"
.TH "JAVAC" "1" "2021" "JDK 16" "JDK Commands"
.hy
.SH NAME
.PP
Expand Down
2 changes: 1 addition & 1 deletion src/jdk.compiler/share/man/serialver.1
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "SERIALVER" "1" "2020" "JDK 16" "JDK Commands"
.TH "SERIALVER" "1" "2021" "JDK 16" "JDK Commands"
.hy
.SH NAME
.PP
Expand Down
2 changes: 1 addition & 1 deletion src/jdk.hotspot.agent/share/man/jhsdb.1
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JHSDB" "1" "2020" "JDK 16" "JDK Commands"
.TH "JHSDB" "1" "2021" "JDK 16" "JDK Commands"
.hy
.SH NAME
.PP
Expand Down
2 changes: 1 addition & 1 deletion src/jdk.jartool/share/man/jar.1
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JAR" "1" "2020" "JDK 16" "JDK Commands"
.TH "JAR" "1" "2021" "JDK 16" "JDK Commands"
.hy
.SH NAME
.PP
Expand Down
11 changes: 1 addition & 10 deletions src/jdk.jartool/share/man/jarsigner.1
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
.\"t
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JARSIGNER" "1" "2020" "JDK 16" "JDK Commands"
.TH "JARSIGNER" "1" "2021" "JDK 16" "JDK Commands"
.hy
.SH NAME
.PP
Expand Down Expand Up @@ -960,15 +960,6 @@ incurs higher overhead.
.RS
.RE
.TP
.B \f[CB]\-directsign\f[R]
By default, jarsigner stores the hash of the \f[CB]\&.SF\f[R] file and
possibly other information in a SignerInfo signedAttributes field, and
then calculates the signature on this field.
If this option is set, no SignerInfo signedAttributes field is generated
and the signature is calculated on the \f[CB]\&.SF\f[R] file directly.
.RS
.RE
.TP
.B \f[CB]\-sectionsonly\f[R]
If the \f[CB]\-sectionsonly\f[R] option appears on the command line, then
the \f[CB]\&.SF\f[R] file (signature file) generated when a JAR file is
Expand Down
4 changes: 2 additions & 2 deletions src/jdk.javadoc/share/man/javadoc.1
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JAVADOC" "1" "2020" "JDK 16" "JDK Commands"
.TH "JAVADOC" "1" "2021" "JDK 16" "JDK Commands"
.hy
.SH NAME
.PP
Expand Down Expand Up @@ -596,7 +596,7 @@ it does, you must enclose the title in quotation marks.
Additional quotation marks within the \f[CB]title\f[R] tag must be
escaped.
For example,
\f[CB]javadoc\ \-header\ "<b>My\ Library</b><br>v1.0"\ com.mypackage.\f[R]
\f[CB]javadoc\ \-doctitle\ "<b>My\ Library</b><br>v1.0"\ com.mypackage.\f[R]
.RS
.RE
.TP
Expand Down
2 changes: 1 addition & 1 deletion src/jdk.jcmd/share/man/jcmd.1
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JCMD" "1" "2020" "JDK 16" "JDK Commands"
.TH "JCMD" "1" "2021" "JDK 16" "JDK Commands"
.hy
.SH NAME
.PP
Expand Down
2 changes: 1 addition & 1 deletion src/jdk.jcmd/share/man/jinfo.1
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JINFO" "1" "2020" "JDK 16" "JDK Commands"
.TH "JINFO" "1" "2021" "JDK 16" "JDK Commands"
.hy
.SH NAME
.PP
Expand Down
2 changes: 1 addition & 1 deletion src/jdk.jcmd/share/man/jmap.1
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JMAP" "1" "2020" "JDK 16" "JDK Commands"
.TH "JMAP" "1" "2021" "JDK 16" "JDK Commands"
.hy
.SH NAME
.PP
Expand Down
2 changes: 1 addition & 1 deletion src/jdk.jcmd/share/man/jps.1
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
.\"
.\" Automatically generated by Pandoc 2.3.1
.\"
.TH "JPS" "1" "2020" "JDK 16" "JDK Commands"
.TH "JPS" "1" "2021" "JDK 16" "JDK Commands"
.hy
.SH NAME
.PP
Expand Down
Loading

1 comment on commit ed1a775

@openjdk-notifier
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.