CHANGES

   1 Perltidy Change Log
   2      You can help Perltidy evolve into a better program.  If you have hit a
   3      bug, unusual behavior, annoyance, or have a suggested improvement,
   4      please send a note to perltidy at users.sourceforge.net.  All
   5      suggestions are welcome.
   6
   7   2006 06 14
   8      -Attribute argument lists are now correctly treated as quoted strings
   9      and not formatted.  This is the most important update in this version.
  10      Thanks to Borris Zentner, Greg Ferguson, Steve Kirkup.
  11
  12      -Updated to recognize the defined or operator, //, to be released in Perl 10.
  13      Thanks to Sebastien Aperghis-Tramoni.
  14
  15      -A useful utility perltidyrc_dump.pl is included in the examples section.  It
  16      will read any perltidyrc file and write it back out in a standard format
  17      (though comments are lost).
  18
  19      -Added option to have perltidy read and return a hash with the contents of a
  20      perltidyrc file.  This may be used by Leif Eriksen's tidyview code.  This
  21      feature is used by the demonstration program 'perltidyrc_dump.pl' in the
  22      examples directory.
  23
  24      -Improved error checking in perltidyrc files.  Unknown bare words were not
  25      being caught.
  26
  27      -The --dump-options parameter now dumps parameters in the format required by a
  28      perltidyrc file.
  29
  30      -V-Strings with underscores are now recognized.
  31      For example: $v = v1.2_3;
  32
  33      -cti=3 option added which gives one extra indentation level to closing
  34      tokens always.  This provides more predictable closing token placement
  35      than cti=2.  If you are using cti=2 you might want to try cti=3.
  36
  37      -To identify all left-adjusted comments as static block comments, use C<-sbcp='^#'>.
  38
  39      -New parameters -fs, -fsb, -fse added to allow sections of code between #<<<
  40      and #>>> to be passed through verbatim. This is enabled by default and turned
  41      off by -nfs.  Flags -fsb and -fse allow other beginning and ending markers.
  42      Thanks to Wolfgang Werner and Marion Berryman for suggesting this.
  43
  44      -added flag -skp to put a space between all Perl keywords and following paren.
  45      The default is to only do this for certain keywords.  Suggested by
  46      H.Merijn Brand.
  47
  48      -added flag -sfp to put a space between a function name and following paren.
  49      The default is not to do this.  Suggested by H.Merijn Brand.
  50
  51      -Added patch to avoid breaking GetOpt::Long::Configure set by calling program.
  52      Thanks to BOOK at CPAN.
  53
  54      -An error was fixed in which certain parameters in a .perltidyrc file given
  55      without the equals sign were not recognized.  That is,
  56      '--brace-tightness 0' gave an error but '--brace-tightness=0' worked
  57      ok.  Thanks to Zac Hansen.
  58
  59      -An error preventing the -nwrs flag from working was corrected. Thanks to
  60       Greg Ferguson.
  61
  62      -Corrected some alignment problems with entab option.
  63
  64      -A bug with the combination of -lp and -extrude was fixed (though this
  65      combination doesn't really make sense).  The bug was that a line with
  66      a single zero would be dropped.  Thanks to Cameron Hayne.
  67
  68      -Updated Windows detection code to avoid an undefined variable.
  69      Thanks to Joe Yates and Russ Jones.
  70
  71      -Improved formatting for short trailing statements following a closing paren.
  72      Thanks to Joe Matarazzo.
  73
  74      -The handling of the -icb (indent closing block braces) flag has been changed
  75      slightly to provide more consistent and predictable formatting of complex
  76      structures.  Instead of giving a closing block brace the indentation of the
  77      previous line, it is now given one extra indentation level.  The two methods
  78      give the same result if the previous line was a complete statement, as in this
  79      example:
  80
  81             if ($task) {
  82                 yyy();
  83                 }    # -icb
  84             else {
  85                 zzz();
  86                 }
  87      The change also fixes a problem with empty blocks such as:
  88
  89         OLD, -icb:
  90         elsif ($debug) {
  91         }
  92
  93         NEW, -icb:
  94         elsif ($debug) {
  95             }
  96
  97      -A problem with -icb was fixed in which a closing brace was misplaced when
  98      it followed a quote which spanned multiple lines.
  99
 100      -Some improved breakpoints for -wba='&& || and or'
 101
 102      -Fixed problem with misaligned cuddled else in complex statements
 103      when the -bar flag was also used.  Thanks to Alex and Royce Reese.
 104
 105      -Corrected documentation to show that --outdent-long-comments is the default.
 106      Thanks to Mario Lia.
 107
 108      -New flag -otr (opening-token-right) is similar to -bar (braces-always-right)
 109      but applies to non-structural opening tokens.
 110
 111      -new flags -sot (stack-opening-token), -sct (stack-closing-token).
 112      Suggested by Tony.
 113
 114   2003 10 21
 115      -The default has been changed to not do syntax checking with perl.
 116        Use -syn if you want it.  Perltidy is very robust now, and the -syn
 117        flag now causes more problems than it's worth because of BEGIN blocks
 118        (which get executed with perl -c).  For example, perltidy will never
 119        return when trying to beautify this code if -syn is used:
 120
 121             BEGIN { 1 while { }; }
 122
 123       Although this is an obvious error, perltidy is often run on untested
 124       code which is more likely to have this sort of problem.  A more subtle
 125       example is:
 126
 127             BEGIN { use FindBin; }
 128
 129       which may hang on some systems using -syn if a shared file system is
 130       unavailable.
 131
 132      -Changed style -gnu to use -cti=1 instead of -cti=2 (see next item).
 133       In most cases it looks better.  To recover the previous format, use
 134       '-gnu -cti=2'
 135
 136      -Added flags -cti=n for finer control of closing token indentation.
 137        -cti = 0 no extra indentation (default; same as -nicp)
 138        -cti = 1 enough indentation so that the closing token
 139             aligns with its opening token.
 140        -cti = 2 one extra indentation level if the line has the form
 141               );   ];   or   };     (same as -icp).
 142
 143        The new option -cti=1 works well with -lp:
 144
 145        EXAMPLES:
 146
 147         # perltidy -lp -cti=1
 148         @month_of_year = (
 149                            'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
 150                            'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
 151                          );
 152
 153         # perltidy -lp -cti=2
 154         @month_of_year = (
 155                            'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
 156                            'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
 157                            );
 158       This is backwards compatible with -icp. See revised manual for
 159       details.  Suggested by Mike Pennington.
 160
 161      -Added flag '--preserve-line-endings' or '-ple' to cause the output
 162       line ending to be the same as in the input file, for unix, dos,
 163       or mac line endings.  Only works under unix. Suggested by
 164       Rainer Hochschild.
 165
 166      -Added flag '--output-line-ending=s' or '-ole=s' where s=dos or win,
 167       unix, or mac.  Only works under unix.
 168
 169      -Files with Mac line endings should now be handled properly under unix
 170       and dos without being passed through a converter.
 171
 172      -You may now include 'and', 'or', and 'xor' in the list following
 173       '--want-break-after' to get line breaks after those keywords rather than
 174       before them.  Suggested by Rainer Hochschild.
 175
 176      -Corrected problem with command line option for -vtc=n and -vt=n. The
 177       equals sign was being eaten up by the Windows shell so perltidy didn't
 178       see it.
 179
 180   2003 07 26
 181      -Corrected cause of warning message with recent versions of Perl:
 182         "Possible precedence problem on bitwise & operator at ..."
 183       Thanks to Jim Files.
 184
 185      -fixed bug with -html with '=for pod2html' sections, in which code/pod
 186      output order was incorrect.  Thanks to Tassilo von Parseval.
 187
 188      -fixed bug when the -html flag is used, in which the following error
 189      message, plus others, appear:
 190          did not see <body> in pod2html output
 191      This was caused by a change in the format of html output by pod2html
 192      VERSION 1.04 (included with perl 5.8).  Thanks to Tassilo von Parseval.
 193
 194      -Fixed bug where an __END__ statement would be mistaken for a label
 195      if it is immediately followed by a line with a leading colon. Thanks
 196      to John Bayes.
 197
 198      -Implemented guessing logic for brace types when it is ambiguous.  This
 199      has been on the TODO list a long time.  Thanks to Boris Zentner for
 200      an example.
 201
 202      -Long options may now be negated either as '--nolong-option'
 203      or '--no-long-option'.  Thanks to Philip Newton for the suggestion.
 204
 205      -added flag --html-entities or -hent which controls the use of
 206      Html::Entities for html formatting.  Use --nohtml-entities or -nhent to
 207      prevent the use of Html::Entities to encode special symbols.  The
 208      default is -hent.  Html::Entities when formatting perl text to escape
 209      special symbols.  This may or may not be the right thing to do,
 210      depending on browser/language combinations.  Thanks to Burak Gursoy for
 211      this suggestion.
 212
 213      -Bareword strings with leading '-', like, '-foo' now count as 1 token
 214      for horizontal tightness.  This way $a{'-foo'}, $a{foo}, and $a{-foo}
 215      are now all treated similarly.  Thus, by default, OLD: $a{ -foo } will
 216      now be NEW: $a{-foo}.  Suggested by Mark Olesen.
 217
 218      -added 2 new flags to control spaces between keywords and opening parens:
 219        -sak=s  or --space-after-keyword=s,  and
 220        -nsak=s or --nospace-after-keyword=s, where 's' is a list of keywords.
 221
 222      The new default list of keywords which get a space is:
 223
 224        "my local our and or eq ne if else elsif until unless while for foreach
 225          return switch case given when"
 226
 227      Use -sak=s and -nsak=s to add and remove keywords from this list,
 228         respectively.
 229
 230      Explanation: Stephen Hildrey noted that perltidy was being inconsistent
 231      in placing spaces between keywords and opening parens, and sent a patch
 232      to give user control over this.  The above list was selected as being
 233      a reasonable default keyword list.  Previously, perltidy
 234      had a hardwired list which also included these keywords:
 235
 236             push pop shift unshift join split die
 237
 238      but did not have 'our'.  Example: if you prefer to make perltidy behave
 239      exactly as before, you can include the following two lines in your
 240      .perltidyrc file:
 241
 242        -sak="push pop local shift unshift join split die"
 243        -nsak="our"
 244
 245      -Corrected html error in .toc file when -frm -html is used (extra ");
 246       browsers were tolerant of it.
 247
 248      -Improved alignment of chains of binary and ?/: operators. Example:
 249       OLD:
 250         $leapyear =
 251           $year % 4     ? 0
 252           : $year % 100 ? 1
 253           : $year % 400 ? 0
 254           : 1;
 255       NEW:
 256         $leapyear =
 257             $year % 4   ? 0
 258           : $year % 100 ? 1
 259           : $year % 400 ? 0
 260           : 1;
 261
 262      -improved breakpoint choices involving '->'
 263
 264      -Corrected tokenization of things like ${#} or ${©}. For example,
 265       ${©} is valid, but ${© } is a syntax error.
 266
 267      -Corrected minor tokenization errors with indirect object notation.
 268       For example, 'new A::()' works now.
 269
 270      -Minor tokenization improvements; all perl code distributed with perl 5.8
 271       seems to be parsed correctly except for one instance (lextest.t)
 272       of the known bug.
 273
 274   2002 11 30
 275      -Implemented scalar attributes.  Thanks to Sean Tobin for noting this.
 276
 277      -Fixed glitch introduced in previous release where -pre option
 278      was not outputting a leading html <pre> tag.
 279
 280      -Numerous minor improvements in vertical alignment, including the following:
 281
 282      -Improved alignment of opening braces in many cases.  Needed for improved
 283      switch/case formatting, and also suggested by Mark Olesen for sort/map/grep
 284      formatting.  For example:
 285
 286       OLD:
 287         @modified =
 288           map { $_->[0] }
 289           sort { $a->[1] <=> $b->[1] }
 290           map { [ $_, -M ] } @filenames;
 291
 292       NEW:
 293         @modified =
 294           map  { $_->[0] }
 295           sort { $a->[1] <=> $b->[1] }
 296           map  { [ $_, -M ] } @filenames;
 297
 298      -Eliminated alignments across unrelated statements. Example:
 299       OLD:
 300         $borrowerinfo->configure( -state => 'disabled' );
 301         $borrowerinfo->grid( -col        => 1, -row => 0, -sticky => 'w' );
 302
 303       NEW:
 304         $borrowerinfo->configure( -state => 'disabled' );
 305         $borrowerinfo->grid( -col => 1, -row => 0, -sticky => 'w' );
 306
 307       Thanks to Mark Olesen for suggesting this.
 308
 309      -Improved alignement of '='s in certain cases.
 310       Thanks to Norbert Gruener for sending an example.
 311
 312      -Outdent-long-comments (-olc) has been re-instated as a default, since
 313       it works much better now.  Use -nolc if you want to prevent it.
 314
 315      -Added check for 'perltidy file.pl -o file.pl', which causes file.pl
 316      to be lost. (The -b option should be used instead). Thanks to mreister
 317      for reporting this problem.
 318
 319   2002 11 06
 320      -Switch/case or given/when syntax is now recognized.  Its vertical alignment
 321      is not great yet, but it parses ok.  The words 'switch', 'case', 'given',
 322      and 'when' are now treated as keywords.  If this causes trouble with older
 323      code, we could introduce a switch to deactivate it.  Thanks to Stan Brown
 324      and Jochen Schneider for recommending this.
 325
 326      -Corrected error parsing sub attributes with call parameters.
 327      Thanks to Marc Kerr for catching this.
 328
 329      -Sub prototypes no longer need to be on the same line as sub names.
 330
 331      -a new flag -frm or --frames will cause html output to be in a
 332      frame, with table of contents in the left panel and formatted source
 333      in the right panel.  Try 'perltidy -html -frm somemodule.pm' for example.
 334
 335      -The new default for -html formatting is to pass the pod through Pod::Html.
 336      The result is syntax colored code within your pod documents. This can be
 337      deactivated with -npod.  Thanks to those who have written to discuss this,
 338      particularly Mark Olesen and Hugh Myers.
 339
 340      -the -olc (--outdent-long-comments) option works much better.  It now outdents
 341      groups of consecutive comments together, and by just the amount needed to
 342      avoid having any one line exceeding the maximum line length.
 343
 344      -block comments are now trimmed of trailing whitespace.
 345
 346      -if a directory specified with -opath does not exist, it will be created.
 347
 348      -a table of contents to packages and subs is output when -html is used.
 349      Use -ntoc to prevent this.
 350
 351      -fixed an unusual bug in which a 'for' statement following a 'format'
 352      statement was not correctly tokenized.  Thanks to Boris Zentner for
 353      catching this.
 354
 355      -Tidy.pm is no longer dependent on modules IO::Scalar and IO::ScalarArray.
 356      There were some speed issues.  Suggested by Joerg Walter.
 357
 358      -The treatment of quoted wildcards (file globs) is now system-independent.
 359      For example
 360
 361         perltidy 'b*x.p[lm]'
 362
 363      would match box.pl, box.pm, brinx.pm under any operating system.  Of
 364      course, anything unquoted will be subject to expansion by any shell.
 365
 366      -default color for keywords under -html changed from
 367      SaddleBrown (#8B4513) to magenta4 (#8B008B).
 368
 369      -fixed an arg parsing glitch in which something like:
 370        perltidy quick-help
 371      would trigger the help message and exit, rather than operate on the
 372      file 'quick-help'.
 373
 374   2002 09 22
 375      -New option '-b' or '--backup-and-modify-in-place' will cause perltidy to
 376      overwrite the original file with the tidied output file.  The original
 377      file will be saved with a '.bak' extension (which can be changed with
 378      -bext=s).  Thanks to Rudi Farkas for the suggestion.
 379
 380      -An index to all subs is included at the top of -html output, unless
 381      only the <pre> section is written.
 382
 383      -Anchor lines of the form <a name="mysub"></a> are now inserted at key points
 384      in html output, such as before sub definitions, for the convenience of
 385      postprocessing scripts.  Suggested by Howard Owen.
 386
 387      -The cuddled-else (-ce) flag now also makes cuddled continues, like
 388      this:
 389
 390         while ( ( $pack, $file, $line ) = caller( $i++ ) ) {
 391            # bla bla
 392         } continue {
 393             $prevpack = $pack;
 394         }
 395
 396      Suggested by Simon Perreault.
 397
 398      -Fixed bug in which an extra blank line was added before an =head or
 399      similar pod line after an __END__ or __DATA__ line each time
 400      perltidy was run.  Also, an extra blank was being added after
 401      a terminal =cut.  Thanks to Mike Birdsall for reporting this.
 402
 403   2002 08 26
 404      -Fixed bug in which space was inserted in a hyphenated hash key:
 405         my $val = $myhash{USER-NAME};
 406       was converted to:
 407         my $val = $myhash{USER -NAME};
 408       Thanks to an anonymous bug reporter at sourceforge.
 409
 410      -Fixed problem with the '-io' ('--indent-only') where all lines
 411       were double spaced.  Thanks to Nick Andrew for reporting this bug.
 412
 413      -Fixed tokenization error in which something like '-e1' was
 414       parsed as a number.
 415
 416      -Corrected a rare problem involving older perl versions, in which
 417       a line break before a bareword caused problems with 'use strict'.
 418       Thanks to Wolfgang Weisselberg for noting this.
 419
 420      -More syntax error checking added.
 421
 422      -Outdenting labels (-ola) has been made the default, in order to follow the
 423       perlstyle guidelines better.  It's probably a good idea in general, but
 424       if you do not want this, use -nola in your .perltidyrc file.
 425
 426      -Updated rules for padding logical expressions to include more cases.
 427       Thanks to Wolfgang Weisselberg for helpful discussions.
 428
 429      -Added new flag -osbc (--outdent-static-block-comments) which will
 430       outdent static block comments by 2 spaces (or whatever -ci equals).
 431       Requested by Jon Robison.
 432
 433   2002 04 25
 434      -Corrected a bug, introduced in the previous release, in which some
 435       closing side comments (-csc) could have incorrect text.  This is
 436       annoying but will be correct the next time perltidy is run with -csc.
 437
 438      -Implemented XHTML patch submitted by Ville Skyttä.
 439
 440      -Fixed bug where whitespace was being removed between 'Bar' and '()'
 441       in a use statement like:
 442
 443            use Foo::Bar ();
 444
 445       Thanks to Ville Skyttä for reporting this.
 446
 447      -Whenever possible, if a logical expression is broken with leading
 448       '&&', '||', 'and', or 'or', then the leading line will be padded
 449       with additional space to produce alignment.  This has been on the
 450       todo list for a long time; thanks to Frank Steinhauer for reminding
 451       me to do it.  Notice the first line after the open parens here:
 452
 453             OLD: perltidy -lp
 454             if (
 455                  !param("rules.to.$linecount")
 456                  && !param("rules.from.$linecount")
 457                  && !param("rules.subject.$linecount")
 458                  && !(
 459                        param("rules.fieldname.$linecount")
 460                        && param("rules.fieldval.$linecount")
 461                  )
 462                  && !param("rules.size.$linecount")
 463                  && !param("rules.custom.$linecount")
 464               )
 465
 466             NEW: perltidy -lp
 467             if (
 468                     !param("rules.to.$linecount")
 469                  && !param("rules.from.$linecount")
 470                  && !param("rules.subject.$linecount")
 471                  && !(
 472                           param("rules.fieldname.$linecount")
 473                        && param("rules.fieldval.$linecount")
 474                  )
 475                  && !param("rules.size.$linecount")
 476                  && !param("rules.custom.$linecount")
 477               )
 478
 479   2002 04 16
 480      -Corrected a mistokenization of variables for a package with a name
 481       equal to a perl keyword.  For example:
 482
 483          my::qx();
 484          package my;
 485          sub qx{print "Hello from my::qx\n";}
 486
 487       In this case, the leading 'my' was mistokenized as a keyword, and a
 488       space was being place between 'my' and '::'.  This has been
 489       corrected.  Thanks to Martin Sluka for discovering this.
 490
 491      -A new flag -bol (--break-at-old-logic-breakpoints)
 492       has been added to control whether containers with logical expressions
 493       should be broken open.  This is the default.
 494
 495      -A new flag -bok (--break-at-old-keyword-breakpoints)
 496       has been added to follow breaks at old keywords which return lists,
 497       such as sort and map.  This is the default.
 498
 499      -A new flag -bot (--break-at-old-trinary-breakpoints) has been added to
 500       follow breaks at trinary (conditional) operators.  This is the default.
 501
 502      -A new flag -cab=n has been added to control breaks at commas after
 503       '=>' tokens.  The default is n=1, meaning break unless this breaks
 504       open an existing on-line container.
 505
 506      -A new flag -boc has been added to allow existing list formatting
 507       to be retained.  (--break-at-old-comma-breakpoints).  See updated manual.
 508
 509      -A new flag -iob (--ignore-old-breakpoints) has been added to
 510       prevent the locations of old breakpoints from influencing the output
 511       format.
 512
 513      -Corrected problem where nested parentheses were not getting full
 514       indentation.  This has been on the todo list for some time; thanks
 515       to Axel Rose for a snippet demonstrating this issue.
 516
 517                 OLD: inner list is not indented
 518                 $this->sendnumeric(
 519                     $this->server,
 520                     (
 521                       $ret->name,        $user->username, $user->host,
 522                     $user->server->name, $user->nick,     "H"
 523                     ),
 524                 );
 525
 526                 NEW:
 527                 $this->sendnumeric(
 528                     $this->server,
 529                     (
 530                         $ret->name,          $user->username, $user->host,
 531                         $user->server->name, $user->nick,     "H"
 532                     ),
 533                 );
 534
 535      -Code cleaned up by removing the following unused, undocumented flags.
 536       They should not be in any .perltidyrc files because they were just
 537       experimental flags which were never documented.  Most of them placed
 538       artificial limits on spaces, and Wolfgang Weisselberg convinced me that
 539       most of them they do more harm than good by causing unexpected results.
 540
 541       --maximum-continuation-indentation (-mci)
 542       --maximum-whitespace-columns
 543       --maximum-space-to-comment (-xsc)
 544       --big-space-jump (-bsj)
 545
 546      -Pod file 'perltidy.pod' has been appended to the script 'perltidy', and
 547       Tidy.pod has been append to the module 'Tidy.pm'.  Older MakeMaker's
 548       were having trouble.
 549
 550      -A new flag -isbc has been added for more control on comments. This flag
 551       has the effect that if there is no leading space on the line, then the
 552       comment will not be indented, and otherwise it may be.  If both -ibc and
 553       -isbc are set, then -isbc takes priority.  Thanks to Frank Steinhauer
 554       for suggesting this.
 555
 556      -A new document 'stylekey.pod' has been created to quickly guide new users
 557       through the maze of perltidy style parameters.  An html version is
 558       on the perltidy web page.  Take a look! It should be very helpful.
 559
 560      -Parameters for controlling 'vertical tightness' have been added:
 561       -vt and -vtc are the main controls, but finer control is provided
 562       with -pvt, -pcvt, -bvt, -bcvt, -sbvt, -sbcvt.  Block brace vertical
 563       tightness controls have also been added.
 564       See updated manual and also see 'stylekey.pod'. Simple examples:
 565
 566         # perltidy -lp -vt=1 -vtc=1
 567         @month_of_year = ( 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
 568                            'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec' );
 569
 570         # perltidy -lp -vt=1 -vtc=0
 571         @month_of_year = ( 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
 572                            'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
 573         );
 574
 575      -Lists which do not format well in uniform columns are now better
 576       identified and formated.
 577
 578         OLD:
 579         return $c->create( 'polygon', $x, $y, $x + $ruler_info{'size'},
 580             $y + $ruler_info{'size'}, $x - $ruler_info{'size'},
 581             $y + $ruler_info{'size'} );
 582
 583         NEW:
 584         return $c->create(
 585             'polygon', $x, $y,
 586             $x + $ruler_info{'size'},
 587             $y + $ruler_info{'size'},
 588             $x - $ruler_info{'size'},
 589             $y + $ruler_info{'size'}
 590         );
 591
 592         OLD:
 593           radlablist($f1, pad('Initial', $p), $b->{Init}->get_panel_ref, 'None ',
 594                      'None', 'Default', 'Default', 'Simple', 'Simple');
 595         NEW:
 596           radlablist($f1,
 597                      pad('Initial', $p),
 598                      $b->{Init}->get_panel_ref,
 599                      'None ', 'None', 'Default', 'Default', 'Simple', 'Simple');
 600
 601      -Corrected problem where an incorrect html filename was generated for
 602       external calls to Tidy.pm module.  Fixed incorrect html title when
 603       Tidy.pm is called with IO::Scalar or IO::Array source.
 604
 605      -Output file permissons are now set as follows.  An output script file
 606       gets the same permission as the input file, except that owner
 607       read/write permission is added (otherwise, perltidy could not be
 608       rerun).  Html output files use system defaults.  Previously chmod 0755
 609       was used in all cases.  Thanks to Mark Olesen for bringing this up.
 610
 611      -Missing semicolons will not be added in multi-line blocks of type
 612       sort, map, or grep.  This brings perltidy into closer agreement
 613       with common practice.  Of course, you can still put semicolons
 614       there if you like.  Thanks to Simon Perreault for a discussion of this.
 615
 616      -Most instances of extra semicolons are now deleted.  This is
 617       particularly important if the -csc option is used.  Thanks to Wolfgang
 618       Weisselberg for noting this.  For example, the following line
 619       (produced by 'h2xs' :) has an extra semicolon which will now be
 620       removed:
 621
 622          BEGIN { plan tests => 1 };
 623
 624      -New parameter -csce (--closing-side-comment-else-flag) can be used
 625       to control what text is appended to 'else' and 'elsif' blocks.
 626       Default is to just add leading 'if' text to an 'else'.  See manual.
 627
 628      -The -csc option now labels 'else' blocks with additinal information
 629       from the opening if statement and elsif statements, if space.
 630       Thanks to Wolfgang Weisselberg for suggesting this.
 631
 632      -The -csc option will now remove any old closing side comments
 633       below the line interval threshold. Thanks to Wolfgang Weisselberg for
 634       suggesting this.
 635
 636      -The abbreviation feature, which was broken in the previous version,
 637       is now fixed.  Thanks to Michael Cartmell for noting this.
 638
 639      -Vertical alignment is now done for '||='  .. somehow this was
 640       overlooked.
 641
 642   2002 02 25
 643      -This version uses modules for the first time, and a standard perl
 644       Makefile.PL has been supplied.  However, perltidy may still be
 645       installed as a single script, without modules.  See INSTALL for
 646       details.
 647
 648      -The man page 'perl2web' has been merged back into the main 'perltidy'
 649       man page to simplify installation.  So you may remove that man page
 650       if you have an older installation.
 651
 652      -Added patch from Axel Rose for MacPerl.  The patch prompts the user
 653       for command line arguments before calling the module
 654       Perl::Tidy::perltidy.
 655
 656      -Corrected bug with '-bar' which was introduced in the previous
 657       version.  A closing block brace was being indented.  Thanks to
 658       Alexandros M Manoussakis for reporting this.
 659
 660      -New parameter '--entab-leading-whitespace=n', or '-et=n', has been
 661       added for those who prefer tabs.  This behaves different from the
 662       existing '-t' parameter; see updated man page.  Suggested by Mark
 663       Olesen.
 664
 665      -New parameter '--perl-syntax-check-flags=s'  or '-pcsf=s' can be
 666       used to change the flags passed to perltidy in a syntax check.
 667       See updated man page.  Suggested by Mark Olesen.
 668
 669      -New parameter '--output-path=s'  or '-opath=s' will cause output
 670       files to be placed in directory s.  See updated man page.  Thanks for
 671       Mark Olesen for suggesting this.
 672
 673      -New parameter --dump-profile (or -dpro) will dump to
 674       standard output information about the search for a
 675       configuration file, the name of whatever configuration file
 676       is selected, and its contents.  This should help debugging
 677       config files, especially on different Windows systems.
 678
 679      -The -w parameter now notes possible errors of the form:
 680
 681             $comment = s/^\s*(\S+)\..*/$1/;   # trim whitespace
 682
 683      -Corrections added for a leading ':' and for leaving a leading 'tcsh'
 684       line untouched.  Mark Olesen reported that lines of this form were
 685       accepted by perl but not by perltidy:
 686
 687             : # use -*- perl -*-
 688             eval 'exec perl -wS $0 "$@"'  # shell should exec 'perl'
 689             unless 1;                     # but Perl should skip this one
 690
 691       Perl will silently swallow a leading colon on line 1 of a
 692       script, and now perltidy will do likewise.  For example,
 693       this is a valid script, provided that it is the first line,
 694       but not otherwise:
 695
 696             : print "Hello World\n";
 697
 698       Also, perltidy will now mark a first line with leading ':' followed by
 699       '#' as type SYSTEM (just as a #!  line), not to be formatted.
 700
 701      -List formatting improved for certain lists with special
 702       initial terms, such as occur with 'printf', 'sprintf',
 703       'push', 'pack', 'join', 'chmod'.  The special initial term is
 704       now placed on a line by itself.  For example, perltidy -gnu
 705
 706          OLD:
 707             $Addr = pack(
 708                          "C4",                hex($SourceAddr[0]),
 709                          hex($SourceAddr[1]), hex($SourceAddr[2]),
 710                          hex($SourceAddr[3])
 711                          );
 712
 713          NEW:
 714             $Addr = pack("C4",
 715                          hex($SourceAddr[0]), hex($SourceAddr[1]),
 716                          hex($SourceAddr[2]), hex($SourceAddr[3]));
 717
 718           OLD:
 719                 push (
 720                       @{$$self{states}}, '64', '66', '68',
 721                       '70',              '72', '74', '76',
 722                       '78',              '80', '82', '84',
 723                       '86',              '88', '90', '92',
 724                       '94',              '96', '98', '100',
 725                       '102',             '104'
 726                       );
 727
 728           NEW:
 729                 push (
 730                       @{$$self{states}},
 731                       '64', '66', '68', '70', '72',  '74',  '76',
 732                       '78', '80', '82', '84', '86',  '88',  '90',
 733                       '92', '94', '96', '98', '100', '102', '104'
 734                       );
 735
 736      -Lists of complex items, such as matricies, are now detected
 737       and displayed with just one item per row:
 738
 739         OLD:
 740         $this->{'CURRENT'}{'gfx'}{'MatrixSkew'} = Text::PDF::API::Matrix->new(
 741             [ 1, tan( deg2rad($a) ), 0 ], [ tan( deg2rad($b) ), 1, 0 ],
 742             [ 0, 0, 1 ]
 743         );
 744
 745         NEW:
 746         $this->{'CURRENT'}{'gfx'}{'MatrixSkew'} = Text::PDF::API::Matrix->new(
 747             [ 1,                  tan( deg2rad($a) ), 0 ],
 748             [ tan( deg2rad($b) ), 1,                  0 ],
 749             [ 0,                  0,                  1 ]
 750         );
 751
 752      -The perl syntax check will be turned off for now when input is from
 753       standard input or standard output.  The reason is that this requires
 754       temporary files, which has produced far too many problems during
 755       Windows testing.  For example, the POSIX module under Windows XP/2000
 756       creates temporary names in the root directory, to which only the
 757       administrator should have permission to write.
 758
 759      -Merged patch sent by Yves Orton to handle appropriate
 760       configuration file locations for different Windows varieties
 761       (2000, NT, Me, XP, 95, 98).
 762
 763      -Added patch to properly handle a for/foreach loop without
 764       parens around a list represented as a qw.  I didn't know this
 765       was possible until Wolfgang Weisselberg pointed it out:
 766
 767             foreach my $key qw\Uno Due Tres Quadro\ {
 768                 print "Set $key\n";
 769             }
 770
 771       But Perl will give a syntax error without the $ variable; ie this will
 772       not work:
 773
 774             foreach qw\Uno Due Tres Quadro\ {
 775                 print "Set $_\n";
 776             }
 777
 778      -Merged Windows version detection code sent by Yves Orton.  Perltidy
 779       now automatically turns off syntax checking for Win 9x/ME versions,
 780       and this has solved a lot of robustness problems.  These systems
 781       cannot reliably handle backtick operators.  See man page for
 782       details.
 783
 784      -Merged VMS filename handling patch sent by Michael Cartmell.  (Invalid
 785       output filenames were being created in some cases).
 786
 787      -Numerous minor improvements have been made for -lp style indentation.
 788
 789      -Long C-style 'for' expressions will be broken after each ';'.
 790
 791       'perltidy -gnu' gives:
 792
 793         OLD:
 794         for ($status = $db->seq($key, $value, R_CURSOR()) ; $status == 0
 795              and $key eq $origkey ; $status = $db->seq($key, $value, R_NEXT()))
 796
 797         NEW:
 798         for ($status = $db->seq($key, $value, R_CURSOR()) ;
 799              $status == 0 and $key eq $origkey ;
 800              $status = $db->seq($key, $value, R_NEXT()))
 801
 802      -For the -lp option, a single long term within parens
 803       (without commas) now has better alignment.  For example,
 804       perltidy -gnu
 805
 806                 OLD:
 807                 $self->throw("Must specify a known host, not $location,"
 808                       . " possible values ("
 809                       . join (",", sort keys %hosts) . ")");
 810
 811                 NEW:
 812                 $self->throw("Must specify a known host, not $location,"
 813                              . " possible values ("
 814                              . join (",", sort keys %hosts) . ")");
 815
 816   2001 12 31
 817      -This version is about 20 percent faster than the previous
 818       version as a result of optimization work.  The largest gain
 819       came from switching to a dispatch hash table in the
 820       tokenizer.
 821
 822      -perltidy -html will check to see if HTML::Entities is
 823       installed, and if so, it will use it to encode unsafe
 824       characters.
 825
 826      -Added flag -oext=ext to change the output file extension to
 827       be different from the default ('tdy' or 'html').  For
 828       example:
 829
 830         perltidy -html -oext=htm filename
 831
 832      will produce filename.htm
 833
 834      -Added flag -cscw to issue warnings if a closing side comment would replace
 835      an existing, different side comments.  See the man page for details.
 836      Thanks to Peter Masiar for helpful discussions.
 837
 838      -Corrected tokenization error of signed hex/octal/binary numbers. For
 839      example, the first hex number below would have been parsed correctly
 840      but the second one was not:
 841         if ( ( $tmp >= 0x80_00_00 ) || ( $tmp < -0x80_00_00 ) ) { }
 842
 843      -'**=' was incorrectly tokenized as '**' and '='.  This only
 844          caused a problem with the -extrude opton.
 845
 846      -Corrected a divide by zero when -extrude option is used
 847
 848      -The flag -w will now contain all errors reported by 'perl -c' on the
 849      input file, but otherwise they are not reported.  The reason is that
 850      perl will report lots of problems and syntax errors which are not of
 851      interest when only a small snippet is being formatted (such as missing
 852      modules and unknown bare words).  Perltidy will always report all
 853      significant syntax errors that it finds, such as unbalanced braces,
 854      unless the -q (quiet) flag is set.
 855
 856      -Merged modifications created by Hugh Myers into perltidy.
 857       These include a 'streamhandle' routine which allows perltidy
 858       as a module to operate on input and output arrays and strings
 859       in addition to files.  Documentation and new packaging as a
 860       module should be ready early next year; This is an elegant,
 861       powerful update; many thanks to Hugh for contributing it.
 862
 863   2001 11 28
 864      -added a tentative patch which tries to keep any existing breakpoints
 865      at lines with leading keywords map,sort,eval,grep. The idea is to
 866      improve formatting of sequences of list operations, as in a schwartzian
 867      transform.  Example:
 868
 869         INPUT:
 870         my @sorted = map { $_->[0] }
 871                      sort { $a->[1] <=> $b->[1] }
 872                      map { [ $_, rand ] } @list;
 873
 874         OLD:
 875         my @sorted =
 876           map { $_->[0] } sort { $a->[1] <=> $b->[1] } map { [ $_, rand ] } @list;
 877
 878         NEW:
 879         my @sorted = map { $_->[0] }
 880           sort { $a->[1] <=> $b->[1] }
 881           map { [ $_, rand ] } @list;
 882
 883       The new alignment is not as nice as the input, but this is an improvement.
 884       Thanks to Yves Orton for this suggestion.
 885
 886      -modified indentation logic so that a line with leading opening paren,
 887      brace, or square bracket will never have less indentation than the
 888      line with the corresponding opening token.  Here's a simple example:
 889
 890         OLD:
 891             $mw->Button(
 892                 -text    => "New Document",
 893                 -command => \&new_document
 894               )->pack(
 895                 -side   => 'bottom',
 896                 -anchor => 'e'
 897             );
 898
 899         Note how the closing ');' is lined up with the first line, even
 900         though it closes a paren in the 'pack' line.  That seems wrong.
 901
 902         NEW:
 903             $mw->Button(
 904                 -text    => "New Document",
 905                 -command => \&new_document
 906               )->pack(
 907                 -side   => 'bottom',
 908                 -anchor => 'e'
 909               );
 910
 911        This seems nicer: you can up-arrow with an editor and arrive at the
 912        opening 'pack' line.
 913
 914      -corrected minor glitch in which cuddled else (-ce) did not get applied
 915      to an 'unless' block, which should look like this:
 916
 917             unless ($test) {
 918
 919             } else {
 920
 921             }
 922
 923       Thanks to Jeremy Mates for reporting this.
 924
 925      -The man page has been reorganized to parameters easier to find.
 926
 927      -Added check for multiple definitions of same subroutine.  It is easy
 928       to introduce this problem when cutting and pasting. Perl does not
 929       complain about it, but it can lead to disaster.
 930
 931      -The command -pro=filename  or -profile=filename may be used to specify a
 932       configuration file which will override the default name of .perltidyrc.
 933       There must not be a space on either side of the '=' sign.  I needed
 934       this to be able to easily test perltidy with a variety of different
 935       configuration files.
 936
 937      -Side comment alignment has been improved somewhat across frequent level
 938       changes, as in short if/else blocks.  Thanks to Wolfgang Weisselberg
 939       for pointing out this problem.  For example:
 940
 941         OLD:
 942         if ( ref $self ) {    # Called as a method
 943             $format = shift;
 944         }
 945         else {    # Regular procedure call
 946             $format = $self;
 947             undef $self;
 948         }
 949
 950         NEW:
 951         if ( ref $self ) {    # Called as a method
 952             $format = shift;
 953         }
 954         else {                # Regular procedure call
 955             $format = $self;
 956             undef $self;
 957         }
 958
 959      -New command -ssc (--static-side-comment) and related command allows
 960       side comments to be spaced close to preceding character.  This is
 961       useful for displaying commented code as side comments.
 962
 963      -New command -csc (--closing-side-comment) and several related
 964       commands allow comments to be added to (and deleted from) any or all
 965       closing block braces.  This can be useful if you have to maintain large
 966       programs, especially those that you didn't write.  See updated man page.
 967       Thanks to Peter Masiar for this suggestion.  For a simple example:
 968
 969             perltidy -csc
 970
 971             sub foo {
 972                 if ( !defined( $_[0] ) ) {
 973                     print("Hello, World\n");
 974                 }
 975                 else {
 976                     print( $_[0], "\n" );
 977                 }
 978             } ## end sub foo
 979
 980       This added '## end sub foo' to the closing brace.
 981       To remove it, perltidy -ncsc.
 982
 983      -New commands -ola, for outdenting labels, and -okw, for outdenting
 984       selected control keywords, were implemented.  See the perltidy man
 985       page for details.  Thanks to Peter Masiar for this suggestion.
 986
 987      -Hanging side comment change: a comment will not be considered to be a
 988       hanging side comment if there is no leading whitespace on the line.
 989       This should improve the reliability of identifying hanging side comments.
 990       Thanks to Peter Masiar for this suggestion.
 991
 992      -Two new commands for outdenting, -olq (outdent-long-quotes) and -olc
 993       (outdent-long-comments), have been added.  The original -oll
 994       (outdent-long-lines) remains, and now is an abbreviation for -olq and -olc.
 995       The new default is just -olq.  This was necessary to avoid inconsistency with
 996       the new static block comment option.
 997
 998      -Static block comments:  to provide a way to display commented code
 999       better, the convention is used that comments with a leading '##' should
1000       not be formatted as usual.  Please see '-sbc' (or '--static-block-comment')
1001       for documentation.  It can be deactivated with with -nsbc, but
1002       should not normally be necessary. Thanks to Peter Masiar for this
1003       suggestion.
1004
1005      -Two changes were made to help show structure of complex lists:
1006       (1) breakpoints are forced after every ',' in a list where any of
1007       the list items spans multiple lines, and
1008       (2) List items which span multiple lines now get continuation indentation.
1009
1010       The following example illustrates both of these points.  Many thanks to
1011       Wolfgang Weisselberg for this snippet and a discussion of it; this is a
1012       significant formatting improvement. Note how it is easier to see the call
1013       parameters in the NEW version:
1014
1015         OLD:
1016         assert( __LINE__, ( not defined $check )
1017             or ref $check
1018             or $check eq "new"
1019             or $check eq "old", "Error in parameters",
1020             defined $old_new ? ( ref $old_new ? ref $old_new : $old_new ) : "undef",
1021             defined $db_new  ? ( ref $db_new  ? ref $db_new  : $db_new )  : "undef",
1022             defined $old_db ? ( ref $old_db ? ref $old_db : $old_db ) : "undef" );
1023
1024         NEW:
1025         assert(
1026             __LINE__,
1027             ( not defined $check )
1028               or ref $check
1029               or $check eq "new"
1030               or $check eq "old",
1031             "Error in parameters",
1032             defined $old_new ? ( ref $old_new ? ref $old_new : $old_new ) : "undef",
1033             defined $db_new  ? ( ref $db_new  ? ref $db_new  : $db_new )  : "undef",
1034             defined $old_db  ? ( ref $old_db  ? ref $old_db  : $old_db )  : "undef"
1035         );
1036
1037         Another example shows how this helps displaying lists:
1038
1039         OLD:
1040         %{ $self->{COMPONENTS} } = (
1041             fname =>
1042             { type => 'name', adj => 'yes', font => 'Helvetica', 'index' => 0 },
1043             street =>
1044             { type => 'road', adj => 'yes', font => 'Helvetica', 'index' => 2 },
1045         );
1046
1047         The structure is clearer with the added indentation:
1048
1049         NEW:
1050         %{ $self->{COMPONENTS} } = (
1051             fname =>
1052               { type => 'name', adj => 'yes', font => 'Helvetica', 'index' => 0 },
1053             street =>
1054               { type => 'road', adj => 'yes', font => 'Helvetica', 'index' => 2 },
1055         );
1056
1057         -The structure of nested logical expressions is now displayed better.
1058         Thanks to Wolfgang Weisselberg for helpful discussions.  For example,
1059         note how the status of the final 'or' is displayed in the following:
1060
1061         OLD:
1062         return ( !null($op)
1063               and null( $op->sibling )
1064               and $op->ppaddr eq "pp_null"
1065               and class($op) eq "UNOP"
1066               and ( ( $op->first->ppaddr =~ /^pp_(and|or)$/
1067                 and $op->first->first->sibling->ppaddr eq "pp_lineseq" )
1068                 or ( $op->first->ppaddr eq "pp_lineseq"
1069                     and not null $op->first->first->sibling
1070                     and $op->first->first->sibling->ppaddr eq "pp_unstack" ) ) );
1071
1072         NEW:
1073         return (
1074             !null($op)
1075               and null( $op->sibling )
1076               and $op->ppaddr eq "pp_null"
1077               and class($op) eq "UNOP"
1078               and (
1079                 (
1080                     $op->first->ppaddr =~ /^pp_(and|or)$/
1081                     and $op->first->first->sibling->ppaddr eq "pp_lineseq"
1082                 )
1083                 or ( $op->first->ppaddr eq "pp_lineseq"
1084                     and not null $op->first->first->sibling
1085                     and $op->first->first->sibling->ppaddr eq "pp_unstack" )
1086               )
1087         );
1088
1089        -A break will always be put before a list item containing a comma-arrow.
1090        This will improve formatting of mixed lists of this form:
1091
1092             OLD:
1093             $c->create(
1094                 'text', 225, 20, -text => 'A Simple Plot',
1095                 -font => $font,
1096                 -fill => 'brown'
1097             );
1098
1099             NEW:
1100             $c->create(
1101                 'text', 225, 20,
1102                 -text => 'A Simple Plot',
1103                 -font => $font,
1104                 -fill => 'brown'
1105             );
1106
1107       -For convenience, the command -dac (--delete-all-comments) now also
1108       deletes pod.  Likewise, -tac (--tee-all-comments) now also sends pod
1109       to a '.TEE' file.  Complete control over the treatment of pod and
1110       comments is still possible, as described in the updated help message
1111       and man page.
1112
1113       -The logic which breaks open 'containers' has been rewritten to be completely
1114       symmetric in the following sense: if a line break is placed after an opening
1115       {, [, or (, then a break will be placed before the corresponding closing
1116       token.  Thus, a container either remains closed or is completely cracked
1117       open.
1118
1119       -Improved indentation of parenthesized lists.  For example,
1120
1121                 OLD:
1122                 $GPSCompCourse =
1123                   int(
1124                   atan2( $GPSTempCompLong - $GPSLongitude,
1125                   $GPSLatitude - $GPSTempCompLat ) * 180 / 3.14159265 );
1126
1127                 NEW:
1128                 $GPSCompCourse = int(
1129                     atan2(
1130                         $GPSTempCompLong - $GPSLongitude,
1131                         $GPSLatitude - $GPSTempCompLat
1132                       ) * 180 / 3.14159265
1133                 );
1134
1135        Further improvements will be made in future releases.
1136
1137       -Some improvements were made in formatting small lists.
1138
1139       -Correspondence between Input and Output line numbers reported in a
1140        .LOG file should now be exact.  They were sometimes off due to the size
1141        of intermediate buffers.
1142
1143       -Corrected minor tokenization error in which a ';' in a foreach loop
1144        control was tokenized as a statement termination, which forced a
1145        line break:
1146
1147             OLD:
1148             foreach ( $i = 0;
1149                 $i <= 10;
1150                 $i += 2
1151               )
1152             {
1153                 print "$i ";
1154             }
1155
1156             NEW:
1157             foreach ( $i = 0 ; $i <= 10 ; $i += 2 ) {
1158                 print "$i ";
1159             }
1160
1161       -Corrected a problem with reading config files, in which quote marks were not
1162        stripped.  As a result, something like -wba="&& . || " would have the leading
1163        quote attached to the && and not work correctly.  A workaround for older
1164        versions is to place a space around all tokens within the quotes, like this:
1165        -wba=" && . || "
1166
1167       -Removed any existing space between a label and its ':'
1168         OLD    : { }
1169         NEW: { }
1170        This was necessary because the label and its colon are a single token.
1171
1172       -Corrected tokenization error for the following (highly non-recommended)
1173        construct:
1174         $user = @vars[1] / 100;
1175
1176       -Resolved cause of a difference between perltidy under perl v5.6.1 and
1177       5.005_03; the problem was different behavior of \G regex position
1178       marker(!)
1179
1180   2001 10 20
1181      -Corrected a bug in which a break was not being made after a full-line
1182      comment within a short eval/sort/map/grep block.  A flag was not being
1183      zeroed.  The syntax error check catches this.  Here is a snippet which
1184      illustrates the bug:
1185
1186             eval {
1187                 #open Socket to Dispatcher
1188                 $sock = &OpenSocket;
1189             };
1190
1191      The formatter mistakenly thought that it had found the following
1192      one-line block:
1193
1194             eval {#open Socket to Dispatcher$sock = &OpenSocket; };
1195
1196      The patch fixes this. Many thanks to Henry Story for reporting this bug.
1197
1198      -Changes were made to help diagnose and resolve problems in a
1199      .perltidyrc file:
1200        (1) processing of command parameters has been into two separate
1201        batches so that any errors in a .perltidyrc file can be localized.
1202        (2) commands --help, --version, and as many of the --dump-xxx
1203        commands are handled immediately, without any command line processing
1204        at all.
1205        (3) Perltidy will ignore any commands in the .perltidyrc file which
1206        cause immediate exit.  These are:  -h -v -ddf -dln -dop -dsn -dtt
1207        -dwls -dwrs -ss.  Thanks to Wolfgang Weisselberg for helpful
1208        suggestions regarding these updates.
1209
1210      -Syntax check has been reinstated as default for MSWin32 systems.  This
1211      way Windows 2000 users will get syntax check by default, which seems
1212      like a better idea, since the number of Win 95/98 systems will be
1213      decreasing over time.  Documentation revised to warn Windows 95/98
1214      users about the problem with empty '&1'.  Too bad these systems
1215      all report themselves as MSWin32.
1216
1217   2001 10 16
1218      -Fixed tokenization error in which a method call of the form
1219
1220         Module::->new();
1221
1222       got a space before the '::' like this:
1223
1224         Module ::->new();
1225
1226       Thanks to David Holden for reporting this.
1227
1228      -Added -html control over pod text, using a new abbreviation 'pd'.  See
1229      updated perl2web man page. The default is to use the color of a comment,
1230      but italicized.  Old .css style sheets will need a new line for
1231      .pd to use this.  The old color was the color of a string, and there
1232      was no control.
1233
1234      -.css lines are now printed in sorted order.
1235
1236      -Fixed interpolation problem where html files had '$input_file' as title
1237      instead of actual input file name.  Thanks to Simon Perreault for finding
1238      this and sending a patch, and also to Tobias Weber.
1239
1240      -Breaks will now have the ':' placed at the start of a line,
1241      one per line by default because this shows logical structure
1242      more clearly. This coding has been completely redone. Some
1243      examples of new ?/: formatting:
1244
1245            OLD:
1246                 wantarray ? map( $dir::cwd->lookup($_)->path, @_ ) :
1247                   $dir::cwd->lookup( $_[0] )->path;
1248
1249            NEW:
1250                 wantarray
1251                   ? map( $dir::cwd->lookup($_)->path, @_ )
1252                   : $dir::cwd->lookup( $_[0] )->path;
1253
1254            OLD:
1255                     $a = ( $b > 0 ) ? {
1256                         a => 1,
1257                         b => 2
1258                     } : { a => 6, b => 8 };
1259
1260            NEW:
1261                     $a = ( $b > 0 )
1262                       ? {
1263                         a => 1,
1264                         b => 2
1265                       }
1266                       : { a => 6, b => 8 };
1267
1268         OLD: (-gnu):
1269         $self->note($self->{skip} ? "Hunk #$self->{hunk} ignored at 1.\n" :
1270                     "Hunk #$self->{hunk} failed--$@");
1271
1272         NEW: (-gnu):
1273         $self->note($self->{skip}
1274                     ? "Hunk #$self->{hunk} ignored at 1.\n"
1275                     : "Hunk #$self->{hunk} failed--$@");
1276
1277         OLD:
1278             $which_search =
1279               $opts{"t"} ? 'title'   :
1280               $opts{"s"} ? 'subject' : $opts{"a"} ? 'author' : 'title';
1281
1282         NEW:
1283             $which_search =
1284               $opts{"t"} ? 'title'
1285               : $opts{"s"} ? 'subject'
1286               : $opts{"a"} ? 'author'
1287               : 'title';
1288
1289      You can use -wba=':' to recover the previous default which placed ':'
1290      at the end of a line.  Thanks to Michael Cartmell for helpful
1291      discussions and examples.
1292
1293      -Tokenizer updated to do syntax checking for matched ?/: pairs.  Also,
1294      the tokenizer now outputs a unique serial number for every balanced
1295      pair of brace types and ?/: pairs.  This greatly simplifies the
1296      formatter.
1297
1298      -Long lines with repeated 'and', 'or', '&&', '||'  will now have
1299      one such item per line.  For example:
1300
1301         OLD:
1302             if ( $opt_d || $opt_m || $opt_p || $opt_t || $opt_x
1303                 || ( -e $archive && $opt_r ) )
1304             {
1305                 ( $pAr, $pNames ) = readAr($archive);
1306             }
1307
1308         NEW:
1309             if ( $opt_d
1310                 || $opt_m
1311                 || $opt_p
1312                 || $opt_t
1313                 || $opt_x
1314                 || ( -e $archive && $opt_r ) )
1315             {
1316                 ( $pAr, $pNames ) = readAr($archive);
1317             }
1318
1319        OLD:
1320             if ( $vp->{X0} + 4 <= $x && $vp->{X0} + $vp->{W} - 4 >= $x
1321                 && $vp->{Y0} + 4 <= $y && $vp->{Y0} + $vp->{H} - 4 >= $y )
1322
1323        NEW:
1324             if ( $vp->{X0} + 4 <= $x
1325                 && $vp->{X0} + $vp->{W} - 4 >= $x
1326                 && $vp->{Y0} + 4 <= $y
1327                 && $vp->{Y0} + $vp->{H} - 4 >= $y )
1328
1329      -Long lines with multiple concatenated tokens will have concatenated
1330      terms (see below) placed one per line, except for short items.  For
1331      example:
1332
1333        OLD:
1334             $report .=
1335               "Device type:" . $ib->family . "  ID:" . $ib->serial . "  CRC:"
1336               . $ib->crc . ": " . $ib->model() . "\n";
1337
1338        NEW:
1339             $report .= "Device type:"
1340               . $ib->family . "  ID:"
1341               . $ib->serial . "  CRC:"
1342               . $ib->model()
1343               . $ib->crc . ": " . "\n";
1344
1345      NOTE: at present 'short' means 8 characters or less.  There is a
1346      tentative flag to change this (-scl), but it is undocumented and
1347      is likely to be changed or removed later, so only use it for testing.
1348      In the above example, the tokens "  ID:", "  CRC:", and "\n" are below
1349      this limit.
1350
1351      -If a line which is short enough to fit on a single line was
1352      nevertheless broken in the input file at a 'good' location (see below),
1353      perltidy will try to retain a break.  For example, the following line
1354      will be formatted as:
1355
1356         open SUM, "<$file"
1357           or die "Cannot open $file ($!)";
1358
1359      if it was broken in the input file, and like this if not:
1360
1361         open SUM, "<$file" or die "Cannot open $file ($!)";
1362
1363      GOOD: 'good' location means before 'and','or','if','unless','&&','||'
1364
1365      The reason perltidy does not just always break at these points is that if
1366      there are multiple, similar statements, this would preclude alignment.  So
1367      rather than check for this, perltidy just tries to follow the input style,
1368      in the hopes that the author made a good choice. Here is an example where
1369      we might not want to break before each 'if':
1370
1371         ($Locale, @Locale) = ($English, @English) if (@English > @Locale);
1372         ($Locale, @Locale) = ($German,  @German)  if (@German > @Locale);
1373         ($Locale, @Locale) = ($French,  @French)  if (@French > @Locale);
1374         ($Locale, @Locale) = ($Spanish, @Spanish) if (@Spanish > @Locale);
1375
1376      -Added wildcard file expansion for systems with shells which lack this.
1377      Now 'perltidy *.pl' should work under MSDOS/Windows.  Thanks to Hugh Myers
1378      for suggesting this.  This uses builtin glob() for now; I may change that.
1379
1380      -Added new flag -sbl which, if specified, overrides the value of -bl
1381      for opening sub braces.  This allows formatting of this type:
1382
1383      perltidy -sbl
1384
1385      sub foo
1386      {
1387         if (!defined($_[0])) {
1388             print("Hello, World\n");
1389         }
1390         else {
1391             print($_[0], "\n");
1392         }
1393      }
1394      Requested by Don Alexander.
1395
1396      -Fixed minor parsing error which prevented a space after a $$ variable
1397      (pid) in some cases.  Thanks to Michael Cartmell for noting this.
1398      For example,
1399        old: $$< 700
1400        new: $$ < 700
1401
1402      -Improved line break choices 'and' and 'or' to display logic better.
1403      For example:
1404
1405         OLD:
1406             exists $self->{'build_dir'} and push @e,
1407               "Unwrapped into directory $self->{'build_dir'}";
1408
1409         NEW:
1410             exists $self->{'build_dir'}
1411               and push @e, "Unwrapped into directory $self->{'build_dir'}";
1412
1413      -Fixed error of multiple use of abbreviatioin '-dsc'.  -dsc remains
1414      abbreviation for delete-side-comments; -dsm is new abbreviation for
1415      delete-semicolons.
1416
1417      -Corrected and updated 'usage' help routine.  Thanks to Slaven Rezic for
1418      noting an error.
1419
1420      -The default for Windows is, for now, not to do a 'perl -c' syntax
1421      check (but -syn will activate it).  This is because of problems with
1422      command.com.  James Freeman sent me a patch which tries to get around
1423      the problems, and it works in many cases, but testing revealed several
1424      issues that still need to be resolved.  So for now, the default is no
1425      syntax check for Windows.
1426
1427      -I added a -T flag when doing perl -c syntax check.
1428      This is because I test it on a large number of scripts from sources
1429      unknown, and who knows what might be hidden in initialization blocks?
1430      Also, deactivated the syntax check if perltidy is run as root.  As a
1431      benign example, running the previous version of perltidy on the
1432      following file would cause it to disappear:
1433
1434             BEGIN{
1435                     print "Bye, bye baby!\n";
1436                     unlink $0;
1437             }
1438
1439      The new version will not let that happen.
1440
1441      -I am contemplating (but have not yet implemented) making '-lp' the
1442      default indentation, because it is stable now and may be closer to how
1443      perl is commonly formatted.  This could be in the next release.  The
1444      reason that '-lp' was not the original default is that the coding for
1445      it was complex and not ready for the initial release of perltidy.  If
1446      anyone has any strong feelings about this, I'd like to hear.  The
1447      current default could always be recovered with the '-nlp' flag.
1448
1449   2001 09 03
1450      -html updates:
1451          - sub definition names are now specially colored, red by default.
1452            The letter 'm' is used to identify them.
1453          - keyword 'sub' now has color of other keywords.
1454          - restored html keyword color to __END__ and __DATA__, which was
1455            accidentally removed in the previous version.
1456
1457      -A new -se (--standard-error-output) flag has been implemented and
1458      documented which causes all errors to be written to standard output
1459      instead of a .ERR file.
1460
1461      -A new -w (--warning-output) flag has been implemented and documented
1462       which causes perltidy to output certain non-critical messages to the
1463       error output file, .ERR.  These include complaints about pod usage,
1464       for example.  The default is to not include these.
1465
1466       NOTE: This replaces an undocumented -w=0 or --warning-level flag
1467       which was tentatively introduced in the previous version to avoid some
1468       unwanted messages.  The new default is the same as the old -w=0, so
1469       that is no longer needed.
1470
1471       -Improved syntax checking and corrected tokenization of functions such
1472       as rand, srand, sqrt, ...  These can accept either an operator or a term
1473       to their right.  This has been corrected.
1474
1475      -Corrected tokenization of semicolon: testing of the previous update showed
1476      that the semicolon in the following statement was being mis-tokenized.  That
1477      did no harm, other than adding an extra blank space, but has been corrected.
1478
1479               for (sort {strcoll($a,$b);} keys %investments) {
1480                  ...
1481               }
1482
1483      -New syntax check: after wasting 5 minutes trying to resolve a syntax
1484       error in which I had an extra terminal ';' in a complex for (;;) statement,
1485       I spent a few more minutes adding a check for this in perltidy so it won't
1486       happen again.
1487
1488      -The behavior of --break-before-subs (-bbs) and --break-before-blocks
1489      (-bbb) has been modified.  Also, a new control parameter,
1490      --long-block-line-count=n (-lbl=n) has been introduced to give more
1491      control on -bbb.  This was previously a hardwired value.  The reason
1492      for the change is to reduce the number of unwanted blank lines that
1493      perltidy introduces, and make it less erratic.  It's annoying to remove
1494      an unwanted blank line and have perltidy put it back.  The goal is to
1495      be able to sprinkle a few blank lines in that dense script you
1496      inherited from Bubba.  I did a lot of experimenting with different
1497      schemes for introducing blank lines before and after code blocks, and
1498      decided that there is no really good way to do it.  But I think the new
1499      scheme is an improvement.  You can always deactivate this with -nbbb.
1500      I've been meaning to work on this; thanks to Erik Thaysen for bringing
1501      it to my attention.
1502
1503      -The .LOG file is seldom needed, and I get tired of deleting them, so
1504       they will now only be automatically saved if perltidy thinks that it
1505       made an error, which is almost never.  You can still force the logfile
1506       to be saved with -log or -g.
1507
1508      -Improved method for computing number of columns in a table.  The old
1509      method always tried for an even number.  The new method allows odd
1510      numbers when it is obvious that a list is not a hash initialization
1511      list.
1512
1513        old: my (
1514                  $name,       $xsargs, $parobjs, $optypes,
1515                  $hasp2child, $pmcode, $hdrcode, $inplacecode,
1516                  $globalnew,  $callcopy
1517               )
1518               = @_;
1519
1520        new: my (
1521                  $name,   $xsargs,  $parobjs,     $optypes,   $hasp2child,
1522                  $pmcode, $hdrcode, $inplacecode, $globalnew, $callcopy
1523               )
1524               = @_;
1525
1526      -I fiddled with the list threshold adjustment, and some small lists
1527      look better now.  Here is the change for one of the lists in test file
1528      'sparse.t':
1529      old:
1530        %units =
1531          ("in", "in", "pt", "pt", "pc", "pi", "mm", "mm", "cm", "cm", "\\hsize", "%",
1532            "\\vsize", "%", "\\textwidth", "%", "\\textheight", "%");
1533
1534      new:
1535        %units = (
1536                   "in",      "in", "pt",          "pt", "pc",           "pi",
1537                   "mm",      "mm", "cm",          "cm", "\\hsize",      "%",
1538                   "\\vsize", "%",  "\\textwidth", "%",  "\\textheight", "%"
1539                   );
1540
1541      -Improved -lp formatting at '=' sign.  A break was always being added after
1542      the '=' sign in a statement such as this, (to be sure there was enough room
1543      for the parameters):
1544
1545      old: my $fee =
1546             CalcReserveFee(
1547                             $env,          $borrnum,
1548                             $biblionumber, $constraint,
1549                             $bibitems
1550                             );
1551
1552      The updated version doesn't do this unless the space is really needed:
1553
1554      new: my $fee = CalcReserveFee(
1555                                    $env,          $borrnum,
1556                                    $biblionumber, $constraint,
1557                                    $bibitems
1558                                    );
1559
1560      -I updated the tokenizer to allow $#+ and $#-, which seem to be new to
1561      Perl 5.6.  Some experimenting with a recent version of Perl indicated
1562      that it allows these non-alphanumeric '$#' array maximum index
1563      varaibles: $#: $#- $#+ so I updated the parser accordingly.  Only $#:
1564      seems to be valid in older versions of Perl.
1565
1566      -Fixed a rare formatting problem with -lp (and -gnu) which caused
1567      excessive indentation.
1568
1569      -Many additional syntax checks have been added.
1570
1571      -Revised method for testing here-doc target strings; the following
1572      was causing trouble with a regex test because of the '*' characters:
1573       print <<"*EOF*";
1574       bla bla
1575       *EOF*
1576      Perl seems to allow almost anything to be a here doc target, so an
1577      exact string comparison is now used.
1578
1579      -Made update to allow underscores in binary numbers, like '0b1100_0000'.
1580
1581      -Corrected problem with scanning certain module names; a blank space was
1582      being inserted after 'warnings' in the following:
1583         use warnings::register;
1584      The problem was that warnings (and a couple of other key modules) were
1585      being tokenized as keywords.  They should have just been identifiers.
1586
1587      -Corrected tokenization of indirect objects after sort, system, and exec,
1588      after testing produced an incorrect error message for the following
1589      line of code:
1590         print sort $sortsubref @list;
1591
1592      -Corrected minor problem where a line after a format had unwanted
1593      extra continuation indentation.
1594
1595      -Delete-block-comments (and -dac) now retain any leading hash-bang line
1596
1597      -Update for -lp (and -gnu) to not align the leading '=' of a list
1598      with a previous '=', since this interferes with alignment of parameters.
1599
1600       old:  my $hireDay = new Date;
1601             my $self    = {
1602                          firstName => undef,
1603                          lastName  => undef,
1604                          hireDay   => $hireDay
1605                          };
1606
1607       new:  my $hireDay = new Date;
1608             my $self = {
1609                          firstName => undef,
1610                          lastName  => undef,
1611                          hireDay   => $hireDay
1612                          };
1613
1614      -Modifications made to display tables more compactly when possible,
1615       without adding lines. For example,
1616       old:
1617                     '1', "I", '2', "II", '3', "III", '4', "IV",
1618                     '5', "V", '6', "VI", '7', "VII", '8', "VIII",
1619                     '9', "IX"
1620       new:
1621                     '1', "I",   '2', "II",   '3', "III",
1622                     '4', "IV",  '5', "V",    '6', "VI",
1623                     '7', "VII", '8', "VIII", '9', "IX"
1624
1625      -Corrected minor bug in which -pt=2 did not keep the right paren tight
1626      around a '++' or '--' token, like this:
1627
1628                 for ($i = 0 ; $i < length $key ; $i++ )
1629
1630      The formatting for this should be, and now is:
1631
1632                 for ($i = 0 ; $i < length $key ; $i++)
1633
1634      Thanks to Erik Thaysen for noting this.
1635
1636      -Discovered a new bug involving here-docs during testing!  See BUGS.html.
1637
1638      -Finally fixed parsing of subroutine attributes (A Perl 5.6 feature).
1639      However, the attributes and prototypes must still be on the same line
1640      as the sub name.
1641
1642   2001 07 31
1643      -Corrected minor, uncommon bug found during routine testing, in which a
1644      blank got inserted between a function name and its opening paren after
1645      a file test operator, but only in the case that the function had not
1646      been previously seen.  Perl uses the existance (or lack thereof) of
1647      the blank to guess if it is a function call.  That is,
1648         if (-l pid_filename()) {
1649      became
1650         if (-l pid_filename ()) {
1651      which is a syntax error if pid_filename has not been seen by perl.
1652
1653      -If the AutoLoader module is used, perltidy will continue formatting
1654      code after seeing an __END__ line.  Use -nlal to deactivate this feature.
1655      Likewise, if the SelfLoader module is used, perltidy will continue
1656      formatting code after seeing a __DATA__ line.  Use -nlsl to
1657      deactivate this feature.  Thanks to Slaven Rezic for this suggestion.
1658
1659      -pod text after __END__ and __DATA__ is now identified by perltidy
1660      so that -dp works correctly.  Thanks to Slaven Rezic for this suggestion.
1661
1662      -The first $VERSION line which might be eval'd by MakeMaker
1663      is now passed through unchanged.  Use -npvl to deactivate this feature.
1664      Thanks to Manfred Winter for this suggestion.
1665
1666      -Improved indentation of nested parenthesized expressions.  Tests have
1667      given favorable results.  Thanks to Wolfgang Weisselberg for helpful
1668      examples.
1669
1670   2001 07 23
1671      -Fixed a very rare problem in which an unwanted semicolon was inserted
1672      due to misidentification of anonymous hash reference curly as a code
1673      block curly.  (No instances of this have been reported; I discovered it
1674      during testing).  A workaround for older versions of perltidy is to use
1675      -nasc.
1676
1677      -Added -icb (-indent-closing-brace) parameter to indent a brace which
1678      terminates a code block to the same level as the previous line.
1679      Suggested by Andrew Cutler.  For example,
1680
1681             if ($task) {
1682                 yyy();
1683                 }    # -icb
1684             else {
1685                 zzz();
1686                 }
1687
1688      -Rewrote error message triggered by an unknown bareword in a print or
1689      printf filehandle position, and added flag -w=0 to prevent issuing this
1690      error message.  Suggested by Byron Jones.
1691
1692      -Added modification to align a one-line 'if' block with similar
1693      following 'elsif' one-line blocks, like this:
1694           if    ( $something eq "simple" )  { &handle_simple }
1695           elsif ( $something eq "hard" )    { &handle_hard }
1696      (Suggested by  Wolfgang Weisselberg).
1697
1698   2001 07 02
1699      -Eliminated all constants with leading underscores because perl 5.005_03
1700      does not support that.  For example, _SPACES changed to XX_SPACES.
1701      Thanks to kromJx for this update.
1702
1703   2001 07 01
1704      -the directory of test files has been moved to a separate distribution
1705      file because it is getting large but is of little interest to most users.
1706      For the current distribution:
1707        perltidy-20010701.tgz        contains the source and docs for perltidy
1708        perltidy-20010701-test.tgz   contains the test files
1709
1710      -fixed bug where temporary file perltidy.TMPI was not being deleted
1711      when input was from stdin.
1712
1713      -adjusted line break logic to not break after closing brace of an
1714      eval block (suggested by Boris Zentner).
1715
1716      -added flag -gnu (--gnu-style) to give an approximation to the GNU
1717      style as sometimes applied to perl.  The programming style in GNU
1718      'automake' was used as a guide in setting the parameters; these
1719      parameters will probably be adjusted over time.
1720
1721      -an empty code block now has one space for emphasis:
1722        if ( $cmd eq "bg_untested" ) {}    # old
1723        if ( $cmd eq "bg_untested" ) { }   # new
1724      If this bothers anyone, we could create a parameter.
1725
1726      -the -bt (--brace-tightness) parameter has been split into two
1727      parameters to give more control. -bt now applies only to non-BLOCK
1728      braces, while a new parameter -bbt (block-brace-tightness) applies to
1729      curly braces which contain code BLOCKS. The default value is -bbt=0.
1730
1731      -added flag -icp (--indent-closing-paren) which leaves a statment
1732      termination of the form );, };, or ]; indented with the same
1733      indentation as the previous line.  For example,
1734
1735         @month_of_year = (          # default, or -nicp
1736             'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct',
1737             'Nov', 'Dec'
1738         );
1739
1740         @month_of_year = (          # -icp
1741             'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct',
1742             'Nov', 'Dec'
1743             );
1744
1745      -Vertical alignment updated to synchronize with tokens &&, ||,
1746      and, or, if, unless.  Allowable space before forcing
1747      resynchronization has been increased.  (Suggested by  Wolfgang
1748      Weisselberg).
1749
1750      -html corrected to use -nohtml-bold-xxxxxxx or -nhbx to negate bold,
1751      and likewise -nohtml-italic-xxxxxxx or -nhbi to negate italic.  There
1752      was no way to negate these previously.  html documentation updated and
1753      corrected.  (Suggested by  Wolfgang Weisselberg).
1754
1755      -Some modifications have been made which improve the -lp formatting in
1756      a few cases.
1757
1758      -Perltidy now retains or creates a blank line after an =cut to keep
1759      podchecker happy (Suggested by Manfred H. Winter).  This appears to be
1760      a glitch in podchecker, but it was annoying.
1761
1762   2001 06 17
1763      -Added -bli flag to give continuation indentation to braces, like this
1764
1765             if ($bli_flag)
1766               {
1767                 extra_indentation();
1768               }
1769
1770      -Corrected an error with the tab (-t) option which caused the last line
1771      of a multi-line quote to receive a leading tab.  This error was in
1772      version 2001 06 08  but not 2001 04 06.  If you formatted a script
1773      with -t with this version, please check it by running once with the
1774      -chk flag and perltidy will scan for this possible error.
1775
1776      -Corrected an invalid pattern (\R should have been just R), changed
1777      $^W =1 to BEGIN {$^W=1} to use warnings in compile phase, and corrected
1778      several unnecessary 'my' declarations. Many thanks to Wolfgang Weisselberg,
1779      2001-06-12, for catching these errors.
1780
1781      -A '-bar' flag has been added to require braces to always be on the
1782      right, even for multi-line if and foreach statements.  For example,
1783      the default formatting of a long if statement would be:
1784
1785             if ($bigwasteofspace1 && $bigwasteofspace2
1786               || $bigwasteofspace3 && $bigwasteofspace4)
1787             {
1788                 bigwastoftime();
1789             }
1790
1791      With -bar, the formatting is:
1792
1793             if ($bigwasteofspace1 && $bigwasteofspace2
1794               || $bigwasteofspace3 && $bigwasteofspace4) {
1795                 bigwastoftime();
1796             }
1797      Suggested by Eli Fidler 2001-06-11.
1798
1799      -Uploaded perltidy to sourceforge cvs 2001-06-10.
1800
1801      -An '-lp' flag (--line-up-parentheses) has been added which causes lists
1802      to be indented with extra indentation in the manner sometimes
1803      associated with emacs or the GNU suggestions.  Thanks to Ian Stuart for
1804      this suggestion and for extensive help in testing it.
1805
1806      -Subroutine call parameter lists are now formatted as other lists.
1807      This should improve formatting of tables being passed via subroutine
1808      calls.  This will also cause full indentation ('-i=n, default n= 4) of
1809      continued parameter list lines rather than just the number of spaces
1810      given with -ci=n, default n=2.
1811
1812      -Added support for hanging side comments.  Perltidy identifies a hanging
1813      side comment as a comment immediately following a line with a side
1814      comment or another hanging side comment.  This should work in most
1815      cases.  It can be deactivated with --no-hanging-side-comments (-nhsc).
1816      The manual has been updated to discuss this.  Suggested by Brad
1817      Eisenberg some time ago, and finally implemented.
1818
1819   2001 06 08
1820      -fixed problem with parsing command parameters containing quoted
1821      strings in .perltidyrc files. (Reported by Roger Espel Llima 2001-06-07).
1822
1823      -added two command line flags, --want-break-after and
1824      --want-break-before, which allow changing whether perltidy
1825      breaks lines before or after any operators.  Please see the revised
1826      man pages for details.
1827
1828      -added system-wide configuration file capability.
1829      If perltidy does not find a .perltidyrc command line file in
1830      the current directory, nor in the home directory, it now looks
1831      for '/usr/local/etc/perltidyrc' and then for '/etc/perltidyrc'.
1832      (Suggested by Roger Espel Llima 2001-05-31).
1833
1834      -fixed problem in which spaces were trimmed from lines of a multi-line
1835      quote. (Reported by Roger Espel Llima 2001-05-30).  This is an
1836      uncommon situation, but serious, because it could conceivably change
1837      the proper function of a script.
1838
1839      -fixed problem in which a semicolon was incorrectly added within
1840      an anonymous hash.  (Reported by A.C. Yardley, 2001-5-23).
1841      (You would know if this happened, because perl would give a syntax
1842      error for the resulting script).
1843
1844      -fixed problem in which an incorrect error message was produced
1845       after a version number on a 'use' line, like this ( Reported
1846       by Andres Kroonmaa, 2001-5-14):
1847
1848                   use CGI 2.42 qw(fatalsToBrowser);
1849
1850       Other than the extraneous error message, this bug was harmless.
1851
1852   2001 04 06
1853      -fixed serious bug in which the last line of some multi-line quotes or
1854       patterns was given continuation indentation spaces.  This may make
1855       a pattern incorrect unless it uses the /x modifier.  To find
1856       instances of this error in scripts which have been formatted with
1857       earlier versions of perltidy, run with the -chk flag, which has
1858       been added for this purpose (SLH, 2001-04-05).
1859
1860       ** So, please check previously formatted scripts by running with -chk
1861       at least once **
1862
1863      -continuation indentation has been reprogrammed to be hierarchical,
1864       which improves deeply nested structures.
1865
1866      -fixed problem with undefined value in list formatting (reported by Michael
1867       Langner 2001-04-05)
1868
1869      -Switched to graphical display of nesting in .LOG files.  If an
1870       old format string was "(1 [0 {2", the new string is "{{(".  This
1871       is easier to read and also shows the order of nesting.
1872
1873      -added outdenting of cuddled paren structures, like  ")->pack(".
1874
1875      -added line break and outdenting of ')->' so that instead of
1876
1877             $mw->Label(
1878               -text   => "perltidy",
1879               -relief => 'ridge')->pack;
1880
1881       the current default is:
1882
1883             $mw->Label(
1884               -text   => "perltidy",
1885               -relief => 'ridge'
1886             )->pack;
1887
1888       (requested by Michael Langner 2001-03-31; in the future this could
1889       be controlled by a command-line parameter).
1890
1891      -revised list indentation logic, so that lists following an assignment
1892       operator get one full indentation level, rather than just continuation
1893       indentation.  Also corrected some minor glitches in the continuation
1894       indentation logic.
1895
1896      -Fixed problem with unwanted continuation indentation after a blank line
1897      (reported by Erik Thaysen 2001-03-28):
1898
1899      -minor update to avoid stranding a single '(' on one line
1900
1901   2001 03 28:
1902      -corrected serious error tokenizing filehandles, in which a sub call
1903      after a print or printf, like this:
1904         print usage() and exit;
1905      became this:
1906         print usage () and exit;
1907      Unfortunately, this converts 'usage' to a filehandle.  To fix this, rerun
1908      perltidy; it will look for this situation and issue a warning.
1909
1910      -fixed another cuddled-else formatting bug (Reported by Craig Bourne)
1911
1912      -added several diagnostic --dump routines
1913
1914      -added token-level whitespace controls (suggested by Hans Ecke)
1915
1916   2001 03 23:
1917      -added support for special variables of the form ${^WANT_BITS}
1918
1919      -space added between scalar and left paren in 'for' and 'foreach' loops,
1920       (suggestion by Michael Cartmell):
1921
1922         for $i( 1 .. 20 )   # old
1923         for $i ( 1 .. 20 )   # new
1924
1925      -html now outputs cascading style sheets (thanks to suggestion from
1926       Hans Ecke)
1927
1928      -flags -o and -st now work with -html
1929
1930      -added missing -html documentation for comments (noted by Alex Izvorski)
1931
1932      -support for VMS added (thanks to Michael Cartmell for code patches and
1933        testing)
1934
1935      -v-strings implemented (noted by Hans Ecke and Michael Cartmell; extensive
1936        testing by Michael Cartmell)
1937
1938      -fixed problem where operand may be empty at line 3970
1939       (\b should be just b in lines 3970, 3973) (Thanks to Erik Thaysen,
1940       Keith Marshall for bug reports)
1941
1942      -fixed -ce bug (cuddled else), where lines like '} else {' were indented
1943       (Thanks to Shawn Stepper and Rick Measham for reporting this)
1944
1945   2001 03 04:
1946      -fixed undefined value in line 153 (only worked with -I set)
1947      (Thanks to Mike Stok, Phantom of the Opcodes, Ian Ehrenwald, and others)
1948
1949      -fixed undefined value in line 1069 (filehandle problem with perl versions <
1950      5.6) (Thanks to Yuri Leikind, Mike Stok, Michael Holve, Jeff Kolber)
1951
1952   2001 03 03:
1953      -Initial announcement at freshmeat.net; started Change Log
1954      (Unfortunately this version was DOA, but it was fixed the next day)