New upstream release (closes: #613417)

[perltidy.git] / BUGS

diff --git a/BUGS b/BUGS
index 5689aca83634ae5785c0ef39dca52e815c1f94d1..f43ea14b37a3dc0cfaa0b95b658ada20526522fd 100644 (file)
--- a/BUGS
+++ b/BUGS
@@ -1,10 +1,10 @@
 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.
+    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.  
+    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
@@ -15,3 +15,17 @@ Perltidy open BUGS
     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.
+