]> git.donarmstrong.com Git - perltidy.git/blob - BUGS
* New upstream release
[perltidy.git] / BUGS
1 Perltidy open BUGS and LIMITATIONS
2     You can help perltidy evolve into a better program. If you think you
3     have hit a bug or weird behavior, or have a suggested improvement,
4     please send a note to perltidy at users.sourceforge.net.
5
6     This file only lists open bugs. For bugs which have been fixed, see the
7     ChangeLog.
8
9   The --extrude and --mangle options can produce code with syntax errors
10     The --extrude tries to put as many newlines in the formatted code as
11     possible. The --mangle tries to remove as many newlines as possible.
12     These options are very useful for stress testing perltidy (and Perl) but
13     not so much for normal formatting. Occasionally they will produce code
14     which Perl considers to have a syntax error. These problems often
15     involve code where Perl is having to guess the tokenization based on
16     whitespace. The given/when and switch/case statements are also
17     particularly vulnerable to unusual line breaks and whitespace. This type
18     of error should not normally occur in practice, but if it does it should
19     be easy to fix the problem by rerunning perltidy with more normal
20     parameters or by manually changing whitespace or newlines.
21
22   The Pod:Html module has some bugs
23     For the most part Pod::Html works very well and is very convenient
24     because it part of the standard Perl distribution. But for example the
25     following line
26
27       =item B<< <Deck> = Session->new_cflt_deck; >>
28
29     which uses double brackets to contain single brackets does not render
30     correctly.
31
32   Perltidy does not handle UTF-8 encoded files
33   Two iterations are sometimes needed
34     Usually the code produced by perltidy on the first pass does not change
35     if it is run again, but sometimes a second pass will produce some small
36     additional change. This mainly happens if a major style change is made,
37     particularly when perltidy is untangling complex ternary statements. Use
38     the iteration parameter -it=2 if it is important that the results be
39     unchanged on subsequent passes, but note that this doubles the run time.
40
41   Latest Bug and Wishlist at CPAN:
42     For the latest list of bugs and feature requests at CPAN see:
43
44     https://rt.cpan.org/Public/Dist/Display.html?Name=Perl-Tidy
45