chiark / gitweb /
git-debrebase: new-upstream-v0: use last upstream merge in breakwater branch
[dgit.git] / git-debrebase
index a1d277e..8c77dbc 100755 (executable)
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+#    git-debrebase new-upstreams-v0 \
+#             NEW-VERSION ORIG-COMMITISH
+#            [EXTRA-ORIG-NAME EXTRA-ORIG-COMMITISH ...]
+
 # usages:
 #    git-debrebase status
 #    git-debrebase start       # like ffqrebase start + debrebase launder
 
 use strict;
 
+use Debian::Dgit qw(:DEFAULT :playground);
+setup_sigwarn();
+
 use Memoize;
 use Carp;
 use POSIX;
 use Data::Dumper;
 use Getopt::Long qw(:config posix_default gnu_compat bundling);
+use Dpkg::Version;
 
-use Debian::Dgit qw(:DEFAULT :playground);
+our ($opt_force);
 
 sub badusage ($) {
     my ($m) = @_;
@@ -153,7 +161,8 @@ sub in_workarea ($) {
     my ($sub) = @_;
     changedir $workarea;
     my $r = eval { $sub->(); };
-    changedir $maindir;
+    { local $@; changedir $maindir; }
+    die $@ if $@;
 }
 
 sub fresh_workarea () {
@@ -211,7 +220,7 @@ sub get_differs ($$) {
            }
            die unless s{^debian/patches/}{};
            my $ok;
-           if ($mode eq 'A' && !m/(?:^|\.)series$/s) {
+           if ($mode eq 'A' && !m/\.series$/s) {
                $ok = 1;
            } elsif ($mode eq 'M' && $_ eq 'series') {
                my $x_s = git_cat_file "$x:debian/patches/series", 'blob';
@@ -246,6 +255,17 @@ sub calculate_committer_authline () {
     return $&;
 }
 
+sub rm_subdir_cached ($) {
+    my ($subdir) = @_;
+    runcmd @git, qw(rm --quiet -rf --cached --ignore-unmatch), $subdir;
+}
+
+sub read_tree_subdir ($$) {
+    my ($subdir, $new_tree_object) = @_;
+    rm_subdir_cached $subdir;
+    runcmd @git, qw(read-tree), "--prefix=$subdir/", $new_tree_object;
+}
+
 # classify returns an info hash like this
 #   CommitId => $objid
 #   Hdr => # commit headers, including 1 final newline
@@ -281,33 +301,51 @@ sub calculate_committer_authline () {
 #
 #   BreakwaterUpstreamMerge
 #     has additional entry in classification result
-#       OrigParents = [ subset of Parents ]
+#       OrigParents = [ subset of Parents ]  # singleton list
 
-sub classify ($) {
-    my ($objid) = @_;
+sub parsecommit ($;$) {
+    my ($objid, $p_ref) = @_;
+    # => hash with                   CommitId Hdr Msg Tree Parents
+    #    Parents entries have only   Ix CommitId
+    #    $p_ref, if provided, must be [] and is used as a base for Parents
+
+    $p_ref //= [];
+    die if @$p_ref;
 
     my ($h,$m) = get_commit $objid;
 
     my ($t) = $h =~ m/^tree (\w+)$/m or die $objid;
     my (@ph) = $h =~ m/^parent (\w+)$/mg;
-    my @p;
 
     my $r = {
        CommitId => $objid,
        Hdr => $h,
        Msg => $m,
         Tree => $t,
-       Parents => \@p,
+       Parents => $p_ref,
     };
 
     foreach my $ph (@ph) {
-       push @p, {
-            Ix => $#p,
+       push @$p_ref, {
+            Ix => $#$p_ref,
             CommitId => $ph,
-            Differs => (get_differs $t, $ph),
         };
     }
 
+    return $r;
+}    
+
+sub classify ($) {
+    my ($objid) = @_;
+
+    my @p;
+    my $r = parsecommit($objid, \@p);
+    my $t = $r->{Tree};
+
+    foreach my $p (@p) {
+       $p->{Differs} = (get_differs $p->{CommitId}, $t),
+    }
+
     printdebug "classify $objid \$t=$t \@p",
        (map { sprintf " %s/%#x", $_->{CommitId}, $_->{Differs} } @p),
        "\n";
@@ -336,7 +374,7 @@ sub classify ($) {
        } elsif ($d & (D_PAT_ADD|D_PAT_OTH)) {
            return $unknown->("edits debian/patches");
        } elsif ($d & DS_DEB and !($d & ~DS_DEB)) {
-           my ($ty,$dummy) = git_cat_file "$ph[0]:debian";
+           my ($ty,$dummy) = git_cat_file "$p[0]{CommitId}:debian";
            if ($ty eq 'tree') {
                if ($d == D_DEB_CLOG) {
                    return $classify->(qw(Changelog));
@@ -387,7 +425,7 @@ sub classify ($) {
        ($p->{IsDgitImport},) = $p_m =~ m/^\[dgit import ([0-9a-z]+) .*\]$/m;
     }
     my @orig_ps = grep { ($_->{IsDgitImport}//'X') eq 'orig' } @p;
-    my $m2 = $m;
+    my $m2 = $r->{Msg};
     if (!(grep { !$_->{IsOrigin} } @p) and
        (@orig_ps >= @p - 1) and
        $m2 =~ s{^\[(dgit import unpatched .*)\]$}{[was: $1]}m) {
@@ -423,9 +461,11 @@ sub classify ($) {
            return $classify->(qw(BreakwaterUpstreamMerge),
                               OrigParents => [ $p[!$prevbrw] ]);
        }
-       # xxx multi-.orig upstreams
     }
 
+    # multi-orig upstreams are represented with a breakwater merge
+    # from a single upstream commit which combines the orig tarballs
+
     return $unknown->("complex merge");
 }
 
@@ -433,7 +473,7 @@ sub walk ($;$$);
 sub walk ($;$$) {
     my ($input,
        $nogenerate,$report) = @_;
-    # => ($tip, $breakwater_tip)
+    # => ($tip, $breakwater_tip, $last_upstream_merge_in_breakwater)
     # (or nothing, if $nogenerate)
 
     # go through commits backwards
@@ -474,7 +514,9 @@ sub walk ($;$$) {
        if ($nogenerate) {
            return (undef,undef);
        }
-       die "commit $cur: Cannot cope with this commit";
+       die "commit $cur: Cannot cope with this commit (d.".
+           (join ' ', map { sprintf "%#x", $_->{Differs} }
+            @{ $cl->{Parents} }). ")";
     };
 
     my $build;
@@ -487,6 +529,8 @@ sub walk ($;$$) {
        no warnings qw(exiting); last;
     };
 
+    my $last_upstream_update;
+
     for (;;) {
        $cl = classify $cur;
        my $ty = $cl->{Type};
@@ -504,6 +548,7 @@ sub walk ($;$$) {
            $cur = $p0;
            next;
        } elsif ($ty eq 'BreakwaterStart') {
+            $last_upstream_update = $cur;
            $build_start->('FirstPackaging', $cur);
        } elsif ($ty eq 'Upstream') {
            push @upp_cl, $cl;
@@ -512,7 +557,7 @@ sub walk ($;$$) {
        } elsif ($ty eq 'Mixed') {
            my $queue = sub {
                my ($q, $wh) = @_;
-               my $cls = { $cl, $xmsg->("split mixed commit: $wh part") };
+               my $cls = { %$cl, $xmsg->("split mixed commit: $wh part") };
                push @$q, $cls;
            };
            $queue->(\@brw_cl, "debian");
@@ -528,6 +573,7 @@ sub walk ($;$$) {
            $cur = $contrib;
            next;
        } elsif ($ty eq 'BreakwaterUpstreamMerge') {
+            $last_upstream_update = $cur;
            $build_start->("PreviousBreakwater", $cur);
        } elsif ($ty eq 'DgitImportUnpatched') {
            my $pm = $pseudomerges[-1];
@@ -581,6 +627,7 @@ sub walk ($;$$) {
                $prline->(" Import");
                $rewrite_from_here->();
                $upp_limit //= $#upp_cl; # further, deeper, patches discarded
+                die 'BUG $upp_limit is not used anywhere?';
                $cur = $ovwr;
                next;
            } else {
@@ -607,14 +654,9 @@ sub walk ($;$$) {
 
     my $rewriting = 0;
 
-    my $rm_tree_cached = sub {
-       my ($subdir) = @_;
-       runcmd @git, qw(rm --quiet -rf --cached --ignore-unmatch), $subdir;
-    };
     my $read_tree_debian = sub {
        my ($treeish) = @_;
-       $rm_tree_cached->(qw(debian));
-       runcmd @git, qw(read-tree --prefix=debian/), "$treeish:debian";
+       read_tree_subdir 'debian', "$treeish:debian";
     };
     my $read_tree_upstream = sub {
        my ($treeish) = @_;
@@ -624,9 +666,14 @@ sub walk ($;$$) {
  
     my $committer_authline = calculate_committer_authline();
 
+    printdebug "WALK REBUILD $build ".(scalar @processed)."\n";
+
+    confess "internal error" unless $build eq (pop @processed)->{CommitId};
+
     in_workarea sub {
        mkdir $rd or $!==EEXIST or die $!;
        my $current_method;
+       runcmd @git, qw(read-tree), $build;
        foreach my $cl (qw(Debian), (reverse @brw_cl),
                        { SpecialMethod => 'RecordBreakwaterTip' },
                        qw(Upstream), (reverse @upp_cl)) {
@@ -637,6 +684,8 @@ sub walk ($;$$) {
            my $method = $cl->{SpecialMethod} // $current_method;
            my @parents = ($build);
            my $cltree = $cl->{CommitId};
+           printdebug "WALK BUILD ".($cltree//'undef').
+               " $method (rewriting=$rewriting)\n";
            if ($method eq 'Debian') {
                $read_tree_debian->($cltree);
            } elsif ($method eq 'Upstream') {
@@ -649,20 +698,26 @@ sub walk ($;$$) {
                next;
            } elsif ($method eq 'DgitImportDebianUpdate') {
                $read_tree_debian->($cltree);
-               $rm_tree_cached->(qw(debian/patches));
+               rm_subdir_cached qw(debian/patches);
            } elsif ($method eq 'DgitImportUpstreamUpdate') {
                $read_tree_upstream->($cltree);
                push @parents, map { $_->{CommitId} } @{ $cl->{OrigParents} };
            } else {
                confess "$method ?";
            }
-           $rewriting ||= $cl ne pop @processed;
+           if (!$rewriting) {
+               my $procd = (pop @processed) // 'UNDEF';
+               if ($cl ne $procd) {
+                   $rewriting = 1;
+                   printdebug "WALK REWRITING NOW cl=$cl procd=$procd\n";
+               }
+           }
            my $newtree = cmdoutput @git, qw(write-tree);
            my $ch = $cl->{Hdr};
            $ch =~ s{^tree .*}{tree $newtree}m or confess "$ch ?";
            $ch =~ s{^parent .*\n}{}m;
            $ch =~ s{(?=^author)}{
-               map { "parent $_\n" } @parents
+               join '', map { "parent $_\n" } @parents
            }me or confess "$ch ?";
            if ($rewriting) {
                $ch =~ s{^committer .*$}{$committer_authline}m
@@ -678,19 +733,31 @@ sub walk ($;$$) {
            my $newcommit = cmdoutput @cmd;
            confess "$ch ?" unless $rewriting or $newcommit eq $cl->{CommitId};
            $build = $newcommit;
+            if (grep { $method eq $_ } qw(DgitImportUpstreamUpdate)) {
+                $last_upstream_update = $cur;
+            }
        }
     };
 
-    runcmd @git, qw(diff-tree --quiet), $input, $build;
+    my $final_check = get_differs $build, $input;
+    die sprintf "internal error %#x %s %s", $final_check, $build, $input
+       if $final_check & ~D_PAT_ADD;
 
-    return ($build, $breakwater);
+    return ($build, $breakwater, $last_upstream_update);
 }
 
 sub get_head () { return git_rev_parse qw(HEAD); }
 
 sub update_head ($$$) {
     my ($old, $new, $mrest) = @_;
-    runcmd @git, qw(update-ref -m), "git-debrebase $mrest", $new, $old;
+    runcmd @git, qw(update-ref -m), "debrebase: $mrest", 'HEAD', $new, $old;
+}
+
+sub update_head_checkout ($$$) {
+    my ($old, $new, $mrest) = @_;
+    my $symref = git_get_symref();
+    runcmd @git, qw(checkout), $new, qw(.);
+    update_head $old, $new, $mrest;
 }
 
 sub cmd_launder () {
@@ -699,8 +766,9 @@ sub cmd_launder () {
     my ($tip,$breakwater) = walk $old;
     update_head $old, $tip, 'launder';
     # no tree changes except debian/patches
-    runcmd @git, qw(rm --quiet -rf debian/patches);
+    runcmd @git, qw(rm --quiet --ignore-unmatch -rf debian/patches);
     printf "# breakwater tip\n%s\n", $breakwater;
+    printf "# working tip\n%s\n", $tip;
 }
 
 sub cmd_analyse () {
@@ -716,7 +784,254 @@ sub cmd_analyse () {
     STDOUT->error and die $!;
 }
 
-GetOptions("D+" => \$debuglevel) or die badusage "bad options\n";
+sub cmd_new_upstream_v0 () {
+    # xxx would like to support more git-rebase options
+    badusage
+ "need NEW-VERSION UPS-COMMITISH [EXTRA-UPS-NAME EXTRA-UPS-COMMITISH...]"
+       unless @ARGV % 2 == 0 and @ARGV >= 2;
+    # tree should be clean and this is not checked
+    # automatically and unconditionally launders before rebasing
+    # if rebase --abort is used, laundering has still been done
+
+    my %pieces;
+
+    # parse args - low commitment
+    my $new_version = (new Dpkg::Version scalar(shift @ARGV), check => 1);
+    my $new_upstream_version = $new_version->version();
+
+    my $new_upstream = git_rev_parse shift @ARGV;
+
+    my $piece = sub {
+        my ($n, @x) = @_; # may be ''
+        my $pc = $pieces{$n} //= {
+           Name => $n,
+           Desc => ($n ? "upstream piece $n" : "upstream (main piece"),
+       };
+       while (my $k = shift @x) { $pc->{$k} = shift @x; }
+    };
+
+    my @newpieces;
+    my $newpiece = sub {
+       my ($n, @x) = @_; # may be ''
+       my $pc = $piece->($n, @x, NewIx => (scalar @newpieces));
+       push @newpieces, $pc;
+    };
+
+    $newpiece->('',
+        OldIx => 0,
+        New => $new_upstream,
+    );
+    while (@ARGV) {
+       my $n = shift @ARGV;
+       my $c = git_rev_parse shift @ARGV;
+       die unless $n =~ m/^$extra_orig_namepart_re$/;
+       $newpiece->($n, New => $c);
+    }
+
+    # now we need to investigate the branch this generates the
+    # laundered version but we don't switch to it yet
+    my $old_head = get_head();
+    my ($old_laundered_tip,$old_bw,$old_upstream_update) = walk $old_head;
+
+    my $old_bw_cl = classify $old_bw;
+    my $old_upstream_update_cl = classify $old_upstream_update;
+    confess unless $old_upstream_update_cl->{OrigParents};
+    my $old_upstream = parsecommit
+        $old_upstream_update_cl->{OrigParents}[0]{CommitId};
+
+    my $problems = 0;
+    my $problem = sub {
+       my ($msg) = @_;
+       $problems++;
+       print STDERR "preflight check failed: $msg\n";
+    };
+
+    $piece->('', Old => $old_upstream);
+
+    if ($old_upstream->{Msg} =~ m{^\[git-debrebase }m) {
+       if ($old_upstream->{Msg} =~
+ m{^\[git-debrebase new-upstream combine \.((?: $extra_orig_namepart_re)+)\]}
+          ) {
+           my @oldpieces = ('', split / /, $1);
+           my $parentix = -1 + scalar @{ $old_upstream->{Parents} };
+           foreach my $i (0..$#oldpieces) {
+               my $n = $oldpieces[$i];
+               $piece->($n, Old => $old_upstream->{CommitId}.'^'.$parentix);
+           }
+       } else {
+           $problem->("previous upstream $old_upstream->{CommitId} is from".
+                 " git-debrebase but not a \`new-upstream combine' commit");
+       }
+    }
+
+    foreach my $pc (values %pieces) {
+       if (!$pc->{Old}) {
+           $problem->("introducing upstream piece $pc->{Name}");
+       } elsif (!$pc->{New}) {
+           $problem->("dropping upstream piece $pc->{Name}");
+       } elsif (!is_fast_fwd $pc->{Old}, $pc->{New}) {
+           $problem->("not fast forward: $pc->{Name} $pc->{Old}..$pc->{New}");
+       }
+    }
+
+    if ($problems) {
+       if ($opt_force) {
+           printf STDERR
+               "preflight check failures (%d) overriden by --force\n",
+               $problems;
+       } else {
+           fail sprintf
+               "preflight check failures (%d) (you could --force)",
+               $problems;
+       }
+    }
+
+    my $new_bw;
+
+    fresh_workarea();
+    in_workarea sub {
+       my @upstream_merge_parents;
+
+       if (!$problems) {
+           push @upstream_merge_parents, $old_upstream->{CommitId};
+       }
+
+       foreach my $pc (@newpieces) { # always has '' first
+           if ($pc->{Name}) {
+               read_tree_subdir $pc->{Name}, $pc->{New};
+           } else {
+               runcmd @git, qw(read-tree), $pc->{New};
+           }
+           push @upstream_merge_parents, $pc->{New};
+       }
+
+       # index now contains the new upstream
+
+       if (@newpieces > 1) {
+           # need to make the upstream subtree merge commit
+           my $us_tree = cmdoutput @git, qw(write-tree);
+           my @cmd = (@git, qw(commit-tree), $us_tree);
+           push @cmd, qw(-p), $_ foreach @upstream_merge_parents;
+           push @cmd, qw(-m), "Combine upstreams for $new_upstream_version";
+           push @cmd, qw(-m),
+               "[git-debrebase new-upstream combine . ".
+               (join " ", map { $_->{Name} } @newpieces[1..$#newpieces]).
+                "]";
+           $new_upstream = cmdoutput @cmd;
+       }
+
+       # $new_upstream is either the single upstream commit, or the
+       # combined commit we just made.  Either way it will be the
+       # "upstream" parent of the breakwater special merge.
+
+       read_tree_subdir 'debian', "$old_bw:debian";
+
+       # index now contains the breakwater merge contents
+
+       my $bw_tree = cmdoutput @git, qw(write_tree);
+       my @cmd = (@git, qw(commit-tree), $bw_tree);
+       push @cmd, qw(-p), $old_bw, qw(-p), $new_upstream;
+       push @cmd, qw(-m), "Update to upstream $new_upstream_version";
+       push @cmd, qw(-m),
+           "[git-debrebase new-upstream breakwater $new_upstream_version]";
+       $new_bw = cmdoutput @git;
+
+       # Now we have to add a changelog stanza so the Debian version
+       # is right.
+
+       die if unlink "debian";
+       die unless $!==ENOTEMPTY;
+       unlink "debian/changelog" or die $!;
+       open CN, ">", "debian/changelog" or die $!;
+       my $oldclog = git_cat_file ":debian/changelog";
+       $oldclog =~ m/^($package_re) \(\S+\) / or
+           fail "cannot parse old changelog to get package name";
+       my $p = $1;
+       print CN <<END, $oldclog or die $!;
+$p ($new_version) UNRELEASED; urgency=medium
+
+  * Update to new upstream version $new_upstream_version.
+
+ -- 
+
+END
+       close CN or die $!;
+       runcmd @git, qw(update-index --add --replace), 'debian/changelog';
+
+       # Now we have the final new breakwater branch in the index
+
+       $bw_tree = cmdoutput @git, qw(write_tree);
+       @cmd = (@git, qw(commit-tree), $bw_tree);
+       push @cmd, qw(-p), $new_bw;
+       push @cmd, qw(-m),
+           "Update changelog for new upstream $new_upstream_version";
+       push @cmd, qw(-m),
+           "[git-debrebase new-upstream changelog $new_upstream_version]";
+       $new_bw = cmdoutput @git;
+    };
+
+    # we have constructed the new breakwater. we now need to commit to
+    # the laundering output, because git-rebase can't easily be made
+    # to make a replay list which is based on some other branch
+
+    update_head $old_head, $old_laundered_tip, 'launder for new upstream';
+
+    my @cmd = (@git, qw(rebase --onto), $new_bw, $old_bw);
+    runcmd @cmd;
+    # now it's for the user to sort out
+}
+
+sub cmd_downstream_rebase_launder_v0 () {
+    badusage "needs 1 argument, the baseline" unless @ARGV==1;
+    my ($base) = @ARGV;
+    $base = git_rev_parse $base;
+    my $old_head = get_head();
+    my $current = $old_head;
+    my $topmost_keep;
+    for (;;) {
+       if ($current eq $base) {
+           $topmost_keep //= $current;
+           print " $current BASE stop\n";
+           last;
+       }
+       my $cl = classify $current;
+       print " $current $cl->{Type}";
+       my $keep = 0;
+       my $p0 = $cl->{Parents}[0]{CommitId};
+       my $next;
+       if ($cl->{Type} eq 'Pseudomerge') {
+           print " ^".($cl->{Contributor}{Ix}+1);
+           $next = $cl->{Contributor}{CommitId};
+       } elsif ($cl->{Type} eq 'AddPatches' or
+                $cl->{Type} eq 'Changelog') {
+           print " strip";
+           $next = $p0;
+       } else {
+           print " keep";
+           $next = $p0;
+           $keep = 1;
+       }
+       print "\n";
+       if ($keep) {
+           $topmost_keep //= $current;
+       } else {
+           die "to-be stripped changes not on top of the branch\n"
+               if $topmost_keep;
+       }
+       $current = $next;
+    }
+    if ($topmost_keep eq $old_head) {
+       print "unchanged\n";
+    } else {
+       print "updating to $topmost_keep\n";
+       update_head_checkout
+           $old_head, $topmost_keep,
+           'downstream-rebase-launder-v0';
+    }
+}
+
+GetOptions("D+" => \$debuglevel,
+          'force!') or die badusage "bad options\n";
 initdebug('git-debrebase ');
 enabledebug if $debuglevel;