From 00fd6a276c0ed5ef5d5a3f49f160b3db5a6692a5 Mon Sep 17 00:00:00 2001 From: Steve Hancock Date: Thu, 9 Jan 2020 07:23:41 -0800 Subject: [PATCH] minor doc cleanups for release of VERSION 20200110 --- CHANGES.md | 18 +++++++++--------- bin/perltidy | 2 +- docs/ChangeLog.html | 18 +++++++++--------- docs/Tidy.html | 2 +- docs/perltidy.html | 2 +- lib/Perl/Tidy.pod | 3 +-- local-docs/Release-Checklist.md | 1 + 7 files changed, 23 insertions(+), 23 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index 953953c8..83034a5e 100644 --- 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 2ee131f3..93a22c4c 100755 --- 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 11c757ee..6457896b 100644 --- a/docs/ChangeLog.html +++ b/docs/ChangeLog.html @@ -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/docs/Tidy.html b/docs/Tidy.html
index ee5cd674..9b493562 100644
--- a/docs/Tidy.html
+++ b/docs/Tidy.html
@@ -354,7 +354,7 @@
 
 
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'.

 
 
VERSION

 
diff --git a/docs/perltidy.html b/docs/perltidy.html
index 599c38de..c9834dd2 100644
--- a/docs/perltidy.html
+++ b/docs/perltidy.html
@@ -2953,7 +2953,7 @@
 
 
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'.

 
 
VERSION

 
diff --git a/lib/Perl/Tidy.pod b/lib/Perl/Tidy.pod
index 9307ca0f..dbbf01b8 100644
--- a/lib/Perl/Tidy.pod
+++ b/lib/Perl/Tidy.pod
@@ -414,8 +414,7 @@ C 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 bc63dbc6..8aadf475 100644
--- 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
-- 
2.39.5