RFR: 8218997: Xusage text, man help, etc doesn't mention -Xlog option.

[Henry Jen]

Good suggestion, didn’t know about that page. I took what’s in Xusage.txt. Updated as following,

diff -r cd3eeeec74c0 src/java.base/share/classes/sun/launcher/resources/launcher.properties
--- a/src/java.base/share/classes/sun/launcher/resources/launcher.properties    Tue May 21 15:08:50 2019 -0700
+++ b/src/java.base/share/classes/sun/launcher/resources/launcher.properties    Tue May 21 16:38:42 2019 -0700
@@ -138,6 +138,9 @@
 \    -Xinternalversion\n\
 \                      displays more detailed JVM version information than the\n\
 \                      -version option\n\
+\    -Xlog:<opts>      Configure or enable logging with the Java Virtual\n\
+\                      Machine (JVM) unified logging framework. Use -Xlog:help\n\
+\                      for details.\n\
 \    -Xloggc:<file>    log GC status to a file with time stamps\n\
 \    -Xmixed           mixed mode execution (default)\n\
 \    -Xmn<size>        sets the initial and maximum size (in bytes) of the heap\n\
diff -r cd3eeeec74c0 src/java.base/share/man/java.1
--- a/src/java.base/share/man/java.1    Tue May 21 15:08:50 2019 -0700
+++ b/src/java.base/share/man/java.1    Tue May 21 16:38:42 2019 -0700
@@ -732,6 +732,11 @@
 option, and then exits\&.
 .RE
 .PP
+\-Xlog:\fIopts\fR
+.RS 4
+Configure or enable logging with the Java Virtual Machine (JVM) unified logging framework. Use \fB\-Xlog:help\fR for details.
+.RE
+.PP
 \-Xloggc:\fIfilename\fR
 .RS 4
 Sets the file to which verbose GC events information should be redirected for logging\&. The information written to this file is similar to the output of


Cheers,
Henry


> On May 21, 2019, at 4:11 PM, David Holmes <david.holmes at oracle.com> wrote:
> 
> Hi Henry,
> 
> On 22/05/2019 8:41 am, Henry Jen wrote:
>> Hi,
>> Please review a trivial patch that add some hints about how to use -Xlog in java help and man page.
>> diff -r cd3eeeec74c0 src/java.base/share/classes/sun/launcher/resources/launcher.properties
>> --- a/src/java.base/share/classes/sun/launcher/resources/launcher.properties    Tue May 21 15:08:50 2019 -0700
>> +++ b/src/java.base/share/classes/sun/launcher/resources/launcher.properties    Tue May 21 15:31:52 2019 -0700
>> @@ -138,6 +138,7 @@
>>  \    -Xinternalversion\n\
>>  \                      displays more detailed JVM version information than the\n\
>>  \                      -version option\n\
>> +\    -Xlog:<opts>      control JVM logging, use -Xlog:help for details
> 
> I would suggest using the same words as used in the online tool reference page [1]:
> 
> Configure or enable logging with the Java Virtual Machine (JVM) unified logging framework. Use -Xlog:help for details.
> 
> Ditto for the man page.
> 
> Cheers,
> David
> 
> [1] https://docs.oracle.com/en/java/javase/12/tools/java.html#GUID-3B1CE181-CD30-4178-9602-230B800D4FAE
> 
>>  \    -Xloggc:<file>    log GC status to a file with time stamps\n\
>>  \    -Xmixed           mixed mode execution (default)\n\
>>  \    -Xmn<size>        sets the initial and maximum size (in bytes) of the heap\n\
>> diff -r cd3eeeec74c0 src/java.base/share/man/java.1
>> --- a/src/java.base/share/man/java.1    Tue May 21 15:08:50 2019 -0700
>> +++ b/src/java.base/share/man/java.1    Tue May 21 15:31:52 2019 -0700
>> @@ -732,6 +732,11 @@
>>  option, and then exits\&.
>>  .RE
>>  .PP
>> +\-Xlog:\fIopts\fR
>> +.RS 4
>> +Control JVM logging, use \fB\-Xlog:help\fR for details.
>> +.RE
>> +.PP
>>  \-Xloggc:\fIfilename\fR
>>  .RS 4
>>  Sets the file to which verbose GC events information should be redirected for logging\&. The information written to this file is similar to the output of
>> Cheers,
>> Henry