From 8551fc60fc515cd290ba38ee8c758c1f4df52b56 Mon Sep 17 00:00:00 2001 From: Steve Hancock Date: Sat, 14 Sep 2019 16:02:33 -0700 Subject: [PATCH] minor doc cleanups --- CHANGES.md | 19 ++++++++++--------- bin/perltidy | 23 ++++++++++++++--------- docs/ChangeLog.html | 21 +++++++++++---------- docs/perltidy.html | 6 ++++-- 4 files changed, 39 insertions(+), 30 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index dc4d4d09..8bba7e1f 100644 --- 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 ''. + - 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 5617bcd5..393a9a30 100755 --- 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 b1093224..a2a6434f 100644 --- a/docs/ChangeLog.html +++ b/docs/ChangeLog.html @@ -2,16 +2,7 @@

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" 
+
- 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 '<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
 

 
diff --git a/docs/perltidy.html b/docs/perltidy.html
index 7399b90d..070d8700 100644
--- a/docs/perltidy.html
+++ b/docs/perltidy.html
@@ -2886,9 +2886,11 @@
 
 
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.

+
A non-zero exit value indicates some kind of problem was detected.

 
-
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.

+
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.

 
 
SEE ALSO

 
-- 
2.39.5