chiark / gitweb /
git-debrebase: comment: explain why tagged linear anchors are evil
[dgit.git] / git-debrebase
index 171324671faed440b06338d41208b3eeda52e47b..524631787575bb459556a696c92850e040a8b970 100755 (executable)
@@ -32,12 +32,14 @@ use Dpkg::Version;
 use File::FnMatch qw(:fnmatch);
 
 our ($opt_force, $opt_noop_ok, @opt_anchors);
+our ($opt_defaultcmd_interactive);
 
 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 +226,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
@@ -394,6 +396,15 @@ sub classify ($) {
        # BreakwaterStart commits are also anchors in the terminology
        # of git-debrebase(5), but they are untagged (and always
        # manually generated).
+       #
+       # We cannot not tolerate any tagged linear commit (ie,
+       # BreakwaterStart commits tagged `[anchor:') because such a
+       # thing could result from an erroneous linearising raw git
+       # rebase of a merge anchor.  That would represent a corruption
+       # of the branch. and we want to detect and reject the results
+       # of such corruption before it makes it out anywhere.  If we
+       # reject it here then we avoid making the pseudomerge which
+       # would be needed to push it.
 
        my $badanchor = sub { $unknown->("git-debrebase \`anchor' but @_"); };
        @p == 2 or return $badanchor->("has other than two parents");
@@ -503,7 +514,7 @@ sub keycommits ($;$$$) {
     # $dgitimport->("unclean-$tagsfx", $msg)
     #   is callled for each situation or commit that
     #   wouldn't be found in a laundered branch
-    # $furniture is forfurniture commits such as might be found on an
+    # $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,
@@ -885,6 +896,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();
@@ -896,11 +916,9 @@ 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';
-    runcmd @git, qw(rebase), @ARGV, $breakwater;
+    push @ARGV, @{ $opt_defaultcmd_interactive // [] };
+    my ($tip,$breakwater) = do_launder_head 'launder for rebase';
+    runcmd @git, qw(rebase), @ARGV, $breakwater if @ARGV;
 }
 
 sub cmd_analyse () {
@@ -940,7 +958,7 @@ 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
@@ -980,10 +998,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";
        }
     };
 
@@ -1009,7 +1027,7 @@ 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";
@@ -1021,9 +1039,21 @@ 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 ($$$$$) {
@@ -1047,10 +1077,25 @@ sub stitch ($$$$$) {
     fresh_workarea();
     my $new_head = make_commit [ $old_head, $ffq_prev ], [
        'Declare fast forward / record previous work',
-        "[git-debrebase pseudomerge: stitch$prose]",
+        "[git-debrebase pseudomerge: $prose]",
     ];
     push @deferred_updates, "update $gdrlast $new_head $git_null_obj";
-    update_head $old_head, $new_head, "stitch";
+    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 () {
@@ -1110,7 +1155,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
@@ -1129,7 +1174,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";
        }
@@ -1139,13 +1184,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}";
        }
     }
@@ -1153,7 +1198,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;
 
@@ -1161,7 +1206,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};
        }
 
@@ -1198,6 +1243,10 @@ sub cmd_new_upstream_v0 () {
  "[git-debrebase anchor: new upstream $new_upstream_version, merge]",
             ];
 
+       my $clogsignoff = cmdoutput qw(git show),
+           '--pretty=format:%an <%ae>  %aD',
+           $new_bw;
+
        # Now we have to add a changelog stanza so the Debian version
        # is right.
        die if unlink "debian";
@@ -1214,7 +1263,7 @@ $p ($new_version) UNRELEASED; urgency=medium
 
   * Update to new upstream version $new_upstream_version.
 
- -- 
+ -- $clogsignoff
 
 END
        close CN or die $!;
@@ -1264,25 +1313,16 @@ sub cmd_breakwater () {
 }
 
 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, $gdrlast)
-       = ffq_prev_branchinfo();
-    if ($status ne 'branch') {
-       fproblem $status, "could not check ffq-prev: $message";
-       fproblems_maybe_bail();
-    }
-    my $ffq_prev_commitish = $ffq_prev && git_get_ref $ffq_prev;
-    if (!$ffq_prev_commitish) {
-       fail "No ffq-prev to stitch." unless $opt_noop_ok;
-       return;
-    }
-    my $old_head = get_head();
-
-    keycommits $old_head, \&fproblem, \&fproblem, \&fproblem;
+    do_stitch($prose);
+}
 
-    stitch($old_head, $ffq_prev, $gdrlast, $ffq_prev_commitish, $prose);
+sub cmd_conclude () {
+    badusage "no arguments allowed" if @ARGV;
+    do_launder_head 'launder for conclude';
+    do_stitch 'conclude';
 }
 
 sub cmd_convert_from_gbp () {
@@ -1302,25 +1342,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;
 
@@ -1434,9 +1474,21 @@ 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";
+          'force!',
+          '-i:s' => sub {
+              my ($opt,$val) = @_;
+              badusage "git-debrebase: no cuddling to -i for git-rebase"
+                  if length $val;
+              die if $opt_defaultcmd_interactive; # should not happen
+              $opt_defaultcmd_interactive = [ qw(-i) ];
+              # This access to @ARGV is excessive familiarity with
+              # Getopt::Long, but there isn't another sensible
+              # approach.  '-i=s{0,}' does not work with bundling.
+              push @$opt_defaultcmd_interactive, @ARGV;
+              @ARGV=();
+          }) or die badusage "bad options\n";
 initdebug('git-debrebase ');
 enabledebug if $debuglevel;
 
@@ -1447,7 +1499,7 @@ $rd = fresh_playground "$playprefix/misc";
 
 @opt_anchors = map { git_rev_parse $_ } @opt_anchors;
 
-if (!@ARGV || $ARGV[0] =~ m{^-}) {
+if (!@ARGV || $opt_defaultcmd_interactive || $ARGV[0] =~ m{^-}) {
     defaultcmd_rebase();
 } else {
     my $cmd = shift @ARGV;