Skip to content

Commit 8325078

Browse files
egahlinpull[bot]
authored andcommitted
8335479: JFR: Missing documentation for -XX:StartFlightRecording
Reviewed-by: mgronlun
1 parent b7747c2 commit 8325078

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

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

+8-1
Original file line numberDiff line numberDiff line change
@@ -1710,10 +1710,12 @@ This prevents the JVM from exiting and keeps the process active so that
17101710
you can attach a debugger to it to investigate the cause of the error.
17111711
By default, this option is disabled.
17121712
.TP
1713-
\f[V]-XX:StartFlightRecording=\f[R]\f[I]parameter\f[R]\f[V]=\f[R]\f[I]value\f[R]
1713+
\f[V]-XX:StartFlightRecording:\f[R]\f[I]parameter\f[R]\f[V]=\f[R]\f[I]value\f[R]
17141714
Starts a JFR recording for the Java application.
17151715
This option is equivalent to the \f[V]JFR.start\f[R] diagnostic command
17161716
that starts a recording during runtime.
1717+
\f[V]-XX:StartFlightRecording:help\f[R] prints available options and
1718+
example command lines.
17171719
You can set the following \f[I]parameter\f[R]\f[V]=\f[R]\f[I]value\f[R]
17181720
entries when starting a JFR recording:
17191721
.RS
@@ -1760,6 +1762,8 @@ written when the recording is stopped, for example:
17601762
.PP
17611763
If %p and/or %t is specified in the filename, it expands to the
17621764
JVM\[aq]s PID and the current timestamp, respectively.
1765+
The filename may also be a directory in which case, the filename is
1766+
generated from the PID and the current date in the specified directory.
17631767
.RE
17641768
.TP
17651769
\f[V]name=\f[R]\f[I]identifier\f[R]
@@ -1840,6 +1844,9 @@ The whitespace delimiter can be omitted for timespan values, i.e.
18401844
20ms.
18411845
For more information about the settings syntax, see Javadoc of the
18421846
jdk.jfr package.
1847+
.PP
1848+
To only see warnings and errors from JFR during startup set
1849+
-Xlog:jfr+startup=warning.
18431850
.RE
18441851
.TP
18451852
\f[V]-XX:ThreadStackSize=\f[R]\f[I]size\f[R]

0 commit comments

Comments
 (0)