3 # Script helping make fast-forwarding histories while still rebasing
4 # upstream deltas when working on Debian packaging
6 # Copyright (C)2017,2018 Ian Jackson
8 # This program is free software: you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation, either version 3 of the License, or
11 # (at your option) any later version.
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with this program. If not, see <http://www.gnu.org/licenses/>.
24 # git-debrebase [<options>] new-upstream-v0 \
25 # <new-version> <orig-commitish> \
26 # [<extra-orig-name> <extra-orig-commitish> ...] \
27 # [<git-rebase options>...]
29 # git-debrebase [<options> --] [<git-rebase options...>]
30 # git-debrebase [<options>] analyse
31 # git-debrebase [<options>] breakwater # prints breakwater tip only
32 # git-debrebase [<options>] stitch [--prose=<for commit message>]
33 # git-debrebase [<options>] launder-v0 # prints breakwater tip etc.
34 # git-debrebase [<options>] downstream-rebase-launder-v0 # experimental
36 # git-debrebase [<options>] convert-from-gbp [<upstream-git-rev>]
37 # git-debrebase [<options>] convert-to-gbp
39 # problems / outstanding questions:
41 # * dgit push with a `3.0 (quilt)' package means doing quilt
42 # fixup. Usually this involves recommitting the whole patch
43 # series, one at a time, with dpkg-source --commit. This is
44 # terribly terribly slow. (Maybe this should be fixed in dgit.)
46 # * dgit push usually needs to (re)make a pseudomerge. The "first"
47 # git-debrebase stripped out the previous pseudomerge and could
48 # have remembeed the HEAD. But it's not quite clear what history
49 # ought to be preserved and what should be discarded. For now
50 # the user will have to tell dgit --overwrite.
52 # To fix this, do we need a new push hook for dgit ?
54 # * Workflow is currently clumsy. Lots of spurious runes to type.
55 # There's not even a guide.
57 # * There are no tests.
59 # * new-upstream-v0 has a terrible UI. You end up with giant
60 # runic command lines.
62 # One consequence of the lack of richness it can need --force in
63 # fairly sensible situations and there is no way to tell it what
64 # you are really trying to do, other than just --force. There
65 # should be an interface with some default branch names.
67 # * There should be a standard convention for the version number,
68 # and unfinalised or not changelog, after new-upstream.
70 # * Handing of multi-orig dgit new-upstream .dsc imports is known to
71 # be broken. They may be not recognised, improperly converted, or
72 # their conversion may be unrecognised.
74 # * Docs need writing and updating. Even README.git-debrebase
75 # describes a design but may not reflect the implementation.
77 # * We need to develop a plausible model that works for derivatives,
78 # who probably want to maintain their stack on top of Debian's.
79 # downstream-rebase-launder-v0 may be a starting point?
83 use Debian::Dgit qw(:DEFAULT :playground);
90 use Getopt::Long qw(:config posix_default gnu_compat bundling);
92 use File::FnMatch qw(:fnmatch);
94 our ($opt_force, $opt_noop_ok);
96 our $us = qw(git-debrebase);
100 die "bad usage: $m\n";
104 my ($k, $optional) = @_;
106 my @cmd = qw(git config -z);
107 push @cmd, qw(--get-all) if wantarray;
109 my $out = cmdoutput_errok @cmd;
111 fail "missing required git config $k" unless $optional;
114 my @l = split /\0/, $out;
115 return wantarray ? @l : $l[0];
122 my $dd = new Data::Dumper [ $v ];
123 Terse $dd 1; Indent $dd 0; Useqq $dd 1;
129 my $data = (git_cat_file $objid, 'commit');
130 $data =~ m/(?<=\n)\n/ or die "$objid ($data) ?";
134 sub D_UPS () { 0x02; } # upstream files
135 sub D_PAT_ADD () { 0x04; } # debian/patches/ extra patches at end
136 sub D_PAT_OTH () { 0x08; } # debian/patches other changes
137 sub D_DEB_CLOG () { 0x10; } # debian/ (not patches/ or changelog)
138 sub D_DEB_OTH () { 0x20; } # debian/changelog
139 sub DS_DEB () { D_DEB_CLOG | D_DEB_OTH; } # debian/ (not patches/)
141 our $playprefix = 'debrebase';
147 sub in_workarea ($) {
150 my $r = eval { $sub->(); };
151 { local $@; changedir $maindir; }
155 sub fresh_workarea () {
156 $workarea = fresh_playground "$playprefix/work";
157 in_workarea sub { playtree_setup };
160 our @deferred_updates;
161 our @deferred_update_messages;
163 sub run_deferred_updates ($) {
166 my @upd_cmd = (@git, qw(update-ref --stdin -m), "debrebase: $mrest");
167 debugcmd '>|', @upd_cmd;
168 open U, "|-", @upd_cmd or die $!;
169 foreach (@deferred_updates) {
170 printdebug ">= ", $_, "\n";
171 print U $_, "\n" or die $!;
174 close U or failedcmd @upd_cmd;
176 print $_, "\n" foreach @deferred_update_messages;
178 @deferred_updates = ();
179 @deferred_update_messages = ();
182 sub get_differs ($$) {
184 # This resembles quiltify_trees_differ, in dgit, a bit.
185 # But we don't care about modes, or dpkg-source-unrepresentable
186 # changes, and we don't need the plethora of different modes.
187 # Conversely we need to distinguish different kinds of changes to
188 # debian/ and debian/patches/.
193 my ($opts, $limits, $fn) = @_;
194 my @cmd = (@git, qw(diff-tree -z --no-renames));
196 push @cmd, "$_:" foreach $x, $y;
197 push @cmd, '--', @$limits;
198 my $diffs = cmdoutput @cmd;
199 foreach (split /\0/, $diffs) { $fn->(); }
202 $rundiff->([qw(--name-only)], [], sub {
203 $differs |= $_ eq 'debian' ? DS_DEB : D_UPS;
206 if ($differs & DS_DEB) {
208 $rundiff->([qw(--name-only -r)], [qw(debian)], sub {
210 m{^debian/patches/} ? D_PAT_OTH :
211 $_ eq 'debian/changelog' ? D_DEB_CLOG :
214 die "mysterious debian changes $x..$y"
215 unless $differs & (D_PAT_OTH|DS_DEB);
218 if ($differs & D_PAT_OTH) {
220 $differs &= ~D_PAT_OTH;
222 $differs |= D_PAT_OTH;
223 no warnings qw(exiting); last;
225 $rundiff->([qw(--name-status -r)], [qw(debian/patches/)], sub {
226 no warnings qw(exiting);
227 if (!defined $mode) {
230 die unless s{^debian/patches/}{};
232 if ($mode eq 'A' && !m/\.series$/s) {
234 } elsif ($mode eq 'M' && $_ eq 'series') {
235 my $x_s = (git_cat_file "$x:debian/patches/series", 'blob');
236 my $y_s = (git_cat_file "$y:debian/patches/series", 'blob');
237 chomp $x_s; $x_s .= "\n";
238 $ok = $x_s eq substr($y_s, 0, length $x_s);
243 $differs |= $ok ? D_PAT_ADD : D_PAT_OTH;
245 die "mysterious debian/patches changes $x..$y"
246 unless $differs & (D_PAT_ADD|D_PAT_OTH);
249 printdebug sprintf "get_differs %s, %s = %#x\n", $x, $y, $differs;
254 sub commit_pr_info ($) {
256 return Data::Dumper->dump([$r], [qw(commit)]);
259 sub calculate_committer_authline () {
260 my $c = cmdoutput @git, qw(commit-tree --no-gpg-sign -m),
261 'DUMMY COMMIT (git-debrebase)', "HEAD:";
262 my ($h,$m) = get_commit $c;
263 $h =~ m/^committer .*$/m or confess "($h) ?";
267 sub rm_subdir_cached ($) {
269 runcmd @git, qw(rm --quiet -rf --cached --ignore-unmatch), $subdir;
272 sub read_tree_subdir ($$) {
273 my ($subdir, $new_tree_object) = @_;
274 rm_subdir_cached $subdir;
275 runcmd @git, qw(read-tree), "--prefix=$subdir/", $new_tree_object;
278 sub make_commit ($$) {
279 my ($parents, $message_paras) = @_;
280 my $tree = cmdoutput @git, qw(write-tree);
281 my @cmd = (@git, qw(commit-tree), $tree);
282 push @cmd, qw(-p), $_ foreach @$parents;
283 push @cmd, qw(-m), $_ foreach @$message_paras;
284 return cmdoutput @cmd;
287 our @fproblem_force_opts;
288 our $fproblems_forced;
289 our $fproblems_tripped;
292 if (grep { $_ eq $tag } @fproblem_force_opts) {
294 print STDERR "git-debrebase: safety catch overridden (-f$tag): $msg\n";
296 $fproblems_tripped++;
297 print STDERR "git-debrebase: safety catch tripped (-f$tag): $msg\n";
301 sub fproblems_maybe_bail () {
302 if ($fproblems_forced) {
304 "%s: safety catch trips: %d overriden by individual -f options\n",
305 $us, $fproblems_forced;
307 if ($fproblems_tripped) {
310 "%s: safety catch trips: %d overriden by global --force\n",
311 $us, $fproblems_tripped;
314 "%s: safety catch trips: %d blockers (you could -f<tag>, or --force)",
315 $us, $fproblems_tripped;
319 sub any_fproblems () {
320 return $fproblems_forced || $fproblems_tripped;
323 # classify returns an info hash like this
325 # Hdr => # commit headers, including 1 final newline
326 # Msg => # commit message (so one newline is dropped)
328 # Type => (see below)
330 # Ix => $index # ie 0, 1, 2, ...
332 # Differs => return value from get_differs
334 # IsDggitImport => 'orig' 'tarball' 'unpatched' 'package' (as from dgit)
336 # NewMsg => # commit message, but with any [dgit import ...] edited
337 # # to say "[was: ...]"
347 # has additional entres in classification result
348 # Overwritten = [ subset of Parents ]
349 # Contributor = $the_remaining_Parent
351 # DgitImportUnpatched
352 # has additional entry in classification result
353 # OrigParents = [ subset of Parents ]
356 # has additional entry in classification result
357 # OrigParents = [ subset of Parents ] # singleton list
362 # has additional entry in classification result
365 sub parsecommit ($;$) {
366 my ($objid, $p_ref) = @_;
367 # => hash with CommitId Hdr Msg Tree Parents
368 # Parents entries have only Ix CommitId
369 # $p_ref, if provided, must be [] and is used as a base for Parents
374 my ($h,$m) = get_commit $objid;
376 my ($t) = $h =~ m/^tree (\w+)$/m or die $objid;
377 my (@ph) = $h =~ m/^parent (\w+)$/mg;
387 foreach my $ph (@ph) {
389 Ix => scalar @$p_ref,
401 my $r = parsecommit($objid, \@p);
405 $p->{Differs} = (get_differs $p->{CommitId}, $t),
408 printdebug "classify $objid \$t=$t \@p",
409 (map { sprintf " %s/%#x", $_->{CommitId}, $_->{Differs} } @p),
413 my ($type, @rest) = @_;
414 $r = { %$r, Type => $type, @rest };
416 printdebug " = $type ".(dd $r)."\n";
422 $r = { %$r, Type => qw(Unknown), Why => $why };
423 printdebug " ** Unknown\n";
427 my @identical = grep { !$_->{Differs} } @p;
428 my ($stype, $series) = git_cat_file "$t:debian/patches/series";
429 my $haspatches = $stype ne 'missing' && $series =~ m/^\s*[^#\n\t ]/m;
431 if ($r->{Msg} =~ m{^\[git-debrebase anchor.*\]$}m) {
432 # multi-orig upstreams are represented with an anchor merge
433 # from a single upstream commit which combines the orig tarballs
435 my $badanchor = sub { $unknown->("git-debrebase \`anchor' but @_"); };
436 @p == 2 or return $badanchor->("has other than two parents");
437 $haspatches and return $badanchor->("contains debian/patches");
439 # How to decide about l/r ordering of anchors ? git
440 # --topo-order prefers to expand 2nd parent first. There's
441 # already an easy rune to look for debian/ history anyway (git log
442 # debian/) so debian breakwater branch should be 1st parent; that
443 # way also there's also an easy rune to look for the upstream
444 # patches (--topo-order).
446 $p[0]{IsOrigin} and $badanchor->("is an origin commit");
447 $p[1]{Differs} & ~DS_DEB and
448 $badanchor->("upstream files differ from left parent");
449 $p[0]{Differs} & ~D_UPS and
450 $badanchor->("debian/ differs from right parent");
452 return $classify->(qw(Anchor),
453 OrigParents => [ $p[1] ]);
457 my $d = $r->{Parents}[0]{Differs};
458 if ($d == D_PAT_ADD) {
459 return $classify->(qw(AddPatches));
460 } elsif ($d & (D_PAT_ADD|D_PAT_OTH)) {
461 return $unknown->("edits debian/patches");
462 } elsif ($d & DS_DEB and !($d & ~DS_DEB)) {
463 my ($ty,$dummy) = git_cat_file "$p[0]{CommitId}:debian";
465 if ($d == D_DEB_CLOG) {
466 return $classify->(qw(Changelog));
468 return $classify->(qw(Packaging));
470 } elsif ($ty eq 'missing') {
471 return $classify->(qw(BreakwaterStart));
473 return $unknown->("parent's debian is not a directory");
475 } elsif ($d == D_UPS) {
476 return $classify->(qw(Upstream));
477 } elsif ($d & DS_DEB and $d & D_UPS and !($d & ~(DS_DEB|D_UPS))) {
478 return $classify->(qw(Mixed));
480 return $unknown->("no changes");
482 confess "internal error $objid ?";
486 return $unknown->("origin commit");
489 if (@p == 2 && @identical == 1) {
490 my @overwritten = grep { $_->{Differs} } @p;
491 confess "internal error $objid ?" unless @overwritten==1;
492 return $classify->(qw(Pseudomerge),
493 Overwritten => [ $overwritten[0] ],
494 Contributor => $identical[0]);
496 if (@p == 2 && @identical == 2) {
498 my ($ph,$pm) = get_commit $_[0]{CommitId};
499 $ph =~ m/^committer .* (\d+) [-+]\d+$/m or die "$_->{CommitId} ?";
503 my $order = $get_t->($bytime[0]) <=> $get_t->($bytime[1]);
504 if ($order > 0) { # newer first
505 } elsif ($order < 0) {
506 @bytime = reverse @bytime;
508 # same age, default to order made by -s ours
509 # that is, commit was made by someone who preferred L
511 return $classify->(qw(Pseudomerge),
512 SubType => qw(Ambiguous),
513 Contributor => $bytime[0],
514 Overwritten => [ $bytime[1] ]);
517 my ($p_h, $p_m) = get_commit $p->{CommitId};
518 $p->{IsOrigin} = $p_h !~ m/^parent \w+$/m;
519 ($p->{IsDgitImport},) = $p_m =~ m/^\[dgit import ([0-9a-z]+) .*\]$/m;
521 my @orig_ps = grep { ($_->{IsDgitImport}//'X') eq 'orig' } @p;
523 if (!(grep { !$_->{IsOrigin} } @p) and
524 (@orig_ps >= @p - 1) and
525 $m2 =~ s{^\[(dgit import unpatched .*)\]$}{[was: $1]}m) {
527 return $classify->(qw(DgitImportUnpatched),
528 OrigParents => \@orig_ps);
531 return $unknown->("complex merge");
534 sub breakwater_of ($) {
535 my ($head) = @_; # must be laundered
539 fail "branch needs laundering (run git-debrebase): $why";
542 my $cl = classify $head;
543 my $ty = $cl->{Type};
544 if ($ty eq 'Packaging' or
545 $ty eq 'Changelog') {
546 $breakwater //= $head;
547 } elsif ($ty eq 'Anchor' or
548 $ty eq 'BreakwaterStart') {
549 $breakwater //= $head;
551 } elsif ($ty eq 'Upstream') {
552 $unclean->("packaging change ($breakwater)".
553 " follows upstream change (eg $head)")
554 if defined $breakwater;
555 } elsif ($ty eq 'Mixed') {
556 $unclean->('found mixed upstream/packaging commit ($head)');
557 } elsif ($ty eq 'Pseudomerge' or
558 $ty eq 'AddPatches') {
559 $unclean->("found interchange conversion commit ($ty, $head)");
560 } elsif ($ty eq 'DgitImportUnpatched') {
561 $unclean->("found dgit dsc import ($head)");
563 fail "found unprocessable commit, cannot cope: $head; $cl->{Why}";
565 $head = $cl->{Parents}[0]{CommitId};
573 $nogenerate,$report) = @_;
574 # => ($tip, $breakwater_tip, $last_anchor)
575 # (or nothing, if $nogenerate)
577 printdebug "*** WALK $input ".($nogenerate//0)." ".($report//'-')."\n";
579 # go through commits backwards
580 # we generate two lists of commits to apply:
581 # breakwater branch and upstream patches
582 my (@brw_cl, @upp_cl, @processed);
589 my ($prose, $info) = @_;
593 $ms .= "\n\n[git-debrebase$info: $prose]\n";
596 my $rewrite_from_here = sub {
598 my $sp_cl = { SpecialMethod => 'StartRewrite' };
600 push @processed, $sp_cl;
605 my $prprdelim = sub { print $report $prdelim if $report; $prdelim=""; };
608 return unless $report;
609 print $report $prdelim, @_;
613 my $bomb = sub { # usage: return $bomb->();
614 print $report " Unprocessable" if $report;
615 print $report " ($cl->{Why})" if $report && defined $cl->{Why};
618 return (undef,undef);
620 die "commit $cur: Cannot cope with this commit (d.".
621 (join ' ', map { sprintf "%#x", $_->{Differs} }
622 @{ $cl->{Parents} }).
623 (defined $cl->{Why} ? "; $cl->{Why}": '').
630 my $build_start = sub {
631 my ($msg, $parent) = @_;
634 no warnings qw(exiting); last;
641 my $ty = $cl->{Type};
642 my $st = $cl->{SubType};
643 $prline->("$cl->{CommitId} $cl->{Type}");
644 $found{$ty. ( defined($st) ? "-$st" : '' )}++;
645 push @processed, $cl;
646 my $p0 = @{ $cl->{Parents} }==1 ? $cl->{Parents}[0]{CommitId} : undef;
647 if ($ty eq 'AddPatches') {
649 $rewrite_from_here->(\@upp_cl);
651 } elsif ($ty eq 'Packaging' or $ty eq 'Changelog') {
655 } elsif ($ty eq 'BreakwaterStart') {
657 $build_start->('FirstPackaging', $cur);
658 } elsif ($ty eq 'Upstream') {
662 } elsif ($ty eq 'Mixed') {
665 my $cls = { %$cl, $xmsg->("split mixed commit: $wh part") };
668 $queue->(\@brw_cl, "debian");
669 $queue->(\@upp_cl, "upstream");
670 $rewrite_from_here->(\@brw_cl);
673 } elsif ($ty eq 'Pseudomerge') {
674 my $contrib = $cl->{Contributor}{CommitId};
675 print $report " Contributor=$contrib" if $report;
676 push @pseudomerges, $cl;
677 $rewrite_from_here->(\@upp_cl);
680 } elsif ($ty eq 'Anchor') {
682 $build_start->("Anchor", $cur);
683 } elsif ($ty eq 'DgitImportUnpatched') {
684 my $pm = $pseudomerges[-1];
686 # To an extent, this is heuristic. Imports don't have
687 # a useful history of the debian/ branch. We assume
688 # that the first pseudomerge after an import has a
689 # useful history of debian/, and ignore the histories
690 # from later pseudomerges. Often the first pseudomerge
691 # will be the dgit import of the upload to the actual
692 # suite intended by the non-dgit NMUer, and later
693 # pseudomerges may represent in-archive copies.
694 my $ovwrs = $pm->{Overwritten};
695 printf $report " PM=%s \@Overwr:%d",
696 $pm->{CommitId}, (scalar @$ovwrs)
699 printdebug "*** WALK BOMB DgitImportUnpatched\n";
702 my $ovwr = $ovwrs->[0]{CommitId};
703 printf $report " Overwr=%s", $ovwr if $report;
704 # This import has a tree which is just like a
705 # breakwater tree, but it has the wrong history. It
706 # ought to have the previous breakwater (which the
707 # pseudomerge overwrote) as an ancestor. That will
708 # make the history of the debian/ files correct. As
709 # for the upstream version: either it's the same as
710 # was ovewritten (ie, same as the previous
711 # breakwater), in which case that history is precisely
712 # right; or, otherwise, it was a non-gitish upload of a
713 # new upstream version. We can tell these apart by
714 # looking at the tree of the supposed upstream.
717 SpecialMethod => 'DgitImportDebianUpdate',
718 $xmsg->("convert dgit import: debian changes")
721 SpecialMethod => 'DgitImportUpstreamUpdate',
722 $xmsg->("convert dgit import: upstream update",
725 $prline->(" Import");
726 $rewrite_from_here->(\@brw_cl);
727 $upp_limit //= $#upp_cl; # further, deeper, patches discarded
731 # Everything is from this import. This kind of import
732 # is already in valid breakwater format, with the
733 # patches as commits.
734 printf $report " NoPM" if $report;
735 # last thing we processed will have been the first patch,
736 # if there is one; which is fine, so no need to rewrite
737 # on account of this import
738 $build_start->("ImportOrigin", $cur);
742 printdebug "*** WALK BOMB unrecognised\n";
748 printdebug "*** WALK prep done cur=$cur".
749 " brw $#brw_cl upp $#upp_cl proc $#processed pm $#pseudomerges\n";
751 return if $nogenerate;
753 # Now we build it back up again
759 my $read_tree_debian = sub {
761 read_tree_subdir 'debian', "$treeish:debian";
762 rm_subdir_cached 'debian/patches';
764 my $read_tree_upstream = sub {
766 runcmd @git, qw(read-tree), $treeish;
767 $read_tree_debian->($build);
770 $#upp_cl = $upp_limit if defined $upp_limit;
772 my $committer_authline = calculate_committer_authline();
774 printdebug "WALK REBUILD $build ".(scalar @processed)."\n";
776 confess "internal error" unless $build eq (pop @processed)->{CommitId};
779 mkdir $rd or $!==EEXIST or die $!;
781 runcmd @git, qw(read-tree), $build;
782 foreach my $cl (qw(Debian), (reverse @brw_cl),
783 { SpecialMethod => 'RecordBreakwaterTip' },
784 qw(Upstream), (reverse @upp_cl)) {
786 $current_method = $cl;
789 my $method = $cl->{SpecialMethod} // $current_method;
790 my @parents = ($build);
791 my $cltree = $cl->{CommitId};
792 printdebug "WALK BUILD ".($cltree//'undef').
793 " $method (rewriting=$rewriting)\n";
794 if ($method eq 'Debian') {
795 $read_tree_debian->($cltree);
796 } elsif ($method eq 'Upstream') {
797 $read_tree_upstream->($cltree);
798 } elsif ($method eq 'StartRewrite') {
801 } elsif ($method eq 'RecordBreakwaterTip') {
802 $breakwater = $build;
804 } elsif ($method eq 'DgitImportDebianUpdate') {
805 $read_tree_debian->($cltree);
806 } elsif ($method eq 'DgitImportUpstreamUpdate') {
807 confess unless $rewriting;
808 my $differs = (get_differs $build, $cltree);
809 next unless $differs & D_UPS;
810 $read_tree_upstream->($cltree);
811 push @parents, map { $_->{CommitId} } @{ $cl->{OrigParents} };
816 my $procd = (pop @processed) // 'UNDEF';
819 printdebug "WALK REWRITING NOW cl=$cl procd=$procd\n";
822 my $newtree = cmdoutput @git, qw(write-tree);
824 $ch =~ s{^tree .*}{tree $newtree}m or confess "$ch ?";
825 $ch =~ s{^parent .*\n}{}mg;
826 $ch =~ s{(?=^author)}{
827 join '', map { "parent $_\n" } @parents
828 }me or confess "$ch ?";
830 $ch =~ s{^committer .*$}{$committer_authline}m
833 my $cf = "$rd/m$rewriting";
834 open CD, ">", $cf or die $!;
835 print CD $ch, "\n", $cl->{Msg} or die $!;
837 my @cmd = (@git, qw(hash-object));
838 push @cmd, qw(-w) if $rewriting;
839 push @cmd, qw(-t commit), $cf;
840 my $newcommit = cmdoutput @cmd;
841 confess "$ch ?" unless $rewriting or $newcommit eq $cl->{CommitId};
843 if (grep { $method eq $_ } qw(DgitImportUpstreamUpdate)) {
849 my $final_check = get_differs $build, $input;
850 die sprintf "internal error %#x %s %s", $final_check, $build, $input
851 if $final_check & ~D_PAT_ADD;
853 my @r = ($build, $breakwater, $last_anchor);
854 printdebug "*** WALK RETURN @r\n";
859 git_check_unmodified();
860 return git_rev_parse qw(HEAD);
863 sub update_head ($$$) {
864 my ($old, $new, $mrest) = @_;
865 push @deferred_updates, "update HEAD $new $old";
866 run_deferred_updates $mrest;
869 sub update_head_checkout ($$$) {
870 my ($old, $new, $mrest) = @_;
871 update_head $old, $new, $mrest;
872 runcmd @git, qw(reset --hard);
875 sub update_head_postlaunder ($$$) {
876 my ($old, $tip, $reflogmsg) = @_;
877 return if $tip eq $old;
878 print "git-debrebase: laundered (head was $old)\n";
879 update_head $old, $tip, $reflogmsg;
880 # no tree changes except debian/patches
881 runcmd @git, qw(rm --quiet --ignore-unmatch -rf debian/patches);
884 sub cmd_launder_v0 () {
885 badusage "no arguments to launder-v0 allowed" if @ARGV;
886 my $old = get_head();
887 my ($tip,$breakwater,$last_anchor) = walk $old;
888 update_head_postlaunder $old, $tip, 'launder';
889 printf "# breakwater tip\n%s\n", $breakwater;
890 printf "# working tip\n%s\n", $tip;
891 printf "# last anchor\n%s\n", $last_anchor;
894 sub defaultcmd_rebase () {
895 my $old = get_head();
896 my ($status, $message) = record_ffq_prev_deferred();
897 if ($status eq 'deferred' || $status eq 'exists') {
899 fproblem $status, "could not record ffq-prev: $message";
900 fproblems_maybe_bail();
902 my ($tip,$breakwater) = walk $old;
903 update_head_postlaunder $old, $tip, 'launder for rebase';
904 runcmd @git, qw(rebase), @ARGV, $breakwater;
908 die if ($ARGV[0]//'') =~ m/^-/;
909 badusage "too many arguments to analyse" if @ARGV>1;
912 $old = git_rev_parse $old;
914 $old = git_rev_parse 'HEAD';
916 my ($dummy,$breakwater) = walk $old, 1,*STDOUT;
917 STDOUT->error and die $!;
920 sub ffq_prev_branchinfo () {
921 # => ('status', "message", [$current, $ffq_prev])
923 # branch message is undef
924 # weird-symref } no $current,
925 # notbranch } no $ffq_prev
926 my $current = git_get_symref();
927 return ('detached', 'detached HEAD') unless defined $current;
928 return ('weird-symref', 'HEAD symref is not to refs/')
929 unless $current =~ m{^refs/};
930 my $ffq_prev = "refs/$ffq_refprefix/$'";
931 printdebug "ffq_prev_branchinfo branch current $current\n";
932 return ('branch', undef, $current, $ffq_prev);
935 sub record_ffq_prev_deferred () {
936 # => ('status', "message")
938 # deferred message is undef
943 # if not ff from some branch we should be ff from, is an fproblem
944 # if "deferred", will have added something about that to
945 # @deferred_update_messages, and also maybe printed (already)
946 # some messages about ff checks
947 my ($status, $message, $current, $ffq_prev) = ffq_prev_branchinfo();
948 return ($status, $message) unless $status eq 'branch';
950 my $currentval = get_head();
952 my $exists = git_get_ref $ffq_prev;
953 return ('exists',"$ffq_prev already exists") if $exists;
955 return ('not-branch', 'HEAD symref is not to refs/heads/')
956 unless $current =~ m{^refs/heads/};
959 my @check_specs = split /\;/, (cfg "branch.$branch.ffq-ffrefs",1) // '*';
962 printdebug "ffq check_specs @check_specs\n";
965 my ($lrref, $desc) = @_;
966 printdebug "ffq might check $lrref ($desc)\n";
968 for my $chk (@check_specs) {
970 $invert = $glob =~ s{^[!^]}{};
971 last if fnmatch $glob, $lrref;
974 my $lrval = git_get_ref $lrref;
975 return unless defined $lrval;
977 if (is_fast_fwd $lrval, $currentval) {
978 print "OK, you are ahead of $lrref\n" or die $!;
979 $checked{$lrref} = 1;
980 } elsif (is_fast_fwd $currentval, $lrval) {
981 $checked{$lrref} = -1;
982 fproblem 'behind', "you are behind $lrref, divergence risk";
984 $checked{$lrref} = -1;
985 fproblem 'diverged', "you have diverged from $lrref";
989 my $merge = cfg "branch.$branch.merge",1;
990 if (defined $merge and $merge =~ m{^refs/heads/}) {
992 printdebug "ffq merge $rhs\n";
993 my $check_remote = sub {
994 my ($remote, $desc) = @_;
995 printdebug "ffq check_remote ".($remote//'undef')." $desc\n";
996 return unless defined $remote;
997 $check->("refs/remotes/$remote/$rhs", $desc);
999 $check_remote->((scalar cfg "branch.$branch.remote",1),
1000 'remote fetch/merge branch');
1001 $check_remote->((scalar cfg "branch.$branch.pushRemote",1) //
1002 (scalar cfg "branch.$branch.pushDefault",1),
1003 'remote push branch');
1005 if ($branch =~ m{^dgit/}) {
1006 $check->("refs/remotes/dgit/$branch", 'remote dgit branch');
1007 } elsif ($branch =~ m{^master$}) {
1008 $check->("refs/remotes/dgit/dgit/sid", 'remote dgit branch for sid');
1011 fproblems_maybe_bail();
1013 push @deferred_updates, "update $ffq_prev $currentval $git_null_obj";
1014 push @deferred_update_messages, "Recorded current head for preservation";
1015 return ('deferred', undef);
1018 sub cmd_new_upstream_v0 () {
1019 # automatically and unconditionally launders before rebasing
1020 # if rebase --abort is used, laundering has still been done
1024 badusage "need NEW-VERSION UPS-COMMITTISH" unless @ARGV >= 2;
1026 # parse args - low commitment
1027 my $new_version = (new Dpkg::Version scalar(shift @ARGV), check => 1);
1028 my $new_upstream_version = $new_version->version();
1030 my $new_upstream = git_rev_parse shift @ARGV;
1033 my ($n, @x) = @_; # may be ''
1034 my $pc = $pieces{$n} //= {
1036 Desc => ($n ? "upstream piece \`$n'" : "upstream (main piece"),
1038 while (my $k = shift @x) { $pc->{$k} = shift @x; }
1043 my $newpiece = sub {
1044 my ($n, @x) = @_; # may be ''
1045 my $pc = $piece->($n, @x, NewIx => (scalar @newpieces));
1046 push @newpieces, $pc;
1051 New => $new_upstream,
1053 while (@ARGV && $ARGV[0] !~ m{^-}) {
1054 my $n = shift @ARGV;
1056 badusage "for each EXTRA-UPS-NAME need EXTRA-UPS-COMMITISH"
1057 unless @ARGV && $ARGV[0] !~ m{^-};
1059 my $c = git_rev_parse shift @ARGV;
1060 die unless $n =~ m/^$extra_orig_namepart_re$/;
1061 $newpiece->($n, New => $c);
1064 # now we need to investigate the branch this generates the
1065 # laundered version but we don't switch to it yet
1066 my $old_head = get_head();
1067 my ($old_laundered_tip,$old_bw,$old_upstream_update) = walk $old_head;
1069 my $old_bw_cl = classify $old_bw;
1070 my $old_upstream_update_cl = classify $old_upstream_update;
1071 confess unless $old_upstream_update_cl->{OrigParents};
1072 my $old_upstream = parsecommit
1073 $old_upstream_update_cl->{OrigParents}[0]{CommitId};
1075 $piece->('', Old => $old_upstream->{CommitId});
1077 if ($old_upstream->{Msg} =~ m{^\[git-debrebase }m) {
1078 if ($old_upstream->{Msg} =~
1079 m{^\[git-debrebase upstream-combine \.((?: $extra_orig_namepart_re)+)\:.*\]$}m
1081 my @oldpieces = ('', split / /, $1);
1082 my $parentix = -1 + scalar @{ $old_upstream->{Parents} };
1083 foreach my $i (0..$#oldpieces) {
1084 my $n = $oldpieces[$i];
1085 $piece->($n, Old => $old_upstream->{CommitId}.'^'.$parentix);
1088 fproblem 'upstream-confusing',
1089 "previous upstream $old_upstream->{CommitId} is from".
1090 " git-debrebase but not an \`upstream-combine' commit";
1094 foreach my $pc (values %pieces) {
1096 fproblem 'upstream-new-piece',
1097 "introducing upstream piece \`$pc->{Name}'";
1098 } elsif (!$pc->{New}) {
1099 fproblem 'upstream-rm-piece',
1100 "dropping upstream piece \`$pc->{Name}'";
1101 } elsif (!is_fast_fwd $pc->{Old}, $pc->{New}) {
1102 fproblem 'upstream-not-ff',
1103 "not fast forward: $pc->{Name} $pc->{Old}..$pc->{New}";
1107 printdebug "%pieces = ", (dd \%pieces), "\n";
1108 printdebug "\@newpieces = ", (dd \@newpieces), "\n";
1110 fproblems_maybe_bail();
1116 my @upstream_merge_parents;
1118 if (!any_fproblems()) {
1119 push @upstream_merge_parents, $old_upstream->{CommitId};
1122 foreach my $pc (@newpieces) { # always has '' first
1124 read_tree_subdir $pc->{Name}, $pc->{New};
1126 runcmd @git, qw(read-tree), $pc->{New};
1128 push @upstream_merge_parents, $pc->{New};
1131 # index now contains the new upstream
1133 if (@newpieces > 1) {
1134 # need to make the upstream subtree merge commit
1135 $new_upstream = make_commit \@upstream_merge_parents,
1136 [ "Combine upstreams for $new_upstream_version",
1137 ("[git-debrebase upstream-combine . ".
1138 (join " ", map { $_->{Name} } @newpieces[1..$#newpieces]).
1143 # $new_upstream is either the single upstream commit, or the
1144 # combined commit we just made. Either way it will be the
1145 # "upstream" parent of the anchor merge.
1147 read_tree_subdir 'debian', "$old_bw:debian";
1149 # index now contains the anchor merge contents
1150 $new_bw = make_commit [ $old_bw, $new_upstream ],
1151 [ "Update to upstream $new_upstream_version",
1152 "[git-debrebase anchor: new upstream $new_upstream_version, merge]",
1155 # Now we have to add a changelog stanza so the Debian version
1157 die if unlink "debian";
1158 die $! unless $!==ENOENT or $!==ENOTEMPTY;
1159 unlink "debian/changelog" or $!==ENOENT or die $!;
1160 mkdir "debian" or die $!;
1161 open CN, ">", "debian/changelog" or die $!;
1162 my $oldclog = git_cat_file ":debian/changelog";
1163 $oldclog =~ m/^($package_re) \(\S+\) / or
1164 fail "cannot parse old changelog to get package name";
1166 print CN <<END, $oldclog or die $!;
1167 $p ($new_version) UNRELEASED; urgency=medium
1169 * Update to new upstream version $new_upstream_version.
1175 runcmd @git, qw(update-index --add --replace), 'debian/changelog';
1177 # Now we have the final new breakwater branch in the index
1178 $new_bw = make_commit [ $new_bw ],
1179 [ "Update changelog for new upstream $new_upstream_version",
1180 "[git-debrebase: new upstream $new_upstream_version, changelog]",
1184 # we have constructed the new breakwater. we now need to commit to
1185 # the laundering output, because git-rebase can't easily be made
1186 # to make a replay list which is based on some other branch
1188 update_head_postlaunder $old_head, $old_laundered_tip,
1189 'launder for new upstream';
1191 my @cmd = (@git, qw(rebase --onto), $new_bw, $old_bw, @ARGV);
1193 # now it's for the user to sort out
1196 sub cmd_record_ffq_prev () {
1197 badusage "no arguments allowed" if @ARGV;
1198 my ($status, $msg) = record_ffq_prev_deferred();
1199 if ($status eq 'exists' && $opt_noop_ok) {
1200 print "Previous head already recorded\n" or die $!;
1201 } elsif ($status eq 'deferred') {
1202 run_deferred_updates 'record-ffq-prev';
1204 fail "Could not preserve: $msg";
1208 sub cmd_breakwater () {
1209 badusage "no arguments allowed" if @ARGV;
1210 my $bw = breakwater_of git_rev_parse 'HEAD';
1211 print "$bw\n" or die $!;
1216 GetOptions('prose=s', \$prose) or die badusage("bad options to stitch");
1217 badusage "no arguments allowed" if @ARGV;
1218 my ($status, $message, $current, $ffq_prev) = ffq_prev_branchinfo();
1219 if ($status ne 'branch') {
1220 fproblem $status, "could not check ffq-prev: $message";
1221 fproblems_maybe_bail();
1223 my $prev = $ffq_prev && git_get_ref $ffq_prev;
1225 fail "No ffq-prev to stitch." unless $opt_noop_ok;
1227 push @deferred_updates, "delete $ffq_prev $prev";
1229 my $old_head = get_head();
1230 if (is_fast_fwd $old_head, $prev) {
1231 my $differs = get_differs $old_head, $prev;
1232 unless ($differs & ~D_PAT_ADD) {
1233 # ffq-prev is ahead of us, and the only tree changes it has
1234 # are possibly addition of things in debian/patches/.
1235 # Just wind forwards rather than making a pointless pseudomerge.
1236 update_head_checkout $old_head, $prev, "stitch (fast forward)";
1241 my $new_head = make_commit [ $old_head, $ffq_prev ], [
1242 'Declare fast forward / record previous work',
1243 "[git-debrebase pseudomerge: stitch$prose]",
1245 update_head $old_head, $new_head, "stitch";
1248 sub cmd_convert_from_gbp () {
1249 badusage "needs 1 optional argument, the upstream git rev"
1251 my ($upstream_spec) = @ARGV;
1252 $upstream_spec //= 'refs/heads/upstream';
1253 my $upstream = git_rev_parse $upstream_spec;
1254 my $old_head = get_head();
1256 my $upsdiff = get_differs $upstream, $old_head;
1257 if ($upsdiff & D_UPS) {
1258 runcmd @git, qw(--no-pager diff),
1259 $upstream, $old_head,
1260 qw( -- :!/debian :/);
1261 fail "upstream ($upstream_spec) and HEAD are not identical in upstream files";
1264 if (!is_fast_fwd $upstream, $old_head) {
1265 fproblem 'upstream-not-ancestor',
1266 "upstream ($upstream) is not an ancestor of HEAD";
1268 my $wrong = cmdoutput
1269 (@git, qw(rev-list --ancestry-path), "$upstream..HEAD",
1270 qw(-- :/ :!/debian));
1271 if (length $wrong) {
1272 fproblem 'unexpected-upstream-changes',
1273 "history between upstream ($upstream) and HEAD contains direct changes to upstream files - are you sure this is a gbp (patches-unapplied) branch?";
1274 print STDERR "list expected changes with: git log --stat --ancestry-path $upstream_spec..HEAD -- :/ ':!/debian'\n";
1278 if ((git_cat_file "$upstream:debian")[0] ne 'missing') {
1279 fproblem 'upstream-has-debian',
1280 "upstream ($upstream) contains debian/ directory";
1283 fproblems_maybe_bail();
1289 runcmd @git, qw(checkout -q -b gdr-internal), $old_head;
1290 # make a branch out of the patch queue - we'll want this in a mo
1291 runcmd qw(gbp pq import);
1292 # strip the patches out
1293 runcmd @git, qw(checkout -q gdr-internal~0);
1294 rm_subdir_cached 'debian/patches';
1295 $work = make_commit ['HEAD'], [
1296 'git-debrebase convert-from-gbp: drop patches from tree',
1297 'Delete debian/patches, as part of converting to git-debrebase format.',
1298 '[git-debrebase convert-from-gbp: drop patches from tree]'
1300 # make the anchor merge
1301 # the tree is already exactly right
1302 $work = make_commit [$work, $upstream], [
1303 'git-debrebase import: declare upstream',
1304 'First breakwater merge.',
1305 '[git-debrebase anchor: declare upstream]'
1308 # rebase the patch queue onto the new breakwater
1309 runcmd @git, qw(reset --quiet --hard patch-queue/gdr-internal);
1310 runcmd @git, qw(rebase --quiet --onto), $work, qw(gdr-internal);
1311 $work = git_rev_parse 'HEAD';
1314 update_head_checkout $old_head, $work, 'convert-from-gbp';
1317 sub cmd_convert_to_gbp () {
1318 badusage "no arguments allowed" if @ARGV;
1319 my $head = get_head();
1320 my $ffq = (ffq_prev_branchinfo())[3];
1321 my $bw = breakwater_of $head;
1325 runcmd @git, qw(checkout -q -b bw), $bw;
1326 runcmd @git, qw(checkout -q -b patch-queue/bw), $head;
1327 runcmd qw(gbp pq export);
1328 runcmd @git, qw(add debian/patches);
1329 $out = make_commit ['HEAD'], [
1330 'Commit patch queue (converted from git-debrebase format)',
1331 '[git-debrebase convert-to-gbp: commit patches]',
1335 runcmd @git, qw(update-ref -m),
1336 "debrebase: converting corresponding main branch to gbp format",
1337 $ffq, $git_null_obj;
1339 update_head_checkout $head, $out, "convert to gbp (v0)";
1340 print <<END or die $!;
1341 git-debrebase: converted to git-buildpackage branch format
1342 git-debrebase: WARNING: do not now run "git-debrebase" any more
1343 git-debrebase: WARNING: doing so would drop all upstream patches!
1347 sub cmd_downstream_rebase_launder_v0 () {
1348 badusage "needs 1 argument, the baseline" unless @ARGV==1;
1350 $base = git_rev_parse $base;
1351 my $old_head = get_head();
1352 my $current = $old_head;
1355 if ($current eq $base) {
1356 $topmost_keep //= $current;
1357 print " $current BASE stop\n";
1360 my $cl = classify $current;
1361 print " $current $cl->{Type}";
1363 my $p0 = $cl->{Parents}[0]{CommitId};
1365 if ($cl->{Type} eq 'Pseudomerge') {
1366 print " ^".($cl->{Contributor}{Ix}+1);
1367 $next = $cl->{Contributor}{CommitId};
1368 } elsif ($cl->{Type} eq 'AddPatches' or
1369 $cl->{Type} eq 'Changelog') {
1379 $topmost_keep //= $current;
1381 die "to-be stripped changes not on top of the branch\n"
1386 if ($topmost_keep eq $old_head) {
1387 print "unchanged\n";
1389 print "updating to $topmost_keep\n";
1390 update_head_checkout
1391 $old_head, $topmost_keep,
1392 'downstream-rebase-launder-v0';
1396 GetOptions("D+" => \$debuglevel,
1397 'noop-ok', => \$opt_noop_ok,
1398 'f=s' => \@fproblem_force_opts,
1399 'force!') or die badusage "bad options\n";
1400 initdebug('git-debrebase ');
1401 enabledebug if $debuglevel;
1403 my $toplevel = cmdoutput @git, qw(rev-parse --show-toplevel);
1404 chdir $toplevel or die "chdir $toplevel: $!";
1406 $rd = fresh_playground "$playprefix/misc";
1408 if (!@ARGV || $ARGV[0] =~ m{^-}) {
1409 defaultcmd_rebase();
1411 my $cmd = shift @ARGV;
1414 $cmdfn = ${*::}{"cmd_$cmdfn"};
1416 $cmdfn or badusage "unknown git-debrebase sub-operation $cmd";