Skip to content
This repository was archived by the owner on Sep 19, 2023. It is now read-only.
/ jdk18 Public archive

Commit ed5d53a

Browse files
8273179: Update nroff pages in JDK 18 before RC
Reviewed-by: dholmes
1 parent d40e90b commit ed5d53a

File tree

28 files changed

+712
-410
lines changed

28 files changed

+712
-410
lines changed

src/java.base/share/man/java.1

Lines changed: 46 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
.\"t
2323
.\" Automatically generated by Pandoc 2.3.1
2424
.\"
25-
.TH "JAVA" "1" "2021" "JDK 18\-ea" "JDK Commands"
25+
.TH "JAVA" "1" "2022" "JDK 18" "JDK Commands"
2626
.hy
2727
.SH NAME
2828
.PP
@@ -935,11 +935,11 @@ size of the heap for the young generation, you can use
935935
.RE
936936
.TP
937937
.B \f[CB]\-Xms\f[R] \f[I]size\f[R]
938-
Sets the minimum and initial size (in bytes) of the heap.
938+
Sets the minimum and the initial size (in bytes) of the heap.
939939
This value must be a multiple of 1024 and greater than 1 MB.
940940
Append the letter \f[CB]k\f[R] or \f[CB]K\f[R] to indicate kilobytes,
941-
\f[CB]m\f[R] or \f[CB]M\f[R] to indicate megabytes, \f[CB]g\f[R] or \f[CB]G\f[R]
942-
to indicate gigabytes.
941+
\f[CB]m\f[R] or \f[CB]M\f[R] to indicate megabytes, or \f[CB]g\f[R] or
942+
\f[CB]G\f[R] to indicate gigabytes.
943943
The following examples show how to set the size of allocated memory to 6
944944
MB using various units:
945945
.RS
@@ -952,14 +952,17 @@ MB using various units:
952952
\f[R]
953953
.fi
954954
.PP
955-
Instead of the \f[CB]\-Xms\f[R] option to set both the minimum and initial
956-
size of the heap, you can use \f[CB]\-XX:MinHeapSize\f[R] to set the
957-
minimum size and \f[CB]\-XX:InitialHeapSize\f[R] to set the initial size.
958-
.PP
959-
If you don\[aq]t set this option, the initial size is set as the sum of
960-
the sizes allocated for the old generation and the young generation.
955+
If you do not set this option, then the initial size will be set as the
956+
sum of the sizes allocated for the old generation and the young
957+
generation.
961958
The initial size of the heap for the young generation can be set using
962959
the \f[CB]\-Xmn\f[R] option or the \f[CB]\-XX:NewSize\f[R] option.
960+
.PP
961+
Note that the \f[CB]\-XX:InitialHeapSize\f[R] option can also be used to
962+
set the initial heap size.
963+
If it appears after \f[CB]\-Xms\f[R] on the command line, then the initial
964+
heap size gets set to the value specified with
965+
\f[CB]\-XX:InitialHeapSize\f[R].
963966
.RE
964967
.TP
965968
.B \f[CB]\-Xmx\f[R] \f[I]size\f[R]
@@ -1366,7 +1369,7 @@ By default this option is disabled.
13661369
.RS
13671370
.RE
13681371
.TP
1369-
.B \f[CB]\-XX:FlightRecorderOptions=\f[R]\f[I]parameter\f[R]\f[CB]=\f[R]\f[I]value\f[R] (or)\f[CB]\-XX:FlightRecorderOptions:\f[R]\f[I]parameter\f[R]\f[CB]=\f[R]\f[I]value\f[R]
1372+
.B \f[CB]\-XX:FlightRecorderOptions=\f[R]\f[I]parameter\f[R]\f[CB]=\f[R]\f[I]value\f[R] (or) \f[CB]\-XX:FlightRecorderOptions:\f[R]\f[I]parameter\f[R]\f[CB]=\f[R]\f[I]value\f[R]
13701373
Sets the parameters that control the behavior of JFR.
13711374
.RS
13721375
.PP
@@ -1640,7 +1643,7 @@ Specifies the path and name of the class data sharing (CDS) archive file
16401643
See \f[B]Application Class Data Sharing\f[R].
16411644
.RE
16421645
.TP
1643-
.B \f[CB]\-XX:SharedArchiveConfigFile\f[R]=\f[I]shared_config_file\f[R]
1646+
.B \f[CB]\-XX:SharedArchiveConfigFile=\f[R]\f[I]shared_config_file\f[R]
16441647
Specifies additional shared data added to the archive file.
16451648
.RS
16461649
.RE
@@ -1747,9 +1750,6 @@ written when the recording is stopped, for example:
17471750
\f[CB]/home/user/recordings/recording.jfr\f[R]
17481751
.IP \[bu] 2
17491752
\f[CB]c:\\recordings\\recording.jfr\f[R]
1750-
.PP
1751-
If \f[CB]%p\f[R] and/or \f[CB]%t\f[R] is specified in the filename, it expands to the JVM\[aq]s
1752-
PID and the current timestamp, respectively.
17531753
.RE
17541754
.TP
17551755
.B \f[CB]name=\f[R]\f[I]identifier\f[R]
@@ -1825,10 +1825,10 @@ To list available options, use the \f[CB]JAVA_HOME\f[R]/bin/jfr tool.
18251825
.RS
18261826
.RE
18271827
.TP
1828-
.B \f[CB]event\-setting\f[R]=\f[I]value\f[R]
1828+
.B \f[CB]event\-setting=\f[R]\f[I]value\f[R]
18291829
Specifies the event setting value to modify.
1830-
Use the form: #= To add a new event setting, prefix the event name with
1831-
\[aq]+\[aq].
1830+
Use the form: \f[CB]<event\-name>#<setting\-name>=<value>\f[R].
1831+
To add a new event setting, prefix the event name with \[aq]+\[aq].
18321832
.RS
18331833
.RE
18341834
.PP
@@ -2591,23 +2591,19 @@ The \f[CB]\-XX:UseRTMLocking\f[R] option must be enabled.
25912591
.RE
25922592
.TP
25932593
.B \f[CB]\-XX:+SegmentedCodeCache\f[R]
2594-
Enables segmentation of the code cache.
2595-
Without the \f[CB]\-XX:+SegmentedCodeCache\f[R], the code cache consists
2596-
of one large segment.
2597-
With \f[CB]\-XX:+SegmentedCodeCache\f[R], we have separate segments for
2598-
nonmethod, profiled method, and nonprofiled method code.
2599-
These segments aren\[aq]t resized at runtime.
2600-
The feature is enabled by default if tiered compilation is enabled
2601-
(\f[CB]\-XX:+TieredCompilation\f[R] ) and
2602-
\f[CB]\-XX:ReservedCodeCacheSize\f[R] >= 240 MB.
2594+
Enables segmentation of the code cache, without which the code cache
2595+
consists of one large segment.
2596+
With \f[CB]\-XX:+SegmentedCodeCache\f[R], separate segments will be used
2597+
for non\-method, profiled method, and non\-profiled method code.
2598+
The segments are not resized at runtime.
26032599
The advantages are better control of the memory footprint, reduced code
2604-
fragmentation, and better iTLB/iCache behavior due to improved locality.
2605-
iTLB/iCache is a CPU\-specific term meaning Instruction Translation
2606-
Lookaside Buffer (ITLB).
2607-
ICache is an instruction cache in theCPU.
2608-
The implementation of the code cache can be found in the file:
2609-
\f[CB]/share/vm/code/codeCache.cpp\f[R].
2600+
fragmentation, and better CPU iTLB (instruction translation lookaside
2601+
buffer) and instruction cache behavior due to improved locality.
26102602
.RS
2603+
.PP
2604+
The feature is enabled by default if tiered compilation is enabled
2605+
(\f[CB]\-XX:+TieredCompilation\f[R] ) and the reserved code cache size
2606+
(\f[CB]\-XX:ReservedCodeCacheSize\f[R]) is at least 240 MB.
26112607
.RE
26122608
.TP
26132609
.B \f[CB]\-XX:StartAggressiveSweepingAt=\f[R]\f[I]percent\f[R]
@@ -2639,16 +2635,17 @@ Is set by default to the highest supported version available (x86 only).
26392635
Enables hardware\-based AES intrinsics for hardware that supports it.
26402636
This option is on by default on hardware that has the necessary
26412637
instructions.
2642-
The \f[CB]\-XX:+UseAES\f[R] is used in conjunction with UseAESIntrinsics.
2638+
The \f[CB]\-XX:+UseAES\f[R] is used in conjunction with
2639+
\f[CB]UseAESIntrinsics\f[R].
26432640
Flags that control intrinsics now require the option
26442641
\f[CB]\-XX:+UnlockDiagnosticVMOptions\f[R].
26452642
.RS
26462643
.RE
26472644
.TP
26482645
.B \f[CB]\-XX:+UseAESIntrinsics\f[R]
26492646
Enables AES intrinsics.
2650-
Specifying\f[CB]\-XX:+UseAESIntrinsics\f[R] is equivalent to also enabling
2651-
\f[CB]\-XX:+UseAES\f[R].
2647+
Specifying \f[CB]\-XX:+UseAESIntrinsics\f[R] is equivalent to also
2648+
enabling \f[CB]\-XX:+UseAES\f[R].
26522649
To disable hardware\-based AES intrinsics, specify
26532650
\f[CB]\-XX:\-UseAES\ \-XX:\-UseAESIntrinsics\f[R].
26542651
For example, to enable hardware AES, use the following flags:
@@ -2844,7 +2841,7 @@ The default value is 1,000.
28442841
.RS
28452842
.RE
28462843
.TP
2847-
.B \f[CB]\-XX:LoopStripMiningIterShortLoop\f[R]=\f[I]number_of_iterations\f[R]
2844+
.B \f[CB]\-XX:LoopStripMiningIterShortLoop=\f[R]\f[I]number_of_iterations\f[R]
28482845
Controls loop strip mining optimization.
28492846
Loops with the number of iterations less than specified will not have
28502847
safepoints in them.
@@ -2971,7 +2968,7 @@ an \f[CB]OutOfMemoryError\f[R] exception is thrown.
29712968
.RS
29722969
.RE
29732970
.TP
2974-
.B \f[CB]\-XX:HeapDumpPath=path\f[R]
2971+
.B \f[CB]\-XX:HeapDumpPath=\f[R]\f[I]path\f[R]
29752972
Sets the path and file name for writing the heap dump provided by the
29762973
heap profiler (HPROF) when the \f[CB]\-XX:+HeapDumpOnOutOfMemoryError\f[R]
29772974
option is set.
@@ -3165,7 +3162,7 @@ The default value is 3.
31653162
.RS
31663163
.RE
31673164
.TP
3168-
.B \f[CB]\-XX:G1HeapRegionSize=size\f[R]
3165+
.B \f[CB]\-XX:G1HeapRegionSize=\f[R]\f[I]size\f[R]
31693166
Sets the size of the regions into which the Java heap is subdivided when
31703167
using the garbage\-first (G1) collector.
31713168
The value is a power of 2 and can range from 1 MB to 32 MB.
@@ -3294,6 +3291,11 @@ If you set this option to 0, then the initial size is set as the sum of
32943291
the sizes allocated for the old generation and the young generation.
32953292
The size of the heap for the young generation can be set using the
32963293
\f[CB]\-XX:NewSize\f[R] option.
3294+
Note that the \f[CB]\-Xms\f[R] option sets both the minimum and the
3295+
initial heap size of the heap.
3296+
If \f[CB]\-Xms\f[R] appears after \f[CB]\-XX:InitialHeapSize\f[R] on the
3297+
command line, then the initial heap size gets set to the value specified
3298+
with \f[CB]\-Xms\f[R].
32973299
.RE
32983300
.TP
32993301
.B \f[CB]\-XX:InitialRAMPercentage=\f[R]\f[I]percent\f[R]
@@ -3895,7 +3897,7 @@ Supports heap sizes from 8MB to 16TB.
38953897
.RS
38963898
.RE
38973899
.TP
3898-
.B \f[CB]\-XX:ZAllocationSpikeTolerance\f[R]=\f[I]factor\f[R]
3900+
.B \f[CB]\-XX:ZAllocationSpikeTolerance=\f[R]\f[I]factor\f[R]
38993901
Sets the allocation spike tolerance for ZGC.
39003902
By default, this option is set to 2.0.
39013903
This factor describes the level of allocation spikes to expect.
@@ -3904,14 +3906,14 @@ be expected to triple at any time.
39043906
.RS
39053907
.RE
39063908
.TP
3907-
.B \f[CB]\-XX:ZCollectionInterval\f[R]=\f[I]seconds\f[R]
3909+
.B \f[CB]\-XX:ZCollectionInterval=\f[R]\f[I]seconds\f[R]
39083910
Sets the maximum interval (in seconds) between two GC cycles when using
39093911
ZGC.
39103912
By default, this option is set to 0 (disabled).
39113913
.RS
39123914
.RE
39133915
.TP
3914-
.B \f[CB]\-XX:ZFragmentationLimit\f[R]=\f[I]percent\f[R]
3916+
.B \f[CB]\-XX:ZFragmentationLimit=\f[R]\f[I]percent\f[R]
39153917
Sets the maximum acceptable heap fragmentation (in percent) for ZGC.
39163918
By default, this option is set to 25.
39173919
Using a lower value will cause the heap to be compacted more
@@ -3939,7 +3941,7 @@ JVM, and make that memory available for other processes to use.
39393941
.RS
39403942
.RE
39413943
.TP
3942-
.B \f[CB]\-XX:ZUncommitDelay\f[R]=\f[I]seconds\f[R]
3944+
.B \f[CB]\-XX:ZUncommitDelay=\f[R]\f[I]seconds\f[R]
39433945
Sets the amount of time (in seconds) that heap memory must have been
39443946
unused before being uncommitted.
39453947
By default, this option is set to 300 (5 minutes).
@@ -4231,7 +4233,7 @@ In the argument file,
42314233
.nf
42324234
\f[CB]
42334235
\-cp\ "/lib/cool\\
4234-
\\app/jars???
4236+
\\app/jars"
42354237
\f[R]
42364238
.fi
42374239
.PP

src/java.base/share/man/keytool.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
.\"t
2323
.\" Automatically generated by Pandoc 2.3.1
2424
.\"
25-
.TH "KEYTOOL" "1" "2021" "JDK 18\-ea" "JDK Commands"
25+
.TH "KEYTOOL" "1" "2022" "JDK 18" "JDK Commands"
2626
.hy
2727
.SH NAME
2828
.PP

src/java.rmi/share/man/rmiregistry.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
.\"
2222
.\" Automatically generated by Pandoc 2.3.1
2323
.\"
24-
.TH "RMIREGISTRY" "1" "2021" "JDK 18\-ea" "JDK Commands"
24+
.TH "RMIREGISTRY" "1" "2022" "JDK 18" "JDK Commands"
2525
.hy
2626
.SH NAME
2727
.PP

src/java.scripting/share/man/jrunscript.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
.\"
2222
.\" Automatically generated by Pandoc 2.3.1
2323
.\"
24-
.TH "JRUNSCRIPT" "1" "2021" "JDK 18\-ea" "JDK Commands"
24+
.TH "JRUNSCRIPT" "1" "2022" "JDK 18" "JDK Commands"
2525
.hy
2626
.SH NAME
2727
.PP

src/jdk.compiler/share/man/javac.1

Lines changed: 14 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
.\"
2222
.\" Automatically generated by Pandoc 2.3.1
2323
.\"
24-
.TH "JAVAC" "1" "2021" "JDK 18\-ea" "JDK Commands"
24+
.TH "JAVAC" "1" "2022" "JDK 18" "JDK Commands"
2525
.hy
2626
.SH NAME
2727
.PP
@@ -681,43 +681,28 @@ Selects a diagnostic mode.
681681
.RE
682682
.TP
683683
.B \f[CB]\-Xdoclint\f[R]
684-
Enables recommended checks for problems in \f[CB]javadoc\f[R] comments
684+
Enables recommended checks for problems in documentation comments.
685685
.RS
686686
.RE
687687
.TP
688688
.B \f[CB]\-Xdoclint:\f[R](\f[CB]all\f[R]|\f[CB]none\f[R]|[\f[CB]\-\f[R]]\f[I]group\f[R])[\f[CB]/\f[R]\f[I]access\f[R]]
689-
Enables or disables specific groups of checks,
689+
Enables or disables specific groups of checks in documentation comments.
690690
.RS
691691
.PP
692692
\f[I]group\f[R] can have one of the following values:
693-
.IP \[bu] 2
694-
\f[CB]accessibility\f[R]
695-
.IP \[bu] 2
696-
\f[CB]html\f[R]
697-
.IP \[bu] 2
698-
\f[CB]missing\f[R]
699-
.IP \[bu] 2
700-
\f[CB]reference\f[R]
701-
.IP \[bu] 2
702-
\f[CB]syntax\f[R]
693+
\f[CB]accessibility\f[R], \f[CB]html\f[R], \f[CB]missing\f[R],
694+
\f[CB]reference\f[R], \f[CB]syntax\f[R]
703695
.PP
704696
The variable \f[I]access\f[R] specifies the minimum visibility level of
705697
classes and members that the \f[CB]\-Xdoclint\f[R] option checks.
706698
It can have one of the following values (in order of most to least
707-
visible):
708-
.IP \[bu] 2
709-
\f[CB]public\f[R]
710-
.IP \[bu] 2
711-
\f[CB]protected\f[R]
712-
.IP \[bu] 2
713-
\f[CB]package\f[R]
714-
.IP \[bu] 2
715-
\f[CB]private\f[R]
699+
visible): \f[CB]public\f[R], \f[CB]protected\f[R], \f[CB]package\f[R],
700+
\f[CB]private\f[R].
716701
.PP
717702
The default \f[I]access\f[R] level is \f[CB]private\f[R].
718703
.PP
719704
For more information about these groups of checks, see the
720-
\f[CB]\-Xdoclint\f[R] option of the \f[CB]javadoc\f[R] command.
705+
\f[B]DocLint\f[R] section of the \f[CB]javadoc\f[R] command documentation.
721706
The \f[CB]\-Xdoclint\f[R] option is disabled by default in the
722707
\f[CB]javac\f[R] command.
723708
.PP
@@ -747,6 +732,9 @@ sub\-packages of the given package.
747732
Each \f[I]package\f[R] can be prefixed with a hyphen (\f[CB]\-\f[R]) to
748733
disable checks for a specified package or packages.
749734
.RS
735+
.PP
736+
For more information, see the \f[B]DocLint\f[R] section of the
737+
\f[CB]javadoc\f[R] command documentation.
750738
.RE
751739
.TP
752740
.B \f[CB]\-Xlint\f[R]
@@ -1047,7 +1035,7 @@ Create a file named \f[CB]options\f[R] that contains the following:
10471035
\f[R]
10481036
.fi
10491037
.PP
1050-
Create a file named \f[CB]classes\f[R] that contains the following:
1038+
Create a file named \f[CB]sources\f[R] that contains the following:
10511039
.IP
10521040
.nf
10531041
\f[CB]
@@ -1060,7 +1048,7 @@ MyClass3.java
10601048
Then, run the \f[CB]javac\f[R] command as follows:
10611049
.RS
10621050
.PP
1063-
\f[CB]javac\ \@options\ \@classes\f[R]
1051+
\f[CB]javac\ \@options\ \@sources\f[R]
10641052
.RE
10651053
.RE
10661054
.TP
@@ -1071,7 +1059,7 @@ are relative to the current working directory (not \f[CB]path1\f[R] or
10711059
.RS
10721060
.RS
10731061
.PP
1074-
\f[CB]javac\ \@path1/options\ \@path2/classes\f[R]
1062+
\f[CB]javac\ \@path1/options\ \@path2/sources\f[R]
10751063
.RE
10761064
.RE
10771065
.SH ARRANGEMENT OF SOURCE CODE

src/jdk.compiler/share/man/serialver.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
.\"
2222
.\" Automatically generated by Pandoc 2.3.1
2323
.\"
24-
.TH "SERIALVER" "1" "2021" "JDK 18\-ea" "JDK Commands"
24+
.TH "SERIALVER" "1" "2022" "JDK 18" "JDK Commands"
2525
.hy
2626
.SH NAME
2727
.PP

src/jdk.hotspot.agent/share/man/jhsdb.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
.\"
2222
.\" Automatically generated by Pandoc 2.3.1
2323
.\"
24-
.TH "JHSDB" "1" "2021" "JDK 18\-ea" "JDK Commands"
24+
.TH "JHSDB" "1" "2022" "JDK 18" "JDK Commands"
2525
.hy
2626
.SH NAME
2727
.PP

src/jdk.httpserver/share/man/jwebserver.1

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,27 @@
1+
.\" Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
2+
.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3+
.\"
4+
.\" This code is free software; you can redistribute it and/or modify it
5+
.\" under the terms of the GNU General Public License version 2 only, as
6+
.\" published by the Free Software Foundation.
7+
.\"
8+
.\" This code is distributed in the hope that it will be useful, but WITHOUT
9+
.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10+
.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
11+
.\" version 2 for more details (a copy is included in the LICENSE file that
12+
.\" accompanied this code).
13+
.\"
14+
.\" You should have received a copy of the GNU General Public License version
15+
.\" 2 along with this work; if not, write to the Free Software Foundation,
16+
.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
17+
.\"
18+
.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
19+
.\" or visit www.oracle.com if you need additional information or have any
20+
.\" questions.
21+
.\"
122
.\" Automatically generated by Pandoc 2.3.1
223
.\"
3-
.TH "JWEBSERVER" "1" "2021" "JDK 18\-internal" "JDK Commands"
24+
.TH "JWEBSERVER" "1" "2022" "JDK 18" "JDK Commands"
425
.hy
526
.SH NAME
627
.PP

0 commit comments

Comments
 (0)