]> git.donarmstrong.com Git - perltidy.git/blobdiff - BUGS
New upstream release (closes: #613417)
[perltidy.git] / BUGS
diff --git a/BUGS b/BUGS
index 79b8b44110c69444fab8fab2fa36ec6344a42a22..f43ea14b37a3dc0cfaa0b95b658ada20526522fd 100644 (file)
--- a/BUGS
+++ b/BUGS
@@ -1,18 +1,31 @@
 Perltidy open BUGS
-     You can help perltidy evolve into a better program.  If you think you
-     have hit a bug or weird behavior, or have a suggested improvement,
-     please send a note to perltidy at users.sourceforge.net.
-
-     This file only lists open bugs.  For bugs which have been fixed, 
-     see the ChangeLog.  
-
-  A here-doc invoked through an 'e' modifier on a pattern replacement text is not recognized
-    For example, the output of perltidy for this script has a syntax error:
-
-            my $text="Hello World!\n";
-            $text =~ s@Hello@<<'END'@e;
-            Goodbye 
-            Cruel
-            END
-            print "$text\n";
+    You can help perltidy evolve into a better program. If you think you
+    have hit a bug or weird behavior, or have a suggested improvement,
+    please send a note to perltidy at users.sourceforge.net.
+
+    This file only lists open bugs. For bugs which have been fixed, see the
+    ChangeLog.
+
+  The --extrude option can produce code with syntax errors
+    The --extrude tries to put as many newlines in the formatted code as
+    possible. This option is very useful for testing perltidy but not for
+    actual formatting. Occasionally it will produce code which Perl
+    considers to have a syntax error. These problems usually involve code
+    where Perl is having to guess the tokenization based on whitespace.
+    Since the --extrude option is typically only used for testing perltidy,
+    this type of error should not normally occur in practice.
+
+  In some rare instances the formatting can oscillate between two states
+    The following example was sent by Denis Moskowitz, Oct 29 2010:
+
+    grep { $_->foo ne 'bar' } # asdfa asdf asdf asdf asdf asdf asdf asdf
+    asdf asdf asdf @baz;
+
+    With standard parameters this oscillates between the above and:
+
+    grep { $_->foo ne 'bar' } # asdfa asdf asdf asdf asdf asdf asdf asdf
+    asdf asdf asdf @baz;
+
+    A workaround here would be to make a slight change to the side comment
+    length.