minor doc cleanups for release of VERSION 20200110

diff --git a/CHANGES.md b/CHANGES.md
index 953953c8045781cdfe3e555fa0f4aa55b6a6a152..83034a5e0e607f18899ec56338afe3e2f82ae816 100644 (file)
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -3,27 +3,27 @@
 ## 2020 01 10
 
     - This release adds a flag to control the feature RT#130394 (allow short nested blocks)
-      introduced in the previous release.  Unfortunately that feature breaks existing 
+      introduced in the previous release.  Unfortunately that feature breaks 
       RPerl installations, so a control flag has been introduced and that feature is now
       off by default.  The flag is:
 
       --one-line-block-nesting=n, or -olbn=n, where n is an integer as follows: 
 
       -olbn=0 break nested one-line blocks into multiple lines [new DEFAULT]
-      -olbn=1 stable; keep existing nested-one line blocks intact
+      -olbn=1 stable; keep existing nested-one line blocks intact [previous DEFAULT]
 
       For example, consider this input line:
 
-         foreach (@list) { if ($_ eq $asked_for) { last } ++$found }
+        foreach (@list) { if ($_ eq $asked_for) { last } ++$found }
 
-      The default behavior (-olbn=0) is to break it into multiple lines:
+      The new default behavior (-olbn=0), and behavior prior to version 20191203, is to break it into multiple lines:
 
-         foreach (@list) {
-                if ( $_ eq $asked_for ) { last }
-                ++$found;
-         }
+        foreach (@list) {
+            if ( $_ eq $asked_for ) { last }
+            ++$found;
+        }
 
-      To keep nested one-line blocks like this on a single line you can add the parameter -olbn=1.
+      To keep nested one-line blocks such as this on a single line you can add the parameter -olbn=1.
 
     - Fixed issue RT#131288: parse error for un-prototyped constant function without parenthesized
       call parameters followed by ternary.

diff --git a/bin/perltidy b/bin/perltidy
index 2ee131f3d4f36ebb4c8f5b8b6ea3b9e1082bfcc2..93a22c4c2202a67229a95a68bdf073317407d259 100755 (executable)
--- a/bin/perltidy
+++ b/bin/perltidy
@@ -3831,7 +3831,7 @@ perlstyle(1), Perl::Tidy(3)
 
 =head1 INSTALLATION
 
-The perltidy binary uses the Perl::Tidy module and is installed when that module is installed.  Module installation is system-dependent.  On some systems, the command 'cpanm Perl::Tidy' will work.
+The perltidy binary uses the Perl::Tidy module and is installed when that module is installed.  The module name is case-sensitive.  For example, the basic command for installing with cpanm is 'cpanm Perl::Tidy'.
 
 =head1 VERSION
 

diff --git a/docs/ChangeLog.html b/docs/ChangeLog.html
index 11c757ee14cdc959e5aa6f5c1e2044b9b6978bb8..6457896bcf5a214c2129011a3e6cb5ae139c6e7a 100644 (file)
--- a/docs/ChangeLog.html
+++ b/docs/ChangeLog.html
@@ -3,27 +3,27 @@
 <h2>2020 01 10</h2>
 
 <pre><code>- This release adds a flag to control the feature RT#130394 (allow short nested blocks)
-  introduced in the previous release.  Unfortunately that feature breaks existing 
+  introduced in the previous release.  Unfortunately that feature breaks 
   RPerl installations, so a control flag has been introduced and that feature is now
   off by default.  The flag is:
 
   --one-line-block-nesting=n, or -olbn=n, where n is an integer as follows: 
 
   -olbn=0 break nested one-line blocks into multiple lines [new DEFAULT]
-  -olbn=1 stable; keep existing nested-one line blocks intact
+  -olbn=1 stable; keep existing nested-one line blocks intact [previous DEFAULT]
 
   For example, consider this input line:
 
-     foreach (@list) { if ($_ eq $asked_for) { last } ++$found }
+    foreach (@list) { if ($_ eq $asked_for) { last } ++$found }
 
-  The default behavior (-olbn=0) is to break it into multiple lines:
+  The new default behavior (-olbn=0), and behavior prior to version 20191203, is to break it into multiple lines:
 
-     foreach (@list) {
-            if ( $_ eq $asked_for ) { last }
-            ++$found;
-     }
+    foreach (@list) {
+        if ( $_ eq $asked_for ) { last }
+        ++$found;
+    }
 
-  To keep nested one-line blocks like this on a single line you can add the parameter -olbn=1.
+  To keep nested one-line blocks such as this on a single line you can add the parameter -olbn=1.
 
 - Fixed issue RT#131288: parse error for un-prototyped constant function without parenthesized
   call parameters followed by ternary.

diff --git a/docs/Tidy.html b/docs/Tidy.html
index ee5cd67430bcde8c1f4596458fd8c582d34b3c5b..9b49356255538db296e8f8f1265bdabbacf46547 100644 (file)
--- a/docs/Tidy.html
+++ b/docs/Tidy.html
@@ -354,7 +354,7 @@
 
 <h1 id="INSTALLATION">INSTALLATION</h1>
 
-<p>On many systems, the command &#39;cpanm Perl::Tidy&#39; will install both the module Perl::Tidy and a binary perltidy.</p>
+<p>The module &#39;Perl::Tidy&#39; comes with a binary &#39;perltidy&#39; which is installed when the module is installed. The module name is case-sensitive. For example, the basic command for installing with cpanm is &#39;cpanm Perl::Tidy&#39;.</p>
 
 <h1 id="VERSION">VERSION</h1>
 

diff --git a/docs/perltidy.html b/docs/perltidy.html
index 599c38de220f5a2c1a279d85b81219d5cfc1c0d9..c9834dd265c30e8ed355335607c08bb29d51fba7 100644 (file)
--- a/docs/perltidy.html
+++ b/docs/perltidy.html
@@ -2953,7 +2953,7 @@
 
 <h1 id="INSTALLATION">INSTALLATION</h1>
 
-<p>The perltidy binary uses the Perl::Tidy module and is installed when that module is installed. Module installation is system-dependent. On some systems, the command &#39;cpanm Perl::Tidy&#39; will work.</p>
+<p>The perltidy binary uses the Perl::Tidy module and is installed when that module is installed. The module name is case-sensitive. For example, the basic command for installing with cpanm is &#39;cpanm Perl::Tidy&#39;.</p>
 
 <h1 id="VERSION">VERSION</h1>
 

diff --git a/lib/Perl/Tidy.pod b/lib/Perl/Tidy.pod
index 9307ca0fef479126afe4d993192b916e9c5c24b6..dbbf01b8bc911bd6c0997d682b003e2ac2acbf28 100644 (file)
--- a/lib/Perl/Tidy.pod
+++ b/lib/Perl/Tidy.pod
@@ -414,8 +414,7 @@ C<write_debug_entry> in Tidy.pm.
 
 =head1 INSTALLATION
 
-On many systems, the command 'cpanm Perl::Tidy' will install both the module Perl::Tidy and a binary perltidy.
-
+The module 'Perl::Tidy' comes with a binary 'perltidy' which is installed when the module is installed.  The module name is case-sensitive.  For example, the basic command for installing with cpanm is 'cpanm Perl::Tidy'.
 
 =head1 VERSION
 

diff --git a/local-docs/Release-Checklist.md b/local-docs/Release-Checklist.md
index bc63dbc6db4ee83159c824ee88b285f387985d54..8aadf4757bd2d028d8bffb60d3081534f9861358 100644 (file)
--- a/local-docs/Release-Checklist.md
+++ b/local-docs/Release-Checklist.md
@@ -7,6 +7,7 @@
     - 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
 - 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