chiark / gitweb /
git-debrebase: break out do_stitch (nfc)
[dgit.git] / git-debrebase
index 9d87e76..ab1990a 100755 (executable)
@@ -37,7 +37,8 @@ our $us = qw(git-debrebase);
 
 sub badusage ($) {
     my ($m) = @_;
-    die "bad usage: $m\n";
+    print STDERR "bad usage: $m\n";
+    exit 12;
 }
 
 sub cfg ($;$) {
@@ -224,40 +225,40 @@ sub make_commit ($$) {
     return cmdoutput @cmd;
 }
 
-our @fproblem_force_opts;
-our $fproblems_forced;
-our $fproblems_tripped;
-sub fproblem ($$) {
+our @snag_force_opts;
+our $snags_forced;
+our $snags_tripped;
+sub snag ($$) {
     my ($tag,$msg) = @_;
-    if (grep { $_ eq $tag } @fproblem_force_opts) {
-       $fproblems_forced++;
-       print STDERR "git-debrebase: safety catch overridden (-f$tag): $msg\n";
+    if (grep { $_ eq $tag } @snag_force_opts) {
+       $snags_forced++;
+       print STDERR "git-debrebase: snag ignored (-f$tag): $msg\n";
     } else {
-       $fproblems_tripped++;
-       print STDERR "git-debrebase: safety catch tripped (-f$tag): $msg\n";
+       $snags_tripped++;
+       print STDERR "git-debrebase: snag detected (-f$tag): $msg\n";
     }
 }
 
-sub fproblems_maybe_bail () {
-    if ($fproblems_forced) {
+sub snags_maybe_bail () {
+    if ($snags_forced) {
        printf STDERR
-           "%s: safety catch trips: %d overriden by individual -f options\n",
-           $us, $fproblems_forced;
+           "%s: snags: %d overriden by individual -f options\n",
+           $us, $snags_forced;
     }
-    if ($fproblems_tripped) {
+    if ($snags_tripped) {
        if ($opt_force) {
            printf STDERR
-               "%s: safety catch trips: %d overriden by global --force\n",
-               $us, $fproblems_tripped;
+               "%s: snags: %d overriden by global --force\n",
+               $us, $snags_tripped;
        } else {
            fail sprintf
-  "%s: safety catch trips: %d blockers (you could -f<tag>, or --force)",
-               $us, $fproblems_tripped;
+  "%s: snags: %d blockers (you could -f<tag>, or --force)",
+               $us, $snags_tripped;
        }
     }
 }
-sub any_fproblems () {
-    return $fproblems_forced || $fproblems_tripped;
+sub any_snags () {
+    return $snags_forced || $snags_tripped;
 }
 
 # classify returns an info hash like this
@@ -494,41 +495,81 @@ sub classify ($) {
     return $unknown->("complex merge");
 }
 
-sub breakwater_of ($) {
-    my ($head) = @_; # must be laundered
-    my $breakwater;
-    my $unclean = sub {
-       my ($why) = @_;
-       fail "branch needs laundering (run git-debrebase): $why";
+sub keycommits ($;$$$) {
+    my ($head, $furniture, $unclean, $trouble) = @_;
+    # => ($anchor, $breakwater)
+
+    # $unclean->("unclean-$tagsfx", $msg)
+    # $furniture->("unclean-$tagsfx", $msg)
+    # $dgitimport->("unclean-$tagsfx", $msg)
+    #   is callled for each situation or commit that
+    #   wouldn't be found in a laundered branch
+    # $furniture is for furniture commits such as might be found on an
+    #   interchange branch (pseudomerge, d/patches, changelog)
+    # $trouble is for things whnich prevent the return of
+    #   anchor and breakwater information; if that is ignored,
+    #   then keycommits returns (undef, undef) instead.
+    #
+    # If a callback is undef, fail is called instead.
+    # If a callback is defined but false, the situation is ignored.
+    # Callbacks may say:
+    #   no warnings qw(exiting); last;
+    # if the answer is no longer wanted.
+
+    my ($anchor, $breakwater);
+    my $clogonly;
+    my $x = sub {
+       my ($cb, $tagsfx, $why) = @_;
+       my $m = "branch needs laundering (run git-debrebase): $why";
+       fail $m unless defined $cb;
+       return unless $cb;
+       $cb->("unclean-$tagsfx", $why);
     };
     for (;;) {
        my $cl = classify $head;
        my $ty = $cl->{Type};
-       if ($ty eq 'Packaging' or
-           $ty eq 'Changelog') {
+       if ($ty eq 'Packaging') {
+           $breakwater //= $clogonly;
            $breakwater //= $head;
+       } elsif ($ty eq 'Changelog') {
+           # this is going to count as the tip of the breakwater
+           # only if it has no upstream stuff before it
+           $clogonly //= $head;
        } elsif ($ty eq 'Anchor' or
                 $ty eq 'TreatAsAnchor' or
                 $ty eq 'BreakwaterStart') {
+           $anchor = $head;
+           $breakwater //= $clogonly;
            $breakwater //= $head;
            last;
        } elsif ($ty eq 'Upstream') {
-           $unclean->("packaging change ($breakwater)".
                     " follows upstream change (eg $head)")
+           $x->($unclean, 'ordering',
"packaging change ($breakwater) follows upstream change (eg $head)")
                if defined $breakwater;
+           $clogonly = undef;
+           $breakwater = undef;
        } elsif ($ty eq 'Mixed') {
-           $unclean->('found mixed upstream/packaging commit ($head)');
+           $x->($unclean, 'mixed',
+                'found mixed upstream/packaging commit ($head)');
+           $clogonly = undef;
+           $breakwater = undef;
        } elsif ($ty eq 'Pseudomerge' or
                 $ty eq 'AddPatches') {
-           $unclean->("found interchange conversion commit ($ty, $head)");
+           $x->($furniture, (lc $ty),
+                "found interchange bureaucracy commit ($ty, $head)");
        } elsif ($ty eq 'DgitImportUnpatched') {
-           $unclean->("found dgit dsc import ($head)");
+           $x->($trouble, 'dgitimport',
+                "found dgit dsc import ($head)");
+           $breakwater = undef;
+           $anchor = undef;
+           no warnings qw(exiting);
+           last;
        } else {
            fail "found unprocessable commit, cannot cope: $head; $cl->{Why}";
        }
        $head = $cl->{Parents}[0]{CommitId};
     }
-    return $breakwater;
+    return ($anchor, $breakwater);
 }
 
 sub walk ($;$$);
@@ -845,6 +886,15 @@ sub update_head_postlaunder ($$$) {
     runcmd @git, qw(rm --quiet --ignore-unmatch -rf debian/patches);
 }
 
+sub do_launder_head ($) {
+    my ($reflogmsg) = @_;
+    my $old = get_head();
+    record_ffq_auto();
+    my ($tip,$breakwater) = walk $old;
+    update_head_postlaunder $old, $tip, $reflogmsg;
+    return ($tip,$breakwater);
+}
+
 sub cmd_launder_v0 () {
     badusage "no arguments to launder-v0 allowed" if @ARGV;
     my $old = get_head();
@@ -856,10 +906,7 @@ sub cmd_launder_v0 () {
 }
 
 sub defaultcmd_rebase () {
-    my $old = get_head();
-    record_ffq_auto();
-    my ($tip,$breakwater) = walk $old;
-    update_head_postlaunder $old, $tip, 'launder for rebase';
+    my ($tip,$breakwater) = do_launder_head 'launder for rebase';
     runcmd @git, qw(rebase), @ARGV, $breakwater;
 }
 
@@ -877,7 +924,7 @@ sub cmd_analyse () {
 }
 
 sub ffq_prev_branchinfo () {
-    # => ('status', "message", [$current, $ffq_prev])
+    # => ('status', "message", [$current, $ffq_prev, $gdrlast])
     # 'status' may be
     #    branch         message is undef
     #    weird-symref   } no $current,
@@ -887,8 +934,9 @@ sub ffq_prev_branchinfo () {
     return ('weird-symref', 'HEAD symref is not to refs/')
        unless $current =~ m{^refs/};
     my $ffq_prev = "refs/$ffq_refprefix/$'";
+    my $gdrlast = "refs/$gdrlast_refprefix/$'";
     printdebug "ffq_prev_branchinfo branch current $current\n";
-    return ('branch', undef, $current, $ffq_prev);
+    return ('branch', undef, $current, $ffq_prev, $gdrlast);
 }
 
 sub record_ffq_prev_deferred () {
@@ -899,11 +947,12 @@ sub record_ffq_prev_deferred () {
     #    detached
     #    weird-symref
     #    notbranch
-    # if not ff from some branch we should be ff from, is an fproblem
+    # if not ff from some branch we should be ff from, is an snag
     # if "deferred", will have added something about that to
     #   @deferred_update_messages, and also maybe printed (already)
     #   some messages about ff checks
-    my ($status, $message, $current, $ffq_prev) = ffq_prev_branchinfo();
+    my ($status, $message, $current, $ffq_prev, $gdrlast)
+       = ffq_prev_branchinfo();
     return ($status, $message) unless $status eq 'branch';
 
     my $currentval = get_head();
@@ -938,10 +987,10 @@ sub record_ffq_prev_deferred () {
            $checked{$lrref} = 1;
        } elsif (is_fast_fwd $currentval, $lrval) {
            $checked{$lrref} = -1;
-           fproblem 'behind', "you are behind $lrref, divergence risk";
+           snag 'behind', "you are behind $lrref, divergence risk";
        } else {
            $checked{$lrref} = -1;
-           fproblem 'diverged', "you have diverged from $lrref";
+           snag 'diverged', "you have diverged from $lrref";
        }
     };
 
@@ -967,9 +1016,10 @@ sub record_ffq_prev_deferred () {
        $check->("refs/remotes/dgit/dgit/sid", 'remote dgit branch for sid');
     }
 
-    fproblems_maybe_bail();
+    snags_maybe_bail();
 
     push @deferred_updates, "update $ffq_prev $currentval $git_null_obj";
+    push @deferred_updates, "delete $gdrlast";
     push @deferred_update_messages, "Recorded current head for preservation";
     return ('deferred', undef);
 }
@@ -978,9 +1028,63 @@ sub record_ffq_auto () {
     my ($status, $message) = record_ffq_prev_deferred();
     if ($status eq 'deferred' || $status eq 'exists') {
     } else {
-       fproblem $status, "could not record ffq-prev: $message";
-       fproblems_maybe_bail();
+       snag $status, "could not record ffq-prev: $message";
+       snags_maybe_bail();
+    }
+}
+
+sub ffq_prev_info () {
+    # => ($ffq_prev, $gdrlast, $ffq_prev_commitish)
+    my ($status, $message, $current, $ffq_prev, $gdrlast)
+       = ffq_prev_branchinfo();
+    if ($status ne 'branch') {
+       snag $status, "could not check ffq-prev: $message";
+       snags_maybe_bail();
+    }
+    my $ffq_prev_commitish = $ffq_prev && git_get_ref $ffq_prev;
+    return ($ffq_prev, $gdrlast, $ffq_prev_commitish);
+}
+
+sub stitch ($$$$$) {
+    my ($old_head, $ffq_prev, $gdrlast, $ffq_prev_commitish, $prose) = @_;
+
+    push @deferred_updates, "delete $ffq_prev $ffq_prev_commitish";
+
+    if (is_fast_fwd $old_head, $ffq_prev_commitish) {
+       my $differs = get_differs $old_head, $ffq_prev_commitish;
+       unless ($differs & ~D_PAT_ADD) {
+           # ffq-prev is ahead of us, and the only tree changes it has
+           # are possibly addition of things in debian/patches/.
+           # Just wind forwards rather than making a pointless pseudomerge.
+           push @deferred_updates,
+               "update $gdrlast $ffq_prev_commitish $git_null_obj";
+           update_head_checkout $old_head, $ffq_prev_commitish,
+               "stitch (fast forward)";
+           return;
+       }
+    }
+    fresh_workarea();
+    my $new_head = make_commit [ $old_head, $ffq_prev ], [
+       'Declare fast forward / record previous work',
+        "[git-debrebase pseudomerge: $prose]",
+    ];
+    push @deferred_updates, "update $gdrlast $new_head $git_null_obj";
+    update_head $old_head, $new_head, "stitch: $prose";
+}
+
+sub do_stitch ($) {
+    my ($prose) = @_;
+
+    my ($ffq_prev, $gdrlast, $ffq_prev_commitish) = ffq_prev_info();
+    if (!$ffq_prev_commitish) {
+       fail "No ffq-prev to stitch." unless $opt_noop_ok;
+       return;
     }
+    my $dangling_head = get_head();
+
+    keycommits $dangling_head, \&snag, \&snag, \&snag;
+
+    stitch($dangling_head, $ffq_prev, $gdrlast, $ffq_prev_commitish, $prose);
 }
 
 sub cmd_new_upstream_v0 () {
@@ -1040,7 +1144,7 @@ sub cmd_new_upstream_v0 () {
     my $old_anchor_cl = classify $old_anchor;
     my $old_upstream;
     if (!$old_anchor_cl->{OrigParents}) {
-       fproblem 'anchor-treated',
+       snag 'anchor-treated',
            'old anchor is recognised due to --anchor, cannot check upstream';
     } else {
        $old_upstream = parsecommit
@@ -1059,7 +1163,7 @@ sub cmd_new_upstream_v0 () {
                $piece->($n, Old => $old_upstream->{CommitId}.'^'.$parentix);
            }
        } else {
-           fproblem 'upstream-confusing',
+           snag 'upstream-confusing',
                "previous upstream $old_upstream->{CommitId} is from".
                " git-debrebase but not an \`upstream-combine' commit";
        }
@@ -1069,13 +1173,13 @@ sub cmd_new_upstream_v0 () {
        if (!$old_upstream) {
            # we have complained already
        } elsif (!$pc->{Old}) {
-           fproblem 'upstream-new-piece',
+           snag 'upstream-new-piece',
                "introducing upstream piece \`$pc->{Name}'";
        } elsif (!$pc->{New}) {
-           fproblem 'upstream-rm-piece',
+           snag 'upstream-rm-piece',
                "dropping upstream piece \`$pc->{Name}'";
        } elsif (!is_fast_fwd $pc->{Old}, $pc->{New}) {
-           fproblem 'upstream-not-ff',
+           snag 'upstream-not-ff',
                "not fast forward: $pc->{Name} $pc->{Old}..$pc->{New}";
        }
     }
@@ -1083,7 +1187,7 @@ sub cmd_new_upstream_v0 () {
     printdebug "%pieces = ", (dd \%pieces), "\n";
     printdebug "\@newpieces = ", (dd \@newpieces), "\n";
 
-    fproblems_maybe_bail();
+    snags_maybe_bail();
 
     my $new_bw;
 
@@ -1091,7 +1195,7 @@ sub cmd_new_upstream_v0 () {
     in_workarea sub {
        my @upstream_merge_parents;
 
-       if (!any_fproblems()) {
+       if (!any_snags()) {
            push @upstream_merge_parents, $old_upstream->{CommitId};
        }
 
@@ -1181,44 +1285,23 @@ sub cmd_record_ffq_prev () {
     }
 }
 
+sub cmd_anchor () {
+    badusage "no arguments allowed" if @ARGV;
+    my ($anchor, $bw) = keycommits +(git_rev_parse 'HEAD'), 0,0;
+    print "$bw\n" or die $!;
+}
+
 sub cmd_breakwater () {
     badusage "no arguments allowed" if @ARGV;
-    my $bw = breakwater_of git_rev_parse 'HEAD';
+    my ($anchor, $bw) = keycommits +(git_rev_parse 'HEAD'), 0,0;
     print "$bw\n" or die $!;
 }
 
 sub cmd_stitch () {
-    my $prose = '';
+    my $prose = 'stitch';
     GetOptions('prose=s', \$prose) or die badusage("bad options to stitch");
     badusage "no arguments allowed" if @ARGV;
-    my ($status, $message, $current, $ffq_prev) = ffq_prev_branchinfo();
-    if ($status ne 'branch') {
-       fproblem $status, "could not check ffq-prev: $message";
-       fproblems_maybe_bail();
-    }
-    my $prev = $ffq_prev && git_get_ref $ffq_prev;
-    if (!$prev) {
-       fail "No ffq-prev to stitch." unless $opt_noop_ok;
-    }
-    push @deferred_updates, "delete $ffq_prev $prev";
-
-    my $old_head = get_head();
-    if (is_fast_fwd $old_head, $prev) {
-       my $differs = get_differs $old_head, $prev;
-       unless ($differs & ~D_PAT_ADD) {
-           # ffq-prev is ahead of us, and the only tree changes it has
-           # are possibly addition of things in debian/patches/.
-           # Just wind forwards rather than making a pointless pseudomerge.
-           update_head_checkout $old_head, $prev, "stitch (fast forward)";
-           return;
-       }
-    }
-    fresh_workarea();
-    my $new_head = make_commit [ $old_head, $ffq_prev ], [
-       'Declare fast forward / record previous work',
-        "[git-debrebase pseudomerge: stitch$prose]",
-    ];
-    update_head $old_head, $new_head, "stitch";
+    do_stitch($prose);
 }
 
 sub cmd_convert_from_gbp () {
@@ -1238,25 +1321,25 @@ sub cmd_convert_from_gbp () {
     }
 
     if (!is_fast_fwd $upstream, $old_head) {
-       fproblem 'upstream-not-ancestor',
+       snag 'upstream-not-ancestor',
            "upstream ($upstream) is not an ancestor of HEAD";
     } else {
        my $wrong = cmdoutput
            (@git, qw(rev-list --ancestry-path), "$upstream..HEAD",
             qw(-- :/ :!/debian));
        if (length $wrong) {
-           fproblem 'unexpected-upstream-changes',
+           snag 'unexpected-upstream-changes',
                "history between upstream ($upstream) and HEAD contains direct changes to upstream files - are you sure this is a gbp (patches-unapplied) branch?";
            print STDERR "list expected changes with:  git log --stat --ancestry-path $upstream_spec..HEAD -- :/ ':!/debian'\n";
        }
     }
 
     if ((git_cat_file "$upstream:debian")[0] ne 'missing') {
-       fproblem 'upstream-has-debian',
+       snag 'upstream-has-debian',
            "upstream ($upstream) contains debian/ directory";
     }
 
-    fproblems_maybe_bail();
+    snags_maybe_bail();
 
     my $work;
 
@@ -1293,8 +1376,8 @@ sub cmd_convert_from_gbp () {
 sub cmd_convert_to_gbp () {
     badusage "no arguments allowed" if @ARGV;
     my $head = get_head();
-    my $ffq = (ffq_prev_branchinfo())[3];
-    my $bw = breakwater_of $head;
+    my (undef, undef, undef, $ffq, $gdrlast) = ffq_prev_branchinfo();
+    my ($anchor, $bw) = keycommits $head, 0;
     fresh_workarea();
     my $out;
     in_workarea sub {
@@ -1309,6 +1392,7 @@ sub cmd_convert_to_gbp () {
     };
     if (defined $ffq) {
        push @deferred_updates, "delete $ffq";
+       push @deferred_updates, "delete $gdrlast";
     }
     update_head_checkout $head, $out, "convert to gbp (v0)";
     print <<END or die $!;
@@ -1369,7 +1453,7 @@ sub cmd_downstream_rebase_launder_v0 () {
 
 GetOptions("D+" => \$debuglevel,
           'noop-ok', => \$opt_noop_ok,
-          'f=s' => \@fproblem_force_opts,
+          'f=s' => \@snag_force_opts,
           'anchor=s' => \@opt_anchors,
           'force!') or die badusage "bad options\n";
 initdebug('git-debrebase ');