From: Steve Hancock <perltidy@users.sourceforge.net>
Date: Mon, 12 Oct 2020 14:07:35 +0000 (-0700)
Subject: update docs
X-Git-Tag: 20201001.03~89
X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=8509fa4e1873f95ab9423cdae138bc00e37012b6;p=perltidy.git

update docs
---

diff --git a/CHANGES.md b/CHANGES.md
index ac51718f..30214a48 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -3,13 +3,20 @@
 ## 2020 10 01.02
 
     - Add flag -xci, --extended-continuation-indentation, regarding issue git #28
+      This flag causes continuation indentation to "extend" deeper into structures.
+      If you use B<-ci=n> and B<-i=n> with the same value of B<n> you will probably
+      want to set this flag.  Since this is a fairly new flag, the default is B<-nxci> 
+      to avoid disturbing existing formatting.  
 
     - Fix issue git #42, clarify how --break-at-old-logical-breakpoints works.
+      The man page was updated to note that it does not cause all logical breakpoints
+      to be replicated in the output file.
 
     - Fix issue git #41, typo in manual regarding -fsb
 
     - Fix issue git #40: when using the -bli option, a closing brace followed by 
-      a semicolon was not being indented.
+      a semicolon was not being indented.  This applies to braces which require 
+      semicolons, such as a 'do' block.
 
 ## 2020 10 01
 
diff --git a/local-docs/BugLog.pod b/local-docs/BugLog.pod
index 55dfe642..de3a5b3e 100644
--- a/local-docs/BugLog.pod
+++ b/local-docs/BugLog.pod
@@ -1,5 +1,49 @@
 =head1 Issues fixed after release 20201001
 
+=item b<fix -bos to keep isolated semicolon breaks after block braces>
+
+The flag B<-bos>,  or B<--break-at-old-semicolon-breakpoints>, keeps breaks
+at old isolated semicolons. For example
+
+    $z = sqrt($x**2 + $y**2)
+      ;
+
+In testing it was found not to be doing this after braces which require
+semicolons, such as 'do' and anonymous subs. This was fixed.  For example
+
+    my $dist = sub {
+        $z = sqrt( $x**2 + $y**2 )
+          ;
+      }
+      ;
+
+=item b<keep break after 'use overload'>
+
+If a line break occurs after B<use overload> then it will now be kept. Previously
+it was dropped.  For example, this would be kept intact:
+
+                use overload
+                    '+' => sub {
+                        print length $_[2], "\n";
+                        my ( $x, $y ) = _order(@_);
+                        Number::Roman->new( int $x + $y );
+                    },
+                    '-' => sub {
+                        my ( $x, $y ) = _order(@_);
+                        Number::Roman->new( int $x - $y );
+                    },
+                    ...
+
+This keeps the list from shifting to the right and can avoid problems in
+formatting the list with certain styles, including with the -xci flag.
+
+=item B<added flag -xci to improve formatting when -ci and -i are equal, issue git #28>
+
+This flag causes continuation indentation to "extend" deeper into structures.
+If you use B<-ci=n> and B<-i=n> with the same value of B<n> you will probably
+want to set this flag.  Since this is a fairly new flag, the default is B<-nxci> 
+to avoid disturbing existing formatting.  
+
 =item B<terminal braces not indenting correctly with -bli formatting, issue git #40>
 
 This problem is illustrated with the following snippet when run with -bli -blil='*'