New upstream version 20220613

[perltidy.git] / docs / ChangeLog.html

diff --git a/docs/ChangeLog.html b/docs/ChangeLog.html
index 41581cc03e9bcd563bc53b071fd30824ea9d557d..90acabb91760022156edbdd57c14fa8b6f44d017 100644 (file)
--- a/docs/ChangeLog.html
+++ b/docs/ChangeLog.html
@@ -1,5 +1,61 @@
 <h1>Perltidy Change Log</h1>
 
+<h2>2022 06 13</h2>
+
+<pre><code>- No significant bugs have been found since the last release but users
+  of programs which call the Perl::Tidy module should note the first
+  item below, which changes a default setting.  The main change to
+  existing formatting is the second item below, which adds vertical
+  alignment to 'use' statements.
+
+- The flag --encode-output-strings, or -eos, is now set 'on' by default.
+  This has no effect on the use of the 'perltidy' binary script, but could
+  change the behavior of some programs which use the Perl::Tidy module on
+  files encoded in UTF-8.  If any problems are noticed, an emergency fix
+  can be made by reverting to the old default by setting -neos.  For
+  an explanation of why this change needs to be made see:
+
+  https://github.com/perltidy/perltidy/issues/92
+
+  https://github.com/perltidy/perltidy/blob/master/docs/eos_flag.md
+
+- Added vertical alignment for qw quotes and empty parens in 'use'
+  statements (see issue #git 93).  This new alignment is 'on' by default
+  and will change formatting as shown below. If this is not wanted it can
+  be turned off with the parameter -vxl='q' (--valign-exclude-list='q').
+
+    # old default, or -vxl='q'
+    use Getopt::Long qw(GetOptions);
+    use Fcntl qw(O_RDONLY O_WRONLY O_EXCL O_CREAT);
+    use Symbol qw(gensym);
+    use Exporter ();
+
+    # new default
+    use Getopt::Long qw(GetOptions);
+    use Fcntl        qw(O_RDONLY O_WRONLY O_EXCL O_CREAT);
+    use Symbol       qw(gensym);
+    use Exporter     ();
+
+- The parameter -kbb (--keep-break-before) now ignores a request to break
+  before an opening token, such as '('.  Likewise, -kba (--keep-break-after)
+  now ignores a request to break after a closing token, such as ')'. This
+  change was made to avoid a rare instability discovered in random testing.
+
+- Previously, if a -dsc command was used to delete all side comments,
+  then any special side comments for controlling non-indenting braces got
+  deleted too. Now, these control side comments are retained when -dsc is
+  set unless a -nnib (--nonon-indenting-braces) flag is also set to
+  deactivate them.
+
+- This version runs about 10 percent faster on large files than the previous
+  release due to optimizations made with the help of Devel::NYTProf.  Much
+  of the gain came from faster processing of blank tokens and comments.
+
+- This version of perltidy was stress-tested for many cpu hours with
+  random input parameters. No failures to converge, internal fault checks,
+  undefined variable references or other irregularities were seen.
+</code></pre>
+
 <h2>2022 02 17</h2>
 
 <pre><code>- A new flag, --encode-output-strings, or -eos, has been added to resolve