update docs concerning change to default --nouse-unicode-gcstring

diff --git a/CHANGES.md b/CHANGES.md
index c9381b720c3e4abb253e9f71cc390b0a357d3d26..4d765afea2139b59a4c11f810c55874cb03abdeb 100644 (file)
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -2,6 +2,9 @@
 
 ## 2020 01 10.01
 
+    - Fixed minor problem where trailing 'unless' clauses were not 
+      getting vertically aligned.
+
     - Added a parameter --logical-padding or -lop to allow logical padding
       to be turned off.  Requested by git #29. This flag is on by default.
       The man pages have examples.
@@ -21,14 +24,15 @@
       in RT#131644.  This flag will keep lines beginning with a semicolon.
 
     - Added --use-unicode-gcstring to control use of Unicode::GCString for
-      evaluating character widths of encoded data.  By default, for encoded files
-      perltidy will now look for Unicode::GCString and, if found, will use it 
+      evaluating character widths of encoded data.  The default is 
+      not to use this (--nouse-unicode-gcstring). If this flag is set,
+      perltidy will look for Unicode::GCString and, if found, will use it 
       to evaluate character display widths.  This can improve displayed
-      vertical alignment for files with wide characters. This flag is mainly intended
-      for testing, but can also prevent the use of this module in the event that some
-      unforseen issue arises.  Perltidy installation does not require
-      Unicode::GCString, so users wanting to use this feature need to install it
-      separately.
+      vertical alignment for files with wide characters.  It is a nice
+      feature but it is off by default to avoid conflicting formatting
+      when there are multiple developers.  Perltidy installation does not 
+      require Unicode::GCString, so users wanting to use this feature need 
+      set this flag and also to install Unicode::GCString separately.
 
     - Added --character-encoding=guess or -guess to have perltidy guess
       if a file (or other input stream) is encoded as -utf8 or some 
@@ -42,12 +46,12 @@
       which is included in standard perl distributions, and only tries to 
       guess if a file is utf8 or not, never any other encoding.  If the guess is 
       utf8, and if the file successfully decodes as utf8, then it the encoding 
-      is assumed to be utf8.  Otherwise, no encoding is assumed.
-      I have done extensive testing and have not detected any problems with
-      this guess method. If you do not want to use this new default guess mode,
-      or have a problem with it, you can set --character-encoding=none 
-      (the previous default) or --character-encoding=utf8 (if you deal
-      with utf8 files).
+      is assumed to be utf8.  Otherwise, no encoding is assumed.  I have done
+      extensive testing and have not detected any problems with this 
+      rather conservative guess method, so I think it is a good default. 
+      If you do not want to use this new default guess mode, or have a 
+      problem with it, you can set --character-encoding=none (the previous 
+      default) or --character-encoding=utf8 (if you deal with utf8 files).
 
     - Specific encodings of input files other than utf8 may now be given, for
       example --character-encoding=euc-jp.  

diff --git a/bin/perltidy b/bin/perltidy
index e3160f5a53b0ceec714a2c34149dd7c82a762874..8fadcab158320f0e05be3b61a4b93fd516f4269d 100755 (executable)
--- a/bin/perltidy
+++ b/bin/perltidy
@@ -632,21 +632,21 @@ B<utf8>.
 
 =item B<-gcs>,  B<--use-unicode-gcstring>
 
-This flag controls whether or not perltidy may use module Unicode::GCString.
-It has no effect if that module is not installed on a system.
-If text is encoded then perltidy will by default use the module
-Unicode::GCString to determine the horizontal widths of the text, provided
-Unicode::GCString is available.  This is needed to produce formatted text with
-good vertical alignment when there are wide characters. If the module is not
-available on the system, or if the flag B<--nouse-unicode-gcstring> or B<ngcs>
-has been set, then this module will not be used and characters will have an
-assumed display width of 1.  In this case, vertical alignment may be poor if
-code contains a mixture of wide and normal characters.  The default setting is
-B<--use-unicode-gcstring>.   This flag is mainly intended for testing, and as a
-workaround in case a problem arises with the Unicode::GCString module.
-
-Perltidy installation does not require Unicode::GCString, so users wanting
-to use this feature need to install it separately.
+This flag controls whether or not perltidy may use module Unicode::GCString to
+obtain accurate display widths of wide characters.  The default 
+is B<--nouse-unicode-gcstring>.
+
+If this flag is set, and text is encoded, perltidy will look for the module
+Unicode::GCString and, if found, will use it to obtain character display
+widths.  This can improve displayed vertical alignment for files with wide
+characters.  It is a nice feature but it is off by default to avoid conflicting
+formatting when there are multiple developers.  Perltidy installation does not
+require Unicode::GCString, so users wanting to use this feature need set this
+flag and also to install Unicode::GCString separately.
+
+If this flag is set and perltidy does not find module Unicode::GCString,
+a warning message will be produced and processing will continue but without
+the potential benefit provided by the module.
 
 Also note that actual vertical alignment depends upon the fonts used by the
 text display software, so vertical alignment may not be optimal even when

diff --git a/local-docs/Release-Checklist.md b/local-docs/Release-Checklist.md
index 8915e2e86328c534742b6350b9b8e0ff5f048a9f..78fac503c6923066c79960c5e61d06b8be6bf284 100644 (file)
--- a/local-docs/Release-Checklist.md
+++ b/local-docs/Release-Checklist.md
@@ -1,31 +1,35 @@
 # Checklist of some things to when preparing a new version and/or release
 
 - review tickets at [rt.cpan.org](https://rt.cpan.org/Public/Dist/Display.html?Name=Perl-Tidy) 
+- review the issues at [github](https://github.com/perltidy/perltidy/issues/)
 - compare the new version with previous version on all files in test area
 - run 'author tests' on a much larger body of code than is covered by the .t
   files.
     - compare results of the current version with previous version
 - review tickets at sourceforge (hardly used now, but possible)
 - review/update the ChangeLog.pod file
-- be sure RPerl still works
+- be sure RPerl still works:
+  - build and install the latest Perl::Tidy on development machine
+  - install the latest RPerl [currently RPerl-5.002000]
+  - perl Makefile.PL, make, make test - should complete ok
 - Review code, especially any ## commented out sections and "FIXME's"
 - run perlver on all modules to check minimum version; should be 5.8.0
   - The first line in Tidy.pm has the required version of Perl
   - travis-CI is setup to test on version 5.8 so we should catch this type of error automatically
-  - use perlbrew to do local checks and debugging on earlier versions of perl
+  - use perlbrew to do local checks and debugging on earlier versions of perl if desired
 - Run tidyall -a to be sure code is tidied
   - note that I have tidyall set to also run perlcritic right now
 - Run perlcritic (if not done by tidyall)
 - run podchecker on all .pod files
 - run ispell on all .pod files
-- Be sure build at Travis.CI is clean for all version of perl
+- Be sure builds at Travis.CI and Appveyor are clean for all version of perl
 - update VERSION numbers in these files (build.pl can do this):
    - lib/Perl/Tidy.pm
    - lib/Perl/Tidy.pod
    - bin/perltidy
    - local-docs/ChangeLog.pod
 - make manifest
-    - check MANIFEST over carefully
+    - check MANIFEST over very carefully
     - sometimes it is necessary to remove MANIFEST and then do "make manifest"
 - make the .tar.gz
    - perl Makefile.PL