minor doc cleanups

diff --git a/CHANGES.md b/CHANGES.md
index dc4d4d09bef9d484f382722e07ff723ebdaebb32..8bba7e1f3a1edb1858ba74bb14281ab256c5c51f 100644 (file)
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -2,15 +2,6 @@
 
 ## 2019 09 15
 
-    - implement issue RT#130425: check mode.  A new flag '--assert-tidy'
-      will cause an error message if the output script is not identical to
-      the input script. For completeness, the opposite flag '--assert-untidy'
-      has also been added.
-
-    - iteration speedup for unchanged code.  Previously, when iterations were
-      requested, at least two formatting passes were made. Now just a single pass
-      is made if the formatted code is identical to the input code.
-
     - fixed issue RT#130344: false warning "operator in print statement" 
       for "use lib". 
 
@@ -23,6 +14,12 @@
       and if it is from a data structure then displayed filename 
       is '<source_stream>'.
 
+    - implement issue RT#130425: check mode.  A new flag '--assert-tidy'
+      will cause an error message if the output script is not identical to
+      the input script. For completeness, the opposite flag '--assert-untidy'
+      has also been added.  The next item, RT#130297, insures that the script
+      will exit with a non-zero exit flag if the assertion fails.
+
     - fixed issue RT#130297; the perltidy script now exits with a nonzero exit 
       status if it wrote to the standard error output. Prevously only fatal
       run errors produced a non-zero exit flag. Now, even non-fatal messages
@@ -50,6 +47,10 @@
       do not try to form new one line blocks for a block type 
       specified with -cbl, particularly map, sort, grep
 
+    - iteration speedup for unchanged code.  Previously, when iterations were
+      requested, at least two formatting passes were made. Now just a single pass
+      is made if the formatted code is identical to the input code.
+
     - some improved vertical alignments
 
 ## 2019 06 01

diff --git a/bin/perltidy b/bin/perltidy
index 5617bcd53707ab3a381f502f89f9297a4bcab63b..393a9a30af9c44b16b7870b867d5101b68674fee 100755 (executable)
--- a/bin/perltidy
+++ b/bin/perltidy
@@ -3757,15 +3757,20 @@ An exit value of 0, 1, or 2 is returned by perltidy to indicate the status of th
 
 A exit value of 0 indicates that perltidy ran to completion with no error messages.
 
-An exit value of 1 indicates that the process had to be terminated early due to
-errors in the input parameters.  This can happen for example if a parameter is
-misspelled or given an invalid value.  Error messages in the standard
-error output will indicate the cause of any problem.  
-
-An exit value of 2 indicates that perltidy ran to completion but there there
-are warning messages in the standard error output related to parameter errors or
-conflicts and/or warning messages in the perltidy error file(s) relating to
-possible syntax errors in the source code being tidied. 
+A non-zero exit value indicates some kind of problem was detected. 
+
+An exit value of 1 indicates that perltidy terminated prematurely, usually due
+to some kind of errors in the input parameters.  This can happen for example if
+a parameter is misspelled or given an invalid value.  Error messages in the
+standard error output will indicate the cause of any problem.  If perltidy
+terminates prematurely then no output files will be produced.
+
+An exit value of 2 indicates that perltidy was able to run to completion but
+there there are (1) warning messages in the standard error output related to
+parameter errors or problems and/or (2) warning messages in the perltidy error
+file(s) relating to possible syntax errors in one or more of the source
+script(s) being tidied.  When multiple files are being processed, an error
+detected in any single file will produce this type of exit condition.
 
 =head1 SEE ALSO
 

diff --git a/docs/ChangeLog.html b/docs/ChangeLog.html
index b1093224c1399a12b1a822cf6a4cec7ea8499b6e..a2a6434fe1d0285d6ecfaa7fffd73429c6659602 100644 (file)
--- a/docs/ChangeLog.html
+++ b/docs/ChangeLog.html
@@ -2,16 +2,7 @@
 
 <h2>2019 09 15</h2>
 
-<pre><code>- implement issue RT#130425: check mode.  A new flag '--assert-tidy'
-  will cause an error message if the output script is not identical to
-  the input script. For completeness, the opposite flag '--assert-untidy'
-  has also been added.
-
-- iteration speedup for unchanged code.  Previously, when iterations were
-  requested, at least two formatting passes were made. Now just a single pass
-  is made if the formatted code is identical to the input code.
-
-- fixed issue RT#130344: false warning "operator in print statement" 
+<pre><code>- fixed issue RT#130344: false warning "operator in print statement" 
   for "use lib". 
 
 - fixed issue RT#130304: standard error output should include filename.
@@ -23,6 +14,12 @@
   and if it is from a data structure then displayed filename 
   is '&lt;source_stream&gt;'.
 
+- implement issue RT#130425: check mode.  A new flag '--assert-tidy'
+  will cause an error message if the output script is not identical to
+  the input script. For completeness, the opposite flag '--assert-untidy'
+  has also been added.  The next item, RT#130297, insures that the script
+  will exit with a non-zero exit flag if the assertion fails.
+
 - fixed issue RT#130297; the perltidy script now exits with a nonzero exit 
   status if it wrote to the standard error output. Prevously only fatal
   run errors produced a non-zero exit flag. Now, even non-fatal messages
@@ -50,6 +47,10 @@
   do not try to form new one line blocks for a block type 
   specified with -cbl, particularly map, sort, grep
 
+- iteration speedup for unchanged code.  Previously, when iterations were
+  requested, at least two formatting passes were made. Now just a single pass
+  is made if the formatted code is identical to the input code.
+
 - some improved vertical alignments
 </code></pre>
 

diff --git a/docs/perltidy.html b/docs/perltidy.html
index 7399b90da4315ddf2b80680727473d801468e82c..070d8700cef482da5478fe5d1aa171d16353968e 100644 (file)
--- a/docs/perltidy.html
+++ b/docs/perltidy.html
@@ -2886,9 +2886,11 @@
 
 <p>A exit value of 0 indicates that perltidy ran to completion with no error messages.</p>
 
-<p>An exit value of 1 indicates that the process had to be terminated early due to errors in the input parameters. This can happen for example if a parameter is misspelled or given an invalid value. Error messages in the standard error output will indicate the cause of any problem.</p>
+<p>A non-zero exit value indicates some kind of problem was detected.</p>
 
-<p>An exit value of 2 indicates that perltidy ran to completion but there there are warning messages in the standard error output related to parameter errors or conflicts and/or warning messages in the perltidy error file(s) relating to possible syntax errors in the source code being tidied.</p>
+<p>An exit value of 1 indicates that perltidy terminated prematurely, usually due to some kind of errors in the input parameters. This can happen for example if a parameter is misspelled or given an invalid value. Error messages in the standard error output will indicate the cause of any problem. If perltidy terminates prematurely then no output files will be produced.</p>
+
+<p>An exit value of 2 indicates that perltidy was able to run to completion but there there are (1) warning messages in the standard error output related to parameter errors or problems and/or (2) warning messages in the perltidy error file(s) relating to possible syntax errors in one or more of the source script(s) being tidied. When multiple files are being processed, an error detected in any single file will produce this type of exit condition.</p>
 
 <h1 id="SEE-ALSO">SEE ALSO</h1>