New upstream version 20220613

[perltidy.git] / CHANGES.md

diff --git a/CHANGES.md b/CHANGES.md
index 41e92d60b655f3dd0fa29623a937630566c09fe7..2a8a11ee06d6ade482b9b915f636e5a9a3a671b5 100644 (file)
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -1,5 +1,60 @@
 # Perltidy Change Log
 
+## 2022 06 13
+
+    - 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.
+
 ## 2022 02 17
 
     - A new flag, --encode-output-strings, or -eos, has been added to resolve