Update description in help message and in manpage

openjdk · Aug 25, 2021 · 19bc58c · 19bc58c
1 parent 55ee9cf
commit 19bc58c
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 8 deletions.
diff --git a/src/hotspot/share/logging/logConfiguration.cpp b/src/hotspot/share/logging/logConfiguration.cpp
@@ -570,11 +570,13 @@ void LogConfiguration::print_command_line_help(outputStream* out) {
   out->print_cr("   filecount=..      - Number of files to keep in rotation (not counting the active file)."
                                          " If set to 0, log rotation is disabled."
                                          " This will cause existing log files to be overwritten.");
-  out->print_cr("   foldmultilines=.. - The switch to replace newline characters with multiline log event"
-                                         " with the character sequence."
-                                         " Escape newline (\\n) and backslash (\\) characters in the UL output"
-                                         " if it is set to true."
-                                         " Note that it works on file output only.");
+  out->print_cr("   foldmultilines=.. - If set to true, a log event that consists of multiple lines"
+                                         " will be folded into a single line by replacing newline characters"
+                                         " with the sequence '\\' and 'n' in the output."
+                                         " Existing single backslash characters will also be replaced"
+                                         " with a sequence of two backslashes so that the conversion can be reversed."
+                                         " This option is safe to use with UTF-8 character encodings,"
+                                         " but other encodings may not work.");
 
   out->cr();
   out->print_cr("\nAsynchronous logging (off by default):");

diff --git a/src/java.base/share/man/java.1 b/src/java.base/share/man/java.1
@@ -4422,9 +4422,8 @@ selected.
 with optional K, M or G suffix>\f[R] \f[CB]foldmultilines=\f[R]\f[I]<true|false>\f[R]
 .RE
 .PP
-\f[I]foldmultilines\f[R] enables to replace newline characters within
-a multiline log event with the character sequence '\\' and 'n'.
-Note that it works on file output only.
+When \f[I]foldmultilines\f[R] is true, a log event that consists of multiple lines will be folded into a single line by replacing newline characters with the sequence '\\' and 'n' in the output. Existing single backslash characters will also be replaced with a sequence of two backslashes so that the conversion can be reversed. This option is safe to use with UTF-8 character encodings, but other encodings may not work. For example, it may happen inadvertently conversion in multi-byte sequences in Shift JIS and BIG5.
+This option is available only for file outputs.
 .RE
 .RE
 .SS Default Configuration