chiark / gitweb /
exit status: Fix dgit-badcommit-fixup to use Debian::Dgit::ExitStatus
[dgit.git] / git-debrebase
index 2a6aea7a85d671fc01299a330e1e98aeab632bb7..bf9af61627bfc2f5bbd85c87417eec7e2a6c7d42 100755 (executable)
@@ -3,7 +3,7 @@
 # Script helping make fast-forwarding histories while still rebasing
 # upstream deltas when working on Debian packaging
 #
-# Copyright (C)2017 Ian Jackson
+# Copyright (C)2017,2018 Ian Jackson
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-# usages:
-#    git-debrebase status
-#    git-debrebase start       # like ffqrebase start + debrebase launder
-#    git-debrebase new-upstream [stuff]  # see below
-#    git-debrebase <git-rebase options>  # does debrebase start if necessary
-#
-#    git-debrebase analyse
-#    git-debrebase launder     # prints breakwater tip
-#    git-debrebase create-new-upstream-breakwater [-f] <upstreaminfo>...
-#
-# <upstreaminfo> is
-#    [,][<subdir>:][+]<commitid>[,...]
-#
-# if initial comma is supplied, entries are not positional.  Unspecified
-# <subdir> means root (and there may be only one).
-# xxx want auto branch names
-# xxx too complicated
-# how about for now
-#    [+]<commit> [<subdir/> [+]<commit>...]
-# ?  plus options
-#     --new-upstream-different-subtrees
-#
-#  automatic case
-#       git-debrebase new-upstream
-#             - previous breakwater merge must be gdr-generated
-#             - orig set is the same as before
-#             - implicitly uses upstream branches according to orig set
-#             - not all upstream branches need be updated
-#             - insists on fast-forward of each branch, unless
-#                  --force (or --force=<subdir>[/])
-#  branch set adjustments
-#       git-debrebase new-upstream --add <subdir>/
-#       git-debrebase new-upstream --rm <subdir>/
-#       git-debrebase new-upstream / [<subdir>/ ...]
-#             - orig set is adjusted
-#             - otherwise like auto (--add is not checked for ffness, obv)
-#             - multiple --add and --rm may be specified
-#             - --add makes new upstream the last contributor
-#  explicit
-#       git-debrebase / [<rootcommitid>] [<subdir>/ [<commitid>] ...]
-#             - orig set is precisely as specified now
-#             - previous breakwater merge is irrelevant
-#             - no fast forward checks
-#  for now only explicit with commitids
-
-#         implicitly uses `upstream'
-#                                     # (or multiple other branches)
-#       git-debrebase new-upstream \
-#             [<subdir>/]=<commitid>
-
-#    UPSTREAM[,[[SUBDIR:]SUBUPSTREAM]
-#    default for SUBDIR: is from previous upstream merge[xxx terminology]
-#    
-#
-#xxx
-# when starting must record original start (for ff)
-# and new rebase basis
-#
-#    git-ffqrebase start [BASE]
-#                # records previous HEAD so it can be overwritten
-#                # records base for future git-ffqrebase
-#    git-ffqrebase set-base BASE
-#    git-ffqrebase <git-rebase options>
-#    git-ffqrebase finish
-#    git-ffqrebase status [BRANCH]
-#
-#  refs/ffqrebase-prev/BRANCH    BRANCH may be refs/...; if not it means
-#  refs/ffqrebase-base/BRANCH      refs/heads/BRANCH
-#                               zero, one, or both of these may exist
-#
-# git-debrebase without start, if already started, is willing
-# to strip pseudomerges provided that they overwrite exactly
-# the previous HEAD
-#  xxxx is this right ?  what matters is have we pushed
-#    I think in fact the right answer is:
-#       git-debrebase always strips out pseudomerges from its branch
-#       a pseudomerge is put in at the time we want to push
-#       at that time, we make a pseudomerge of the remote tracking
-#           branch (if raw git) or the dgit view (if dgit)
-#       for raw git git-ffqrebase, do want preciseley to record
-#           value of remote tracking branch or our branch, on start, so we
-#           overwrite only things we intend to
-#  the previous pseudomerge    check for tags and remote branches ?
+END { $? = $Debian::Dgit::ExitStatus::desired // -1; };
+use Debian::Dgit::ExitStatus;
 
 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 File::FnMatch qw(:fnmatch);
+
+our ($opt_force, $opt_noop_ok, @opt_anchors);
+our ($opt_defaultcmd_interactive);
 
-use Debian::Dgit qw(:DEFAULT $wa);
+our $us = qw(git-debrebase);
 
 sub badusage ($) {
     my ($m) = @_;
-    die "bad usage: $m\n";
+    print STDERR "bad usage: $m\n";
+    finish 12;
 }
 
-sub cfg ($) {
-    my ($k) = @_;
-    $/ = "\0";
+sub cfg ($;$) {
+    my ($k, $optional) = @_;
+    local $/ = "\0";
     my @cmd = qw(git config -z);
     push @cmd, qw(--get-all) if wantarray;
     push @cmd, $k;
-    my $out = cmdoutput @cmd;
-    return split /\0/, $out;
+    my $out = cmdoutput_errok @cmd;
+    if (!defined $out) {
+       fail "missing required git config $k" unless $optional;
+       return ();
+    }
+    my @l = split /\0/, $out;
+    return wantarray ? @l : $l[0];
 }
 
 memoize('cfg');
 
+sub dd ($) {
+    my ($v) = @_;
+    my $dd = new Data::Dumper [ $v ];
+    Terse $dd 1; Indent $dd 0; Useqq $dd 1;
+    return Dump $dd;
+}
+
 sub get_commit ($) {
     my ($objid) = @_;
-    my ($type,$data) = git_cat_file $objid;
-    die unless $type eq 'commit';
-    $data =~ m/(?<=\n)\n/;
+    my $data = (git_cat_file $objid, 'commit');
+    $data =~ m/(?<=\n)\n/ or die "$objid ($data) ?";
     return ($`,$');
 }
 
-sub D_DEB ()     { return 0x1; } # debian/ (not including debian/patches/)
-sub D_UPS ()     { return 0x2; } # upstream files
-sub D_PAT_ADD () { return 0x4; } # debian/patches/ extra patches at end
-sub D_PAT_OTH () { return 0x8; } # debian/patches other changes
+sub D_UPS ()      { 0x02; } # upstream files
+sub D_PAT_ADD ()  { 0x04; } # debian/patches/ extra patches at end
+sub D_PAT_OTH ()  { 0x08; } # debian/patches other changes
+sub D_DEB_CLOG () { 0x10; } # debian/ (not patches/ or changelog)
+sub D_DEB_OTH ()  { 0x20; } # debian/changelog
+sub DS_DEB ()     { D_DEB_CLOG | D_DEB_OTH; } # debian/ (not patches/)
+
+our $playprefix = 'debrebase';
+our $rd;
+our $workarea;
 
-our $rd = ".git/git-debrebase";
-our $ud = "$rd/work";
 our @git = qw(git);
 
+sub in_workarea ($) {
+    my ($sub) = @_;
+    changedir $workarea;
+    my $r = eval { $sub->(); };
+    { local $@; changedir $maindir; }
+    die $@ if $@;
+}
+
+sub fresh_workarea () {
+    $workarea = fresh_playground "$playprefix/work";
+    in_workarea sub { playtree_setup };
+}
+
+our $snags_forced;
+our $snags_tripped;
+our $snags_checked;
+our @deferred_updates;
+our @deferred_update_messages;
+
+sub run_deferred_updates ($) {
+    my ($mrest) = @_;
+
+    confess 'dangerous internal error' if
+       !$snags_checked || $snags_tripped || $snags_forced;
+
+    my @upd_cmd = (@git, qw(update-ref --stdin -m), "debrebase: $mrest");
+    debugcmd '>|', @upd_cmd;
+    open U, "|-", @upd_cmd or die $!;
+    foreach (@deferred_updates) {
+       printdebug ">= ", $_, "\n";
+       print U $_, "\n" or die $!;
+    }
+    printdebug ">\$\n";
+    close U or failedcmd @upd_cmd;
+
+    print $_, "\n" foreach @deferred_update_messages;
+
+    @deferred_updates = ();
+    @deferred_update_messages = ();
+}
+
+sub get_differs ($$) {
+    my ($x,$y) = @_;
+    # This resembles quiltify_trees_differ, in dgit, a bit.
+    # But we don't care about modes, or dpkg-source-unrepresentable
+    # changes, and we don't need the plethora of different modes.
+    # Conversely we need to distinguish different kinds of changes to
+    # debian/ and debian/patches/.
+
+    my $differs = 0;
+
+    my $rundiff = sub {
+       my ($opts, $limits, $fn) = @_;
+       my @cmd = (@git, qw(diff-tree -z --no-renames));
+       push @cmd, @$opts;
+       push @cmd, "$_:" foreach $x, $y;
+       push @cmd, '--', @$limits;
+       my $diffs = cmdoutput @cmd;
+       foreach (split /\0/, $diffs) { $fn->(); }
+    };
+
+    $rundiff->([qw(--name-only)], [], sub {
+        $differs |= $_ eq 'debian' ? DS_DEB : D_UPS;
+    });
+
+    if ($differs & DS_DEB) {
+       $differs &= ~DS_DEB;
+       $rundiff->([qw(--name-only -r)], [qw(debian)], sub {
+            $differs |=
+               m{^debian/patches/}      ? D_PAT_OTH  :
+               $_ eq 'debian/changelog' ? D_DEB_CLOG :
+                                          D_DEB_OTH;
+       });
+       die "mysterious debian changes $x..$y"
+           unless $differs & (D_PAT_OTH|DS_DEB);
+    }
+
+    if ($differs & D_PAT_OTH) {
+       my $mode;
+       $differs &= ~D_PAT_OTH;
+       my $pat_oth = sub {
+           $differs |= D_PAT_OTH;
+           no warnings qw(exiting);  last;
+       };
+       $rundiff->([qw(--name-status -r)], [qw(debian/patches/)], sub {
+            no warnings qw(exiting);
+            if (!defined $mode) {
+               $mode = $_;  next;
+           }
+           die unless s{^debian/patches/}{};
+           my $ok;
+           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');
+               my $y_s = (git_cat_file "$y:debian/patches/series", 'blob');
+               chomp $x_s;  $x_s .= "\n";
+               $ok = $x_s eq substr($y_s, 0, length $x_s);
+           } else {
+               # nope
+           }
+           $mode = undef;
+           $differs |= $ok ? D_PAT_ADD : D_PAT_OTH;
+        });
+       die "mysterious debian/patches changes $x..$y"
+           unless $differs & (D_PAT_ADD|D_PAT_OTH);
+    }
+
+    printdebug sprintf "get_differs %s, %s = %#x\n", $x, $y, $differs;
+
+    return $differs;
+}
+
 sub commit_pr_info ($) {
     my ($r) = @_;
     return Data::Dumper->dump([$r], [qw(commit)]);
@@ -157,6 +215,63 @@ 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;
+}
+
+sub make_commit ($$) {
+    my ($parents, $message_paras) = @_;
+    my $tree = cmdoutput @git, qw(write-tree);
+    my @cmd = (@git, qw(commit-tree), $tree);
+    push @cmd, qw(-p), $_ foreach @$parents;
+    push @cmd, qw(-m), $_ foreach @$message_paras;
+    return cmdoutput @cmd;
+}
+
+our @snag_force_opts;
+sub snag ($$) {
+    my ($tag,$msg) = @_;
+    if (grep { $_ eq $tag } @snag_force_opts) {
+       $snags_forced++;
+       print STDERR "git-debrebase: snag ignored (-f$tag): $msg\n";
+    } else {
+       $snags_tripped++;
+       print STDERR "git-debrebase: snag detected (-f$tag): $msg\n";
+    }
+}
+
+sub snags_maybe_bail () {
+    $snags_checked++;
+    if ($snags_forced) {
+       printf STDERR
+           "%s: snags: %d overriden by individual -f options\n",
+           $us, $snags_forced;
+       $snags_forced=0;
+    }
+    if ($snags_tripped) {
+       if ($opt_force) {
+           printf STDERR
+               "%s: snags: %d overriden by global --force\n",
+               $us, $snags_tripped;
+           $snags_tripped=0;
+       } else {
+           fail sprintf
+  "%s: snags: %d blockers (you could -f<tag>, or --force)",
+               $us, $snags_tripped;
+       }
+    }
+}
+sub any_snags () {
+    return $snags_forced || $snags_tripped;
+}
+
 # classify returns an info hash like this
 #   CommitId => $objid
 #   Hdr => # commit headers, including 1 final newline
@@ -175,10 +290,10 @@ sub calculate_committer_authline () {
 #
 # Types:
 #   Packaging
+#   Changelog
 #   Upstream
 #   AddPatches
 #   Mixed
-#   Unknown
 #
 #   Pseudomerge
 #     has additional entres in classification result
@@ -189,56 +304,153 @@ sub calculate_committer_authline () {
 #     has additional entry in classification result
 #       OrigParents = [ subset of Parents ]
 #
-#   BreakwaterUpstreamMerge
+#   Anchor
 #     has additional entry in classification result
-#       OrigParents = [ subset of Parents ]
+#       OrigParents = [ subset of Parents ]  # singleton list
+#
+#   TreatAsAnchor
+#
+#   BreakwaterStart
+#
+#   Unknown
+#     has additional entry in classification result
+#       Why => "prose"
 
-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+)$/m;
-    my @p;
+    my (@ph) = $h =~ m/^parent (\w+)$/mg;
 
     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 => scalar @$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";
+
     my $classify = sub {
        my ($type, @rest) = @_;
        $r = { %$r, Type => $type, @rest };
+       if ($debuglevel) {
+           printdebug " = $type ".(dd $r)."\n";
+       }
        return $r;
     };
     my $unknown = sub {
        my ($why) = @_;
-       $r = { %$r, Type => qw(Unknown) };
+       $r = { %$r, Type => qw(Unknown), Why => $why };
+       printdebug " ** Unknown\n";
        return $r;
     };
 
+    if (grep { $_ eq $objid } @opt_anchors) {
+       return $classify->('TreatAsAnchor');
+    }
+
+    my @identical = grep { !$_->{Differs} } @p;
+    my ($stype, $series) = git_cat_file "$t:debian/patches/series";
+    my $haspatches = $stype ne 'missing' && $series =~ m/^\s*[^#\n\t ]/m;
+
+    if ($r->{Msg} =~ m{^\[git-debrebase anchor.*\]$}m) {
+       # multi-orig upstreams are represented with an anchor merge
+       # from a single upstream commit which combines the orig tarballs
+
+       # Every anchor tagged this way must be a merge.
+       # We are relying on the
+       #     [git-debrebase anchor: ...]
+       # commit message annotation in "declare" anchor merges (which
+       # do not have any upstream changes), to distinguish those
+       # anchor merges from ordinary pseudomerges (which we might
+       # just try to strip).
+       #
+       # However, the user is going to be doing git-rebase a lot.  We
+       # really don't want them to rewrite an anchor commit.
+       # git-rebase trips up on merges, so that is a useful safety
+       # catch.
+       #
+       # 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");
+       $haspatches and return $badanchor->("contains debian/patches");
+
+       # How to decide about l/r ordering of anchors ?  git
+       # --topo-order prefers to expand 2nd parent first.  There's
+       # already an easy rune to look for debian/ history anyway (git log
+       # debian/) so debian breakwater branch should be 1st parent; that
+       # way also there's also an easy rune to look for the upstream
+       # patches (--topo-order).
+
+       $p[0]{IsOrigin} and $badanchor->("is an origin commit");
+       $p[1]{Differs} & ~DS_DEB and
+           $badanchor->("upstream files differ from left parent");
+       $p[0]{Differs} & ~D_UPS and
+           $badanchor->("debian/ differs from right parent");
+
+       return $classify->(qw(Anchor),
+                          OrigParents => [ $p[1] ]);
+    }
+
     if (@p == 1) {
        my $d = $r->{Parents}[0]{Differs};
        if ($d == D_PAT_ADD) {
            return $classify->(qw(AddPatches));
        } elsif ($d & (D_PAT_ADD|D_PAT_OTH)) {
            return $unknown->("edits debian/patches");
-       } elsif ($d == D_DEB) {
-           my ($ty,$dummy) = git_cat_file "$ph[0]:debian";
+       } elsif ($d & DS_DEB and !($d & ~DS_DEB)) {
+           my ($ty,$dummy) = git_cat_file "$p[0]{CommitId}:debian";
            if ($ty eq 'tree') {
-               return $classify->(qw(Packaging));
+               if ($d == D_DEB_CLOG) {
+                   return $classify->(qw(Changelog));
+               } else {
+                   return $classify->(qw(Packaging));
+               }
            } elsif ($ty eq 'missing') {
                return $classify->(qw(BreakwaterStart));
            } else {
@@ -246,7 +458,7 @@ sub classify ($) {
            }
        } elsif ($d == D_UPS) {
            return $classify->(qw(Upstream));
-       } elsif ($d == (D_DEB|D_UPS)) {
+       } elsif ($d & DS_DEB and $d & D_UPS and !($d & ~(DS_DEB|D_UPS))) {
            return $classify->(qw(Mixed));
        } elsif ($d == 0) {
            return $unknown->("no changes");
@@ -258,32 +470,40 @@ sub classify ($) {
        return $unknown->("origin commit");
     }
 
-    my @identical = grep { !$_->{Differs} } @p;
     if (@p == 2 && @identical == 1) {
        my @overwritten = grep { $_->{Differs} } @p;
        confess "internal error $objid ?" unless @overwritten==1;
        return $classify->(qw(Pseudomerge),
-                          Overwritten => $overwritten[0],
+                          Overwritten => [ $overwritten[0] ],
                           Contributor => $identical[0]);
     }
     if (@p == 2 && @identical == 2) {
-       my @bytime = nsort_by {
-           my ($ph,$pm) = get_commit $_->{CommitId};
+       my $get_t = sub {
+           my ($ph,$pm) = get_commit $_[0]{CommitId};
            $ph =~ m/^committer .* (\d+) [-+]\d+$/m or die "$_->{CommitId} ?";
            $1;
-       } @p;
+       };
+       my @bytime = @p;
+       my $order = $get_t->($bytime[0]) <=> $get_t->($bytime[1]);
+       if ($order > 0) { # newer first
+       } elsif ($order < 0) {
+           @bytime = reverse @bytime;
+       } else {
+           # same age, default to order made by -s ours
+           # that is, commit was made by someone who preferred L
+       }
        return $classify->(qw(Pseudomerge),
                           SubType => qw(Ambiguous),
-                          Overwritten => $bytime[0],
-                          Contributor => $bytime[1]);
+                          Contributor => $bytime[0],
+                          Overwritten => [ $bytime[1] ]);
     }
     foreach my $p (@p) {
-       my ($p_h, $p_m) = get_commit $p;
+       my ($p_h, $p_m) = get_commit $p->{CommitId};
        $p->{IsOrigin} = $p_h !~ m/^parent \w+$/m;
        ($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) {
@@ -292,56 +512,118 @@ sub classify ($) {
                           OrigParents => \@orig_ps);
     }
 
-    my ($stype, $series) = git_cat_file "$t:debian/patches/series";
-    my $haspatches = $stype ne 'missing' && $series =~ m/^\s*[^#\n\t ]/m;
+    return $unknown->("complex merge");
+}
 
-    # How to decide about l/r ordering of breakwater merges ?  git
-    # --topo-order prefers to expand 2nd parent first.  There's
-    # already an easy rune to look for debian/ history anyway (git log
-    # debian/) so debian breakwater branch should be 1st parent; that
-    # way also there's also an easy rune to look for the upstream
-    # patches (--topo-order).
-    if (@p == 2 &&
-       !$haspatches &&
-       !$p[0]{IsOrigin} && # breakwater merge never starts with an origin
-       !($p[0]{Differs} & ~D_DEB) &&
-       !($p[1]{Differs} & ~D_UPS)) {
-       return $classify->(qw(BreakwaterUpstreamMerge),
-                          OrigParents => [ $p[1] ]);
-    }
-    # xxx multi-.orig upstreams
+sub keycommits ($;$$$) {
+    my ($head, $furniture, $unclean, $trouble) = @_;
+    # => ($anchor, $breakwater)
 
-    return $unknown->("complex merge");
+    # $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') {
+           $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') {
+           $x->($unclean, 'ordering',
+ "packaging change ($breakwater) follows upstream change (eg $head)")
+               if defined $breakwater;
+           $clogonly = undef;
+           $breakwater = undef;
+       } elsif ($ty eq 'Mixed') {
+           $x->($unclean, 'mixed',
+                "found mixed upstream/packaging commit ($head)");
+           $clogonly = undef;
+           $breakwater = undef;
+       } elsif ($ty eq 'Pseudomerge' or
+                $ty eq 'AddPatches') {
+           $x->($furniture, (lc $ty),
+                "found interchange bureaucracy commit ($ty, $head)");
+       } elsif ($ty eq 'DgitImportUnpatched') {
+           $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 ($anchor, $breakwater);
 }
 
-sub walk ($;$$$$);
-sub walk {
+sub walk ($;$$);
+sub walk ($;$$) {
     my ($input,
-       $nogenerate,$report,
-       $wantbrwonly,$depth) = @_;
-    # => ($tip, $breakwater_tip)
+       $nogenerate,$report) = @_;
+    # => ($tip, $breakwater_tip, $last_anchor)
+    # (or nothing, if $nogenerate)
+
+    printdebug "*** WALK $input ".($nogenerate//0)." ".($report//'-')."\n";
 
     # go through commits backwards
     # we generate two lists of commits to apply:
     # breakwater branch and upstream patches
     my (@brw_cl, @upp_cl, @processed);
     my %found;
+    my $upp_limit;
     my @pseudomerges;
 
-    $depth //= 0;
-
     my $cl;
     my $xmsg = sub {
-       my ($appendinfo) = @_;
+       my ($prose, $info) = @_;
        my $ms = $cl->{Msg};
        chomp $ms;
-       $ms .= "\n\n[git-debrebase $appendinfo]\n";
+       $info //= '';
+       $ms .= "\n\n[git-debrebase$info: $prose]\n";
        return (Msg => $ms);
     };
     my $rewrite_from_here = sub {
-       push @processed, { SpecialMethod => 'StartRewrite' };
+       my ($cl) = @_;
+       my $sp_cl = { SpecialMethod => 'StartRewrite' };
+       push @$cl, $sp_cl;
+       push @processed, $sp_cl;
     };
-
     my $cur = $input;
 
     my $prdelim = "";
@@ -355,19 +637,31 @@ sub walk {
 
     my $bomb = sub { # usage: return $bomb->();
        print $report " Unprocessable" if $report;
+       print $report " ($cl->{Why})" if $report && defined $cl->{Why};
        $prprdelim->();
        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} }).
+           (defined $cl->{Why} ? "; $cl->{Why}": '').
+                ")";
     };
 
+    my $build;
+    my $breakwater;
+
+    my $build_start = sub {
+       my ($msg, $parent) = @_;
+       $prline->(" $msg");
+       $build = $parent;
+       no warnings qw(exiting); last;
+    };
+
+    my $last_anchor;
+
     for (;;) {
-       if (!defined $cur) {
-           push @brw_cl, { ExactlyParents => [] };
-           $prline->("Origin");
-           last;
-       }
        $cl = classify $cur;
        my $ty = $cl->{Type};
        my $st = $cl->{SubType};
@@ -377,16 +671,15 @@ sub walk {
        my $p0 = @{ $cl->{Parents} }==1 ? $cl->{Parents}[0]{CommitId} : undef;
        if ($ty eq 'AddPatches') {
            $cur = $p0;
-           $rewrite_from_here->();
-           next;
-       } elsif ($ty eq 'Packaging') {
-           push @brw_cl, $cl;
-           $cur = $p0;
+           $rewrite_from_here->(\@upp_cl);
            next;
-       } elsif ($ty eq 'Packaging') {
+       } elsif ($ty eq 'Packaging' or $ty eq 'Changelog') {
            push @brw_cl, $cl;
            $cur = $p0;
            next;
+       } elsif ($ty eq 'BreakwaterStart') {
+            $last_anchor = $cur;
+           $build_start->('FirstPackaging', $cur);
        } elsif ($ty eq 'Upstream') {
            push @upp_cl, $cl;
            $cur = $p0;
@@ -394,23 +687,24 @@ 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");
            $queue->(\@upp_cl, "upstream");
-           $rewrite_from_here->();
+           $rewrite_from_here->(\@brw_cl);
+           $cur = $p0;
            next;
        } elsif ($ty eq 'Pseudomerge') {
-           print $report " Contributor=$ty->{Contributor}" if $report;
+           my $contrib = $cl->{Contributor}{CommitId};
+           print $report " Contributor=$contrib" if $report;
            push @pseudomerges, $cl;
-           $rewrite_from_here->();
-           $cur = $ty->{Contributor};
+           $rewrite_from_here->(\@upp_cl);
+           $cur = $contrib;
            next;
-       } elsif ($ty eq 'BreakwaterUpstreamMerge') {
-           push @brw_cl, { ExactlyParents => [$cur] };
-           $prline->("PreviousBreakwater");
-           last;
+       } elsif ($ty eq 'Anchor' or $ty eq 'TreatAsAnchor') {
+            $last_anchor = $cur;
+           $build_start->("Anchor", $cur);
        } elsif ($ty eq 'DgitImportUnpatched') {
            my $pm = $pseudomerges[-1];
            if (defined $pm) {
@@ -423,9 +717,11 @@ sub walk {
                # suite intended by the non-dgit NMUer, and later
                # pseudomerges may represent in-archive copies.
                my $ovwrs = $pm->{Overwritten};
-               printf $report " PM=%s \@Overwr:%d", $pm, (scalar @$ovwrs)
+               printf $report " PM=%s \@Overwr:%d",
+                   $pm->{CommitId}, (scalar @$ovwrs)
                    if $report;
                if (@$ovwrs != 1) {
+                    printdebug "*** WALK BOMB DgitImportUnpatched\n";
                    return $bomb->();
                }
                my $ovwr = $ovwrs->[0]{CommitId};
@@ -445,78 +741,69 @@ sub walk {
                    %$cl,
                    SpecialMethod => 'DgitImportDebianUpdate',
                     $xmsg->("convert dgit import: debian changes")
+               }, {
+                   %$cl,
+                   SpecialMethod => 'DgitImportUpstreamUpdate',
+                    $xmsg->("convert dgit import: upstream update",
+                           " anchor")
                };
-               my $differs = (get_differs $ovwr, $cl->{Tree});
-               printf $report " Differs=%#x", $differs if $report;
-               if ($differs & D_UPS) {
-                   printf $report " D_UPS" if $report;
-                   # This will also trigger if a non-dgit git-based NMU
-                   # deleted .gitignore (which is a thing that some of
-                   # the existing git tools do if the user doesn't
-                   # somehow tell them not to).  Ah well.
-                   push @brw_cl, {
-                       %$cl,
-                       SpecialMethod => 'DgitImportUpstreamUpdate',
-                       $xmsg->("convert dgit import: upstream changes")
-                   };
-               }
-               $prline->("Import");
-               $prprdelim->();
-               my ($dummy,$basis) = walk
-                   $ovwr,
-                   $nogenerate, $report,
-                   1, $depth+1;
-               push @brw_cl, { ExactlyParents => [$basis] };
-               $rewrite_from_here->();
-               last;
+               $prline->(" Import");
+               $rewrite_from_here->(\@brw_cl);
+               $upp_limit //= $#upp_cl; # further, deeper, patches discarded
+               $cur = $ovwr;
+               next;
            } else {
                # Everything is from this import.  This kind of import
                # is already in valid breakwater format, with the
                # patches as commits.
                printf $report " NoPM" if $report;
-               push @brw_cl, { ExactlyParents => [$cur] };
                # last thing we processed will have been the first patch,
                # if there is one; which is fine, so no need to rewrite
                # on account of this import
-               $prline->("ImportOrigin");
-               last;
+               $build_start->("ImportOrigin", $cur);
            }
            die "$ty ?";
         } else {
+            printdebug "*** WALK BOMB unrecognised\n";
            return $bomb->();
        }
     }
     $prprdelim->();
-    return () if $nogenerate;
+
+    printdebug "*** WALK prep done cur=$cur".
+        " brw $#brw_cl upp $#upp_cl proc $#processed pm $#pseudomerges\n";
+
+    return if $nogenerate;
 
     # Now we build it back up again
 
-    workarea_fresh();
+    fresh_workarea();
 
     my $rewriting = 0;
 
-    my $build = $basis;
-
-    my $rm_tree_cached = sub {
-       my ($subdir) = @_;
-       runcmd @git, qw(rm --quiet -rf --cached), $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";
+        rm_subdir_cached 'debian/patches';
     };
     my $read_tree_upstream = sub {
        my ($treeish) = @_;
        runcmd @git, qw(read-tree), $treeish;
        $read_tree_debian->($build);
     };
+
+    $#upp_cl = $upp_limit if defined $upp_limit;
  
     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)) {
@@ -527,6 +814,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') {
@@ -535,25 +824,32 @@ sub walk {
                $rewriting = 1;
                next;
            } elsif ($method eq 'RecordBreakwaterTip') {
-               last if $wantbrwonly;
                $breakwater = $build;
                next;
            } elsif ($method eq 'DgitImportDebianUpdate') {
                $read_tree_debian->($cltree);
-               $rm_tree_cached->(qw(debian/patches));
            } elsif ($method eq 'DgitImportUpstreamUpdate') {
+               confess unless $rewriting;
+               my $differs = (get_differs $build, $cltree);
+               next unless $differs & D_UPS;
                $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{^parent .*\n}{}mg;
            $ch =~ s{(?=^author)}{
-               map { "parent $_\n" } @parents
+               join '', map { "parent $_\n" } @parents
            }me or confess "$ch ?";
            if ($rewriting) {
                $ch =~ s{^committer .*$}{$committer_authline}m
@@ -569,31 +865,71 @@ sub walk {
            my $newcommit = cmdoutput @cmd;
            confess "$ch ?" unless $rewriting or $newcommit eq $cl->{CommitId};
            $build = $newcommit;
+            if (grep { $method eq $_ } qw(DgitImportUpstreamUpdate)) {
+                $last_anchor = $cur;
+            }
        }
     };
 
-    runcmd @git, qw(diff-tree --quiet),
-       map { $wantdebonly ? "$_:debian" : $_ }
-       $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;
+
+    my @r = ($build, $breakwater, $last_anchor);
+    printdebug "*** WALK RETURN @r\n";
+    return @r
+}
 
-    return ($build, $breakwater);
+sub get_head () {
+    git_check_unmodified();
+    return git_rev_parse qw(HEAD);
 }
 
-sub get_head () { return git_rev_parse qw(HEAD); }
+sub update_head ($$$) {
+    my ($old, $new, $mrest) = @_;
+    push @deferred_updates, "update HEAD $new $old";
+    run_deferred_updates $mrest;
+}
 
-sub update_head ($$) {
+sub update_head_checkout ($$$) {
     my ($old, $new, $mrest) = @_;
-    runcmd @git, qw(update-ref -m), "git-debrebase $mrest", $new, $old;
+    update_head $old, $new, $mrest;
+    runcmd @git, qw(reset --hard);
 }
 
-sub cmd_launder () {
-    badusage "no arguments to launder allowed";
+sub update_head_postlaunder ($$$) {
+    my ($old, $tip, $reflogmsg) = @_;
+    return if $tip eq $old;
+    print "git-debrebase: laundered (head was $old)\n";
+    update_head $old, $tip, $reflogmsg;
+    # no tree changes except debian/patches
+    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 $old, $tip, 'launder';
-    # no tree changes except debian/patches
-    runcmd @git, qw(rm --quiet -rf debian/patches);
+    snags_maybe_bail();
+    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();
+    my ($tip,$breakwater,$last_anchor) = walk $old;
+    update_head_postlaunder $old, $tip, 'launder';
     printf "# breakwater tip\n%s\n", $breakwater;
+    printf "# working tip\n%s\n", $tip;
+    printf "# last anchor\n%s\n", $last_anchor;
+}
+
+sub defaultcmd_rebase () {
+    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 () {
@@ -603,20 +939,651 @@ sub cmd_analyse () {
     if (defined $old) {
        $old = git_rev_parse $old;
     } else {
-       $old = get_head();
+       $old = git_rev_parse 'HEAD';
     }
     my ($dummy,$breakwater) = walk $old, 1,*STDOUT;
-    print "$breakwater BREAKWATER\n";
     STDOUT->error and die $!;
 }
 
-my $toplevel = runcmd @git, qw(rev-parse --show-toplevel);
+sub ffq_prev_branchinfo () {
+    # => ('status', "message", [$current, $ffq_prev, $gdrlast])
+    # 'status' may be
+    #    branch         message is undef
+    #    weird-symref   } no $current,
+    #    notbranch      }  no $ffq_prev
+    my $current = git_get_symref();
+    return ('detached', 'detached HEAD') unless defined $current;
+    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, $gdrlast);
+}
+
+sub record_ffq_prev_deferred () {
+    # => ('status', "message")
+    # 'status' may be
+    #    deferred          message is undef
+    #    exists
+    #    detached
+    #    weird-symref
+    #    notbranch
+    # 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, $gdrlast)
+       = ffq_prev_branchinfo();
+    return ($status, $message) unless $status eq 'branch';
+
+    my $currentval = get_head();
+
+    my $exists = git_get_ref $ffq_prev;
+    return ('exists',"$ffq_prev already exists") if $exists;
+
+    return ('not-branch', 'HEAD symref is not to refs/heads/')
+       unless $current =~ m{^refs/heads/};
+    my $branch = $';
+
+    my @check_specs = split /\;/, (cfg "branch.$branch.ffq-ffrefs",1) // '*';
+    my %checked;
+
+    printdebug "ffq check_specs @check_specs\n";
+
+    my $check = sub {
+       my ($lrref, $desc) = @_;
+       printdebug "ffq might check $lrref ($desc)\n";
+       my $invert;
+       for my $chk (@check_specs) {
+           my $glob = $chk;
+           $invert = $glob =~ s{^[!^]}{};
+           last if fnmatch $glob, $lrref;
+       }
+       return if $invert;
+       my $lrval = git_get_ref $lrref;
+       return unless defined $lrval;
+
+       if (is_fast_fwd $lrval, $currentval) {
+           print "OK, you are ahead of $lrref\n" or die $!;
+           $checked{$lrref} = 1;
+       } elsif (is_fast_fwd $currentval, $lrval) {
+           $checked{$lrref} = -1;
+           snag 'behind', "you are behind $lrref, divergence risk";
+       } else {
+           $checked{$lrref} = -1;
+           snag 'diverged', "you have diverged from $lrref";
+       }
+    };
+
+    my $merge = cfg "branch.$branch.merge",1;
+    if (defined $merge and $merge =~ m{^refs/heads/}) {
+       my $rhs = $';
+       printdebug "ffq merge $rhs\n";
+       my $check_remote = sub {
+           my ($remote, $desc) = @_;
+           printdebug "ffq check_remote ".($remote//'undef')." $desc\n";
+           return unless defined $remote;
+           $check->("refs/remotes/$remote/$rhs", $desc);
+       };
+       $check_remote->((scalar cfg "branch.$branch.remote",1),
+                       'remote fetch/merge branch');
+       $check_remote->((scalar cfg "branch.$branch.pushRemote",1) //
+                       (scalar cfg "branch.$branch.pushDefault",1),
+                       'remote push branch');
+    }
+    if ($branch =~ m{^dgit/}) {
+       $check->("refs/remotes/dgit/$branch", 'remote dgit branch');
+    } elsif ($branch =~ m{^master$}) {
+       $check->("refs/remotes/dgit/dgit/sid", 'remote dgit branch for sid');
+    }
+
+    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);
+}
+
+sub record_ffq_auto () {
+    my ($status, $message) = record_ffq_prev_deferred();
+    if ($status eq 'deferred' || $status eq 'exists') {
+    } else {
+       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, $unclean) = @_;
+
+    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, $unclean,$unclean,$unclean;
+    snags_maybe_bail();
+
+    stitch($dangling_head, $ffq_prev, $gdrlast, $ffq_prev_commitish, $prose);
+}
+
+sub cmd_new_upstream_v0 () {
+    # automatically and unconditionally launders before rebasing
+    # if rebase --abort is used, laundering has still been done
+
+    my %pieces;
+
+    badusage "need NEW-VERSION [UPS-COMMITTISH]" unless @ARGV >= 1;
+
+    # 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 // 'upstream');
+
+    record_ffq_auto();
+
+    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; }
+        $pc;
+    };
+
+    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 && $ARGV[0] !~ m{^-}) {
+       my $n = shift @ARGV;
+
+        badusage "for each EXTRA-UPS-NAME need EXTRA-UPS-COMMITISH"
+            unless @ARGV && $ARGV[0] !~ m{^-};
+
+       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_anchor) = walk $old_head;
+
+    my $old_bw_cl = classify $old_bw;
+    my $old_anchor_cl = classify $old_anchor;
+    my $old_upstream;
+    if (!$old_anchor_cl->{OrigParents}) {
+       snag 'anchor-treated',
+           'old anchor is recognised due to --anchor, cannot check upstream';
+    } else {
+       $old_upstream = parsecommit
+           $old_anchor_cl->{OrigParents}[0]{CommitId};
+       $piece->('', Old => $old_upstream->{CommitId});
+    }
+
+    if ($old_upstream && $old_upstream->{Msg} =~ m{^\[git-debrebase }m) {
+       if ($old_upstream->{Msg} =~
+ m{^\[git-debrebase upstream-combine \.((?: $extra_orig_namepart_re)+)\:.*\]$}m
+          ) {
+           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 {
+           snag 'upstream-confusing',
+               "previous upstream $old_upstream->{CommitId} is from".
+               " git-debrebase but not an \`upstream-combine' commit";
+       }
+    }
+
+    foreach my $pc (values %pieces) {
+       if (!$old_upstream) {
+           # we have complained already
+       } elsif (!$pc->{Old}) {
+           snag 'upstream-new-piece',
+               "introducing upstream piece \`$pc->{Name}'";
+       } elsif (!$pc->{New}) {
+           snag 'upstream-rm-piece',
+               "dropping upstream piece \`$pc->{Name}'";
+       } elsif (!is_fast_fwd $pc->{Old}, $pc->{New}) {
+           snag 'upstream-not-ff',
+               "not fast forward: $pc->{Name} $pc->{Old}..$pc->{New}";
+       }
+    }
+
+    printdebug "%pieces = ", (dd \%pieces), "\n";
+    printdebug "\@newpieces = ", (dd \@newpieces), "\n";
+
+    snags_maybe_bail();
+
+    my $new_bw;
+
+    fresh_workarea();
+    in_workarea sub {
+       my @upstream_merge_parents;
+
+       if (!any_snags()) {
+           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
+            $new_upstream = make_commit \@upstream_merge_parents,
+                [ "Combine upstreams for $new_upstream_version",
+ ("[git-debrebase upstream-combine . ".
+ (join " ", map { $_->{Name} } @newpieces[1..$#newpieces]).
+ ": new upstream]"),
+                ];
+       }
+
+       # $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 anchor merge.
+
+       read_tree_subdir 'debian', "$old_bw:debian";
+
+       # index now contains the anchor merge contents
+        $new_bw = make_commit [ $old_bw, $new_upstream ],
+            [ "Update to upstream $new_upstream_version",
+ "[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";
+       die $! unless $!==ENOENT or $!==ENOTEMPTY;
+       unlink "debian/changelog" or $!==ENOENT or die $!;
+        mkdir "debian" 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.
+
+ -- $clogsignoff
+
+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
+        $new_bw = make_commit [ $new_bw ],
+            [ "Update changelog for new upstream $new_upstream_version",
+              "[git-debrebase: new upstream $new_upstream_version, changelog]",
+            ];
+    };
+
+    # 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_postlaunder $old_head, $old_laundered_tip,
+        'launder for new upstream';
+
+    my @cmd = (@git, qw(rebase --onto), $new_bw, $old_bw, @ARGV);
+    runcmd @cmd;
+    # now it's for the user to sort out
+}
+
+sub cmd_record_ffq_prev () {
+    badusage "no arguments allowed" if @ARGV;
+    my ($status, $msg) = record_ffq_prev_deferred();
+    if ($status eq 'exists' && $opt_noop_ok) {
+       print "Previous head already recorded\n" or die $!;
+    } elsif ($status eq 'deferred') {
+       run_deferred_updates 'record-ffq-prev';
+    } else {
+       fail "Could not preserve: $msg";
+    }
+}
+
+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 ($anchor, $bw) = keycommits +(git_rev_parse 'HEAD'), 0,0;
+    print "$bw\n" or die $!;
+}
+
+sub cmd_stitch () {
+    my $prose = 'stitch';
+    GetOptions('prose=s', \$prose) or die badusage("bad options to stitch");
+    badusage "no arguments allowed" if @ARGV;
+    do_stitch $prose, 0;
+}
+sub cmd_prepush () { cmd_stitch(); }
+
+sub cmd_quick () {
+    badusage "no arguments allowed" if @ARGV;
+    do_launder_head 'launder for git-debrebase quick';
+    do_stitch 'quick';
+}
+
+sub cmd_conclude () {
+    my ($ffq_prev, $gdrlast, $ffq_prev_commitish) = ffq_prev_info();
+    if (!$ffq_prev_commitish) {
+       fail "No ongoing git-debrebase session." unless $opt_noop_ok;
+       return;
+    }
+    my $dangling_head = get_head();
+    
+    badusage "no arguments allowed" if @ARGV;
+    do_launder_head 'launder for git-debrebase quick';
+    do_stitch 'quick';
+}
+
+sub make_patches_staged ($) {
+    my ($head) = @_;
+    # Produces the patches that would result from $head if it were
+    # laundered.
+    my ($secret_head, $secret_bw, $last_anchor) = walk $head;
+    fresh_workarea();
+    in_workarea sub {
+       runcmd @git, qw(checkout -q -b bw), $secret_bw;
+       runcmd @git, qw(checkout -q -b patch-queue/bw), $secret_head;
+       runcmd qw(gbp pq export);
+       runcmd @git, qw(add debian/patches);
+    };
+}
+
+sub make_patches ($) {
+    my ($head) = @_;
+    keycommits $head, 0, \&snag;
+    make_patches_staged $head;
+    my $out;
+    in_workarea sub {
+       my $ptree = cmdoutput @git, qw(write-tree --prefix=debian/patches/);
+       runcmd @git, qw(read-tree), $head;
+       read_tree_subdir 'debian/patches', $ptree;
+       $out = make_commit [$head], [
+            'Commit patch queue (exported by git-debrebase)',
+            '[git-debrebase: export and commit patches]',
+        ];
+    };
+    my $d = get_differs $head, $out;
+    if ($d == 0) {
+       return undef; # nothing to do
+    } elsif ($d == D_PAT_ADD) {
+       return $out; # OK
+    } else {
+       fail "Patch export produced patch amendments".
+           " (abandoned output commit $out).".
+           "  Try laundering first.";
+    }
+}
+
+sub cmd_make_patches () {
+    badusage "no arguments allowed" if @ARGV;
+    my $old_head = get_head();
+    my $new = make_patches $old_head;
+    snags_maybe_bail();
+    if (!$new) {
+       fail "No (more) patches to export." unless $opt_noop_ok;
+       return;
+    }
+    update_head_checkout $old_head, $new, 'make-patches';
+}
+
+sub cmd_convert_from_gbp () {
+    badusage "needs 1 optional argument, the upstream git rev"
+       unless @ARGV<=1;
+    my ($upstream_spec) = @ARGV;
+    $upstream_spec //= 'refs/heads/upstream';
+    my $upstream = git_rev_parse $upstream_spec;
+    my $old_head = get_head();
+
+    my $upsdiff = get_differs $upstream, $old_head;
+    if ($upsdiff & D_UPS) {
+       runcmd @git, qw(--no-pager diff),
+           $upstream, $old_head,
+           qw( -- :!/debian :/);
+ fail "upstream ($upstream_spec) and HEAD are not identical in upstream files";
+    }
+
+    if (!is_fast_fwd $upstream, $old_head) {
+       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) {
+           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') {
+       snag 'upstream-has-debian',
+           "upstream ($upstream) contains debian/ directory";
+    }
+
+    snags_maybe_bail();
+
+    my $work;
+
+    fresh_workarea();
+    in_workarea sub {
+       runcmd @git, qw(checkout -q -b gdr-internal), $old_head;
+       # make a branch out of the patch queue - we'll want this in a mo
+       runcmd qw(gbp pq import);
+       # strip the patches out
+       runcmd @git, qw(checkout -q gdr-internal~0);
+       rm_subdir_cached 'debian/patches';
+       $work = make_commit ['HEAD'], [
+ 'git-debrebase convert-from-gbp: drop patches from tree',
+ 'Delete debian/patches, as part of converting to git-debrebase format.',
+ '[git-debrebase convert-from-gbp: drop patches from tree]'
+                             ];
+       # make the anchor merge
+       # the tree is already exactly right
+       $work = make_commit [$work, $upstream], [
+ 'git-debrebase import: declare upstream',
+ 'First breakwater merge.',
+ '[git-debrebase anchor: declare upstream]'
+                             ];
+
+       # rebase the patch queue onto the new breakwater
+       runcmd @git, qw(reset --quiet --hard patch-queue/gdr-internal);
+       runcmd @git, qw(rebase --quiet --onto), $work, qw(gdr-internal);
+       $work = git_rev_parse 'HEAD';
+    };
+
+    update_head_checkout $old_head, $work, 'convert-from-gbp';
+}
+
+sub cmd_convert_to_gbp () {
+    badusage "no arguments allowed" if @ARGV;
+    my $head = get_head();
+    my (undef, undef, undef, $ffq, $gdrlast) = ffq_prev_branchinfo();
+    keycommits $head, 0;
+    my $out;
+    make_patches_staged $head;
+    in_workarea sub {
+       $out = make_commit ['HEAD'], [
+            'Commit patch queue (converted from git-debrebase format)',
+            '[git-debrebase convert-to-gbp: commit patches]',
+        ];
+    };
+    if (defined $ffq) {
+       push @deferred_updates, "delete $ffq";
+       push @deferred_updates, "delete $gdrlast";
+    }
+    snags_maybe_bail();
+    update_head_checkout $head, $out, "convert to gbp (v0)";
+    print <<END or die $!;
+git-debrebase: converted to git-buildpackage branch format
+git-debrebase: WARNING: do not now run "git-debrebase" any more
+git-debrebase: WARNING: doing so would drop all upstream patches!
+END
+}
+
+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,
+          'noop-ok', => \$opt_noop_ok,
+          'f=s' => \@snag_force_opts,
+          'anchor=s' => \@opt_anchors,
+          '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;
+
+my $toplevel = cmdoutput @git, qw(rev-parse --show-toplevel);
 chdir $toplevel or die "chdir $toplevel: $!";
 
-my $cmd = shift @ARGV;
-my $cmdfn = $cmd;
-$cmdfn =~ y/-/_/;
-$cmdfn = ${*::}{"cmd_$cmdfn"};
+$rd = fresh_playground "$playprefix/misc";
+
+@opt_anchors = map { git_rev_parse $_ } @opt_anchors;
+
+if (!@ARGV || $opt_defaultcmd_interactive || $ARGV[0] =~ m{^-}) {
+    defaultcmd_rebase();
+} else {
+    my $cmd = shift @ARGV;
+    my $cmdfn = $cmd;
+    $cmdfn =~ y/-/_/;
+    $cmdfn = ${*::}{"cmd_$cmdfn"};
+
+    $cmdfn or badusage "unknown git-debrebase sub-operation $cmd";
+    $cmdfn->();
+}
 
-$cmdfn or badusage "unknown git-debrebase sub-operation $cmd";
-$cmdfn->();
+finish 0;