New upstream version 20200110

[perltidy.git] / lib / Perl / Tidy.pod

diff --git a/lib/Perl/Tidy.pod b/lib/Perl/Tidy.pod
index 1213156c386425dc96e1dca7ae2504385154ec2d..dbbf01b8bc911bd6c0997d682b003e2ac2acbf28 100644 (file)
--- a/lib/Perl/Tidy.pod
+++ b/lib/Perl/Tidy.pod
@@ -129,7 +129,7 @@ command line string.
 If the B<dump_options> parameter is given, it must be the reference to a hash.
 In this case, the parameters contained in any perltidyrc configuration file
 will be placed in this hash and perltidy will return immediately.  This is
-equivalent to running perltidy with --dump-options, except that the perameters
+equivalent to running perltidy with --dump-options, except that the parameters
 are returned in a hash rather than dumped to standard output.  Also, by default
 only the parameters in the perltidyrc file are returned, but this can be
 changed (see the next parameter).  This parameter provides a convenient method
@@ -188,17 +188,21 @@ B<filter_example.pl> in the perltidy distribution.
 
 =head1 ERROR HANDLING
 
-Perltidy will return with an error flag indicating if 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.  The calling
-program should check this flag because if it is set the destination stream will
-be empty or incomplete and should be ignored.  Error messages in the B<stderr>
-stream will indicate the cause of any problem.  
+An exit value of 0, 1, or 2 is returned by perltidy to indicate the status of the result.
 
-If the error flag is not set then perltidy ran to completion.   However there
-may still be warning messages in the B<stderr> stream related to control
-parameters, and there may be warning messages in the B<errorfile> stream
-relating to possible syntax errors in the source code being tidied.  
+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.  The calling program should check for
+this flag because if it is set the destination stream will be empty or
+incomplete and should be ignored.  Error messages in the B<stderr> stream 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 B<stderr> stream related to parameter errors or
+conflicts and/or warning messages in the B<errorfile> stream relating to
+possible syntax errors in the source code being tidied. 
 
 In the event of a catastrophic error for which recovery is not possible
 B<perltidy> terminates by making calls to B<croak> or B<confess> to help the
@@ -214,7 +218,7 @@ B<argv> parameter.
 The B<-syn> (B<--check-syntax>) flag may be used with all source and
 destination streams except for standard input and output.  However 
 data streams which are not associated with a filename will 
-be copied to a temporary file before being be passed to Perl.  This
+be copied to a temporary file before being passed to Perl.  This
 use of temporary files can cause somewhat confusing output from Perl.
 
 If the B<-pbp> style is used it will typically be necessary to also
@@ -408,14 +412,13 @@ C<write_debug_entry> in Tidy.pm.
 
   &perltidy
 
-=head1 CREDITS
+=head1 INSTALLATION
 
-Thanks to Hugh Myers who developed the initial modular interface 
-to 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
 
-This man page documents Perl::Tidy version 20160302.
+This man page documents Perl::Tidy version 20200110
 
 =head1 LICENSE
 
@@ -424,10 +427,13 @@ under the terms of the "GNU General Public License".
 
 Please refer to the file "COPYING" for details.
 
-=head1 AUTHOR
+=head1 BUG REPORTS
+
+A list of current bugs and issues can be found at the CPAN site L<https://rt.cpan.org/Public/Dist/Display.html?Name=Perl-Tidy>
+
+To report a new bug or problem, use the link on this page.  
 
- Steve Hancock
- perltidy at users.sourceforge.net
+The source code repository is at L<https://github.com/perltidy/perltidy>.
 
 =head1 SEE ALSO