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/>.
21 END { $? = $Debian::Dgit::ExitStatus::desired // -1; };
22 use Debian::Dgit::GDR;
23 use Debian::Dgit::ExitStatus;
27 use Debian::Dgit qw(:DEFAULT :playground);
34 use Getopt::Long qw(:config posix_default gnu_compat bundling);
36 use File::FnMatch qw(:fnmatch);
39 $debugcmd_when_debuglevel = 2;
41 our ($usage_message) = <<'END';
43 git-debrebase [<options>] [--|-i <git rebase options...>]
44 git-debrebase [<options>] status
45 git-debrebase [<options>] prepush [--prose=...]
46 git-debrebase [<options>] quick|conclude
47 git-debrebase [<options>] new-upstream <new-version> [<details ...>]
48 git-debrebase [<options>] convert-from-gbp [<upstream-commitish>]
50 See git-debrebase(1), git-debrebase(5), dgit-maint-debrebase(7) (in dgit).
53 our ($opt_force, $opt_careful, $opt_noop_ok, @opt_anchors);
54 our ($opt_defaultcmd_interactive);
58 our $us = qw(git-debrebase);
60 our $wrecknoteprefix = 'refs/debrebase/wreckage';
61 our $merge_cache_ref = 'refs/debrebase/merge-resolutions';
67 print STDERR "$us: bad usage: $m\n";
73 local $SIG{__WARN__}; # GetOptions calls `warn' to print messages
74 GetOptions @_ or badusage $m;
78 getoptions_main "bad options follow \`git-debrebase $sc'", @_;
82 my ($k, $optional) = @_;
84 my @cmd = qw(git config -z);
85 push @cmd, qw(--get-all) if wantarray;
87 my $out = cmdoutput_errok @cmd;
89 fail "missing required git config $k" unless $optional;
92 my @l = split /\0/, $out;
93 return wantarray ? @l : $l[0];
100 my $dd = new Data::Dumper [ $v ];
101 Terse $dd 1; Indent $dd 0; Useqq $dd 1;
107 my $data = (git_cat_file $objid, 'commit');
108 $data =~ m/(?<=\n)\n/ or die "$objid ($data) ?";
112 sub D_UPS () { 0x02; } # upstream files
113 sub D_PAT_ADD () { 0x04; } # debian/patches/ extra patches at end
114 sub D_PAT_OTH () { 0x08; } # debian/patches other changes
115 sub D_DEB_CLOG () { 0x10; } # debian/changelog
116 sub D_DEB_OTH () { 0x20; } # debian/ (not patches/ or changelog)
117 sub DS_DEB () { D_DEB_CLOG | D_DEB_OTH; } # debian/ (not patches/)
119 our $playprefix = 'debrebase';
124 our @dgit = qw(dgit);
126 sub in_workarea ($) {
129 my $r = eval { $sub->(); };
130 { local $@; changedir $maindir; }
134 sub fresh_workarea (;$) {
137 $workarea = fresh_playground "$playprefix/$subdir";
138 in_workarea sub { playtree_setup };
141 sub run_ref_updates_now ($$) {
142 my ($mrest, $updates) = @_;
143 # @$updates is a list of lines for git-update-ref, without \ns
145 my @upd_cmd = (git_update_ref_cmd "debrebase: $mrest", qw(--stdin));
146 debugcmd '>|', @upd_cmd;
147 open U, "|-", @upd_cmd or die $!;
148 foreach (@$updates) {
149 printdebug ">= ", $_, "\n";
150 print U $_, "\n" or die $!;
153 close U or failedcmd @upd_cmd;
156 our $snags_forced = 0;
157 our $snags_tripped = 0;
158 our $snags_summarised = 0;
159 our @deferred_updates;
160 our @deferred_update_messages;
162 sub merge_wreckage_cleaning ($) {
164 git_for_each_ref("$wrecknoteprefix/*", sub {
165 my ($objid,$objtype,$fullrefname,$reftail) = @_;
166 push @$updates, "delete $fullrefname";
170 sub all_snags_summarised () {
171 $snags_forced + $snags_tripped == $snags_summarised;
173 sub run_deferred_updates ($) {
176 confess 'dangerous internal error' unless all_snags_summarised();
178 merge_wreckage_cleaning \@deferred_updates;
179 run_ref_updates_now $mrest, \@deferred_updates;
180 print $_, "\n" foreach @deferred_update_messages;
182 @deferred_updates = ();
183 @deferred_update_messages = ();
186 sub get_tree ($;$$) {
187 # tree object name => ([ $name, $info ], ...)
188 # where $name is the sort key, ie has / at end for subtrees
189 # $info is the LHS from git-ls-tree (<mode> <type> <hash>)
190 # without $precheck, will crash if $x does not exist, so don't do that;
191 # instead pass '' to get ().
192 my ($x, $precheck, $recurse) = @_;
194 return () if !length $x;
197 my ($type, $dummy) = git_cat_file $x, [qw(tree missing)];
198 return () if $type eq 'missing';
201 our (@get_tree_memo, %get_tree_memo);
202 my $memo = $get_tree_memo{$x};
203 return @$memo if $memo;
205 local $Debian::Dgit::debugcmd_when_debuglevel = 3;
207 my @cmd = (qw(git ls-tree -z --full-tree));
208 push @cmd, qw(-r) if $recurse;
209 push @cmd, qw(--), $x;
210 my $o = cmdoutput @cmd;
213 foreach my $l (split /\0/, $o) {
214 my ($i, $n) = split /\t/, $l, 2;
215 $n .= '/' if $i =~ m/^\d+ tree /;
217 confess "$x need $last < $n ?" unless $last lt $n;
219 $get_tree_memo{$x} = \@l;
220 push @get_tree_memo, $x;
221 if (@get_tree_memo > 10) {
222 delete $get_tree_memo{ shift @get_tree_memo };
227 sub trees_diff_walk ($$$;$) {
228 # trees_diff_walk [$all,] $x, $y, sub {... }
229 # calls sub->($name, $ix, $iy) for each difference (with $all, each name)
230 # $x and $y are as for get_tree
231 # where $name, $ix, $iy are $name and $info from get_tree
232 my $all = shift @_ if @_>=4;
233 my ($x,$y,$call) = @_;
234 return if !$all and $x eq $y;
237 printdebug "trees_diff_walk(..$x,$y..) ".Dumper(\@x,\@y)
240 my $cmp = !@x <=> !@y # eg @y empty? $cmp=-1, use x
241 || $x[0][0] cmp $y[0][0]; # eg, x lt y ? $cmp=-1, use x
242 my ($n, $ix, $iy); # all same? $cmp=0, use both
244 printdebug "trees_diff_walk $cmp : @{ $x[0]//[] } | @{ $y[0]//[] }\n"
246 ($n, $ix) = @{ shift @x } if $cmp <= 0;
247 ($n, $iy) = @{ shift @y } if $cmp >= 0;
248 next if !$all and $ix eq $iy;
250 "trees_diff_walk(%d,'%s','%s') call('%s','%s','%s')\n",
251 !!$all,$x,$y, $n,$ix,$iy
253 $call->($n, $ix, $iy);
257 sub get_differs ($$) {
259 # This does a similar job to quiltify_trees_differ, in dgit, a bit.
260 # But we don't care about modes, or dpkg-source-unrepresentable
261 # changes, and we don't need the plethora of different modes.
262 # Conversely we need to distinguish different kinds of changes to
263 # debian/ and debian/patches/.
264 # Also, here we have, and want to use, trees_diff_walk, because
265 # we may be calling this an awful lot and we want it to be fast.
270 no warnings qw(exiting);
272 my $plain = sub { $_[0] =~ m{^(100|0*)644 blob }s; };
274 trees_diff_walk "$x:", "$y:", sub {
275 my ($n,$ix,$iy) = @_;
277 # analyse difference at the toplevel
279 if ($n ne 'debian/') {
283 if ($n eq 'debian') {
284 # one side has a non-tree for ./debian !
285 $differs |= D_DEB_OTH;
289 my $xd = $ix && "$x:debian";
290 my $yd = $iy && "$y:debian";
291 trees_diff_walk $xd, $yd, sub {
292 my ($n,$ix,$iy) = @_;
294 # analyse difference in debian/
296 if ($n eq 'changelog' && (!$ix || $plain->($ix))
298 $differs |= D_DEB_CLOG;
301 if ($n ne 'patches/') {
302 $differs |= D_DEB_OTH;
306 my $xp = $ix && "$xd/patches";
307 my $yp = $iy && "$yd/patches";
308 trees_diff_walk $xp, $yp, sub {
309 my ($n,$ix,$iy) = @_;
311 # analyse difference in debian/patches
314 if ($n !~ m/\.series$/s && !$ix && $plain->($iy)) {
316 } elsif ($n eq 'series' && $plain->($ix) && $plain->($iy)) {
317 my $x_s = (git_cat_file "$xp/series", 'blob');
318 my $y_s = (git_cat_file "$yp/series", 'blob');
319 chomp $x_s; $x_s .= "\n";
320 $ok = $x_s eq substr($y_s, 0, length $x_s);
324 $differs |= $ok ? D_PAT_ADD : D_PAT_OTH;
329 printdebug sprintf "get_differs %s %s = %#x\n", $x, $y, $differs;
334 sub commit_pr_info ($) {
336 return Data::Dumper->dump([$r], [qw(commit)]);
339 sub calculate_committer_authline () {
340 my $c = cmdoutput @git, qw(commit-tree --no-gpg-sign -m),
341 'DUMMY COMMIT (git-debrebase)', "HEAD:";
342 my ($h,$m) = get_commit $c;
343 $h =~ m/^committer .*$/m or confess "($h) ?";
347 sub rm_subdir_cached ($) {
349 runcmd @git, qw(rm --quiet -rf --cached --ignore-unmatch), $subdir;
352 sub read_tree_subdir ($$) {
353 my ($subdir, $new_tree_object) = @_;
354 rm_subdir_cached $subdir;
355 runcmd @git, qw(read-tree), "--prefix=$subdir/", $new_tree_object;
358 sub read_tree_debian ($) {
360 read_tree_subdir 'debian', "$treeish:debian";
361 rm_subdir_cached 'debian/patches';
364 sub read_tree_upstream ($;$$) {
365 my ($treeish, $keep_patches, $tree_with_debian) = @_;
366 # if $tree_with_debian is supplied, will use that for debian/
367 # otherwise will save and restore it.
369 $tree_with_debian ? "$tree_with_debian:debian"
370 : cmdoutput @git, qw(write-tree --prefix=debian/);
371 runcmd @git, qw(read-tree), $treeish;
372 read_tree_subdir 'debian', $debian;
373 rm_subdir_cached 'debian/patches' unless $keep_patches;
376 sub make_commit ($$) {
377 my ($parents, $message_paras) = @_;
378 my $tree = cmdoutput @git, qw(write-tree);
379 my @cmd = (@git, qw(commit-tree), $tree);
380 push @cmd, qw(-p), $_ foreach @$parents;
381 push @cmd, qw(-m), $_ foreach @$message_paras;
382 return cmdoutput @cmd;
385 our @snag_force_opts;
387 my ($tag,$msg) = @_; # ignores extra args, for benefit of keycommits
388 if (grep { $_ eq $tag } @snag_force_opts) {
390 print STDERR "git-debrebase: snag ignored (-f$tag): $msg\n";
393 print STDERR "git-debrebase: snag detected (-f$tag): $msg\n";
397 # Important: all mainline code must call snags_maybe_bail after
398 # any point where snag might be called, but before making changes
399 # (eg before any call to run_deferred_updates). snags_maybe_bail
400 # may be called more than once if necessary (but this is not ideal
401 # because then the messages about number of snags may be confusing).
402 sub snags_maybe_bail () {
403 return if all_snags_summarised();
406 "%s: snags: %d overriden by individual -f options\n",
409 if ($snags_tripped) {
412 "%s: snags: %d overriden by global --force\n",
416 "%s: snags: %d blocker(s) (you could -f<tag>, or --force)",
420 $snags_summarised = $snags_forced + $snags_tripped;
422 sub snags_maybe_bail_early () {
423 # useful to bail out early without doing a lot of work;
424 # not a substitute for snags_maybe_bail.
425 snags_maybe_bail() if $snags_tripped && !$opt_force;
428 return $snags_forced || $snags_tripped;
431 sub gbp_pq_export ($$$) {
432 my ($bname, $base, $tip) = @_;
433 # must be run in a workarea. $bname and patch-queue/$bname
434 # ought not to exist. Leaves you on patch-queue/$bname with
435 # the patches staged but not committed.
436 printdebug "gbp_pq_export $bname $base $tip\n";
437 runcmd @git, qw(checkout -q -b), $bname, $base;
438 runcmd @git, qw(checkout -q -b), "patch-queue/$bname", $tip;
439 my @gbp_cmd = (qw(gbp pq export));
440 my $r = system shell_cmd 'exec >../gbp-pq-err 2>&1', @gbp_cmd;
442 { local ($!,$?); copy('../gbp-pq-err', \*STDERR); }
445 runcmd @git, qw(add -f debian/patches) if stat_exists 'debian/patches';
449 # xxx allow merge resolution separately from laundering, before git merge
451 # xxx general gdr docs highlight forbidden things
452 # xxx general gdr docs list allowable things ?
453 # xxx general gdr docs explicitly forbid some rebase
456 # use git-format-patch?
457 # our own patch identification algorithm?
458 # this is an alternative strategy
460 sub merge_failed ($$;@) {
461 my ($wrecknotes, $emsg, @xmsgs) = @_;
463 push @m, "Merge resolution failed: $emsg";
469 merge_wreckage_cleaning \@updates;
470 run_ref_updates_now "merge failed", \@updates;
474 while (my ($k,$v) = each %$wrecknotes) {
475 push @updates, "create $wrecknoteprefix/$k $v";
477 run_ref_updates_now "merge failed", \@updates;
478 push @m, "Wreckage left in $wrecknoteprefix/*.";
480 push @m, "See git-debrebase(1) section FAILED MERGES for suggestions.";
482 # use finish rather than fail, in case we are within an eval
483 # (that can happen inside walk!)
485 print STDERR "$us: $_\n" foreach @m;
489 sub mwrecknote ($$$) {
490 my ($wrecknotes, $reftail, $commitish) = @_;
491 confess unless defined $commitish;
492 printdebug "mwrecknote $reftail $commitish\n";
493 $wrecknotes->{$reftail} = $commitish;
496 sub merge_attempt_cmd {
497 my $wrecknotes = shift @_;
501 merge_failed $wrecknotes,
502 failedcmd_waitstatus(),
503 "failed command: @_";
507 sub merge_series_patchqueue_convert ($$$);
509 sub merge_series ($$$;@) {
510 my ($newbase, $wrecknotes, $base_q, @input_qs) = @_;
511 # $base_q{SeriesBase} $input_qs[]{SeriesBase}
512 # $base_q{SeriesTip} $input_qs[]{SeriesTip}
513 # ^ specifies several patch series (currently we only support exactly 2)
514 # return value is a commit which is the result of
515 # merging the two versions of the same topic branch
516 # $input_q[0] and $input_q[1]
517 # with respect to the old version
521 # Creates, in *_q, a key MR for its private use
523 printdebug "merge_series newbase=$newbase\n";
525 $input_qs[$_]{MR}{S} = $_ foreach (0..$#input_qs);
526 $base_q->{MR}{S} = 'base';
529 # $prereq{<patch filename>}{<possible prereq}{<S>} = 1 or absent
530 # $prereq{<patch filename>}{<possible prereq} exists or not (later)
531 # $prereq{<patch filename>} exists or not (even later)
535 my $mwrecknote = sub { &mwrecknote($wrecknotes, @_); };
537 my $attempt_cmd = sub { &merge_attempt_cmd($wrecknotes, @_); };
540 fresh_workarea "merge";
541 my $seriesfile = "debian/patches/series";
544 foreach my $q ($base_q, reverse @input_qs) {
546 gbp_pq_export "p-$s", $q->{SeriesBase}, $q->{SeriesTip};
548 if (open S, $seriesfile) {
549 while (my $patch = <S>) {
550 chomp $patch or die $!;
551 $prereq{$patch} //= {};
552 foreach my $earlier (@earlier) {
553 $prereq{$patch}{$earlier}{$s}++ and die;
555 push @earlier, $patch;
556 stat "debian/patches/$patch" or die "$patch ?";
558 S->error and die "$seriesfile $!";
561 die "$seriesfile $!" unless $!==ENOENT;
563 read_tree_upstream $newbase, 1;
564 my $pec = make_commit [ grep { defined } $base_q->{MR}{PEC} ], [
565 "Convert $s to patch queue for merging",
566 "[git-debrebase merge-innards patch-queue import:".
569 printdebug "merge_series pec $pec ";
570 runcmd @git, qw(rm -q --ignore-unmatch --cached), $seriesfile;
571 $pec = make_commit [ $pec ], [
572 "Drop series file from $s to avoid merge trouble",
573 "[git-debrebase merge-innards patch-queue prep:".
577 read_tree_debian $newbase;
579 read_tree_subdir 'debian/patches', "$pec:debian/patches";
581 rm_subdir_cached 'debian/patches';
583 $pec = make_commit [ $pec ], [
584 "Update debian/ (excluding patches) to final to avoid re-merging",
585 "debian/ was already merged and we need to just take that.",
586 "[git-debrebase merge-innards patch-queue packaging:".
590 printdebug "pec' $pec\n";
591 runcmd @git, qw(reset -q --hard), $pec;
592 $q->{MR}{PEC} = $pec;
593 $mwrecknote->("$q->{LeftRight}-patchqueue", $pec);
595 # now, because of reverse, we are on $input_q->{MR}{OQC}
596 runcmd @git, qw(checkout -q -b merge);
597 printdebug "merge_series merging...\n";
598 my @mergecmd = (@git, qw(merge --quiet --no-edit), "p-1");
600 $attempt_cmd->(@mergecmd);
602 printdebug "merge_series merge ok, series...\n";
603 # We need to construct a new series file
604 # Firstly, resolve prereq
605 foreach my $f (sort keys %prereq) {
606 printdebug "merge_series patch\t$f\t";
607 if (!stat_exists "debian/patches/$f") {
608 print DEBUG " drop\n" if $debuglevel;
609 # git merge deleted it; that's how we tell it's not wanted
613 print DEBUG " keep\n" if $debuglevel;
614 foreach my $g (sort keys %{ $prereq{$f} }) {
615 my $gfp = $prereq{$f}{$g};
616 printdebug "merge_series prereq\t$f\t-> $g\t";
617 if (!!$gfp->{0} == !!$gfp->{1}
620 print DEBUG "\tkeep\n" if $debuglevel;
622 print DEBUG "\tdrop\n" if $debuglevel;
623 delete $prereq{$f}{$g};
630 return scalar keys %{ $prereq{$f} };
633 my $nodate = time + 1;
635 # $authordate{<patch filename>};
636 my $authordate = sub {
638 $authordate{$f} //= do {
639 open PF, "<", "debian/patches/$f" or die "$f $!";
641 return $nodate if m/^$/;
642 last if s{^Date: }{};
645 return cmdoutput qw(date +%s -d), $_;
649 open NS, '>', $seriesfile or die $!;
651 while (keys %prereq) {
653 foreach my $try (sort keys %prereq) {
656 $unsat->($try) <=> $unsat->($best) or
657 $authordate->($try) <=> $authordate->($best) or
663 printdebug "merge_series series next $best\n";
664 print NS "$best\n" or die $!;
665 delete $prereq{$best};
666 foreach my $gp (values %prereq) {
671 runcmd @git, qw(add), $seriesfile;
672 runcmd @git, qw(commit --quiet -m), 'Merged patch queue form';
673 $merged_pq = git_rev_parse 'HEAD';
674 $mwrecknote->('merged-patchqueue', $merged_pq);
676 return merge_series_patchqueue_convert
677 $wrecknotes, $newbase, $merged_pq;
680 sub merge_series_patchqueue_convert ($$$) {
681 my ($wrecknotes, $newbase, $merged_pq) = @_;
686 printdebug "merge_series series gbp pq import\n";
687 runcmd @git, qw(checkout -q -b mergec), $merged_pq;
689 merge_attempt_cmd($wrecknotes, qw(gbp pq import));
691 # OK now we are on patch-queue/merge, and we need to rebase
692 # onto the intended parent and drop the patches from each one
694 printdebug "merge_series series ok, building...\n";
695 my $build = $newbase;
696 my @lcmd = (@git, qw(rev-list --reverse mergec..patch-queue/mergec));
697 foreach my $c (grep /./, split /\n/, cmdoutput @lcmd) {
698 my $commit = git_cat_file $c, 'commit';
699 printdebug "merge_series series ok, building $c\n";
700 read_tree_upstream $c, 0, $newbase;
701 my $tree = cmdoutput @git, qw(write-tree);
702 $commit =~ s{^parent (\S+)$}{parent $build}m or confess;
703 $commit =~ s{^tree (\S+)$}{tree $tree}m or confess;
704 open C, ">", "../mcommit" or die $!;
705 print C $commit or die $!;
707 $build = cmdoutput @git, qw(hash-object -w -t commit ../mcommit);
710 mwrecknote($wrecknotes, 'merged-result', $result);
712 runcmd @git, qw(update-ref refs/heads/result), $result;
714 runcmd @git, qw(checkout -q -b debug);
715 runcmd @git, qw(commit --allow-empty -q -m M-INDEX);
716 runcmd @git, qw(add .);
717 runcmd @git, qw(commit --allow-empty -q -m M-WORKTREE);
718 my $mdebug = git_rev_parse 'HEAD';
719 printdebug sprintf "merge_series done debug=%s\n", $mdebug;
720 mwrecknote($wrecknotes, 'merged-debug', $mdebug);
722 printdebug "merge_series returns $result\n";
726 # classify returns an info hash like this
728 # Hdr => # commit headers, including 1 final newline
729 # Msg => # commit message (so one newline is dropped)
731 # Type => (see below)
733 # Ix => $index # ie 0, 1, 2, ...
735 # Differs => return value from get_differs
737 # IsDggitImport => 'orig' 'tarball' 'unpatched' 'package' (as from dgit)
739 # NewMsg => # commit message, but with any [dgit import ...] edited
740 # # to say "[was: ...]"
750 # has additional entres in classification result
751 # Overwritten = [ subset of Parents ]
752 # Contributor = $the_remaining_Parent
754 # DgitImportUnpatched
755 # has additional entry in classification result
756 # OrigParents = [ subset of Parents ]
759 # has additional entry in classification result
760 # OrigParents = [ subset of Parents ] # singleton list
767 # has additional entry in classification result
770 sub parsecommit ($;$) {
771 my ($objid, $p_ref) = @_;
772 # => hash with CommitId Hdr Msg Tree Parents
773 # Parents entries have only Ix CommitId
774 # $p_ref, if provided, must be [] and is used as a base for Parents
779 my ($h,$m) = get_commit $objid;
781 my ($t) = $h =~ m/^tree (\w+)$/m or die $objid;
782 my (@ph) = $h =~ m/^parent (\w+)$/mg;
792 foreach my $ph (@ph) {
794 Ix => scalar @$p_ref,
806 my $r = parsecommit($objid, \@p);
810 $p->{Differs} = (get_differs $p->{CommitId}, $t),
813 printdebug "classify $objid \$t=$t \@p",
814 (map { sprintf " %s/%#x", $_->{CommitId}, $_->{Differs} } @p),
818 my ($type, @rest) = @_;
819 $r = { %$r, Type => $type, @rest };
821 printdebug " = $type ".(dd $r)."\n";
827 $r = { %$r, Type => qw(Unknown), Why => $why };
828 printdebug " ** Unknown\n";
832 if (grep { $_ eq $objid } @opt_anchors) {
833 return $classify->('TreatAsAnchor');
836 my @identical = grep { !$_->{Differs} } @p;
837 my ($stype, $series) = git_cat_file "$t:debian/patches/series";
838 my $haspatches = $stype ne 'missing' && $series =~ m/^\s*[^#\n\t ]/m;
840 if ($r->{Msg} =~ m{^\[git-debrebase anchor.*\]$}m) {
841 # multi-orig upstreams are represented with an anchor merge
842 # from a single upstream commit which combines the orig tarballs
844 # Every anchor tagged this way must be a merge.
845 # We are relying on the
846 # [git-debrebase anchor: ...]
847 # commit message annotation in "declare" anchor merges (which
848 # do not have any upstream changes), to distinguish those
849 # anchor merges from ordinary pseudomerges (which we might
850 # just try to strip).
852 # However, the user is going to be doing git-rebase a lot. We
853 # really don't want them to rewrite an anchor commit.
854 # git-rebase trips up on merges, so that is a useful safety
857 # BreakwaterStart commits are also anchors in the terminology
858 # of git-debrebase(5), but they are untagged (and always
859 # manually generated).
861 # We cannot not tolerate any tagged linear commit (ie,
862 # BreakwaterStart commits tagged `[anchor:') because such a
863 # thing could result from an erroneous linearising raw git
864 # rebase of a merge anchor. That would represent a corruption
865 # of the branch. and we want to detect and reject the results
866 # of such corruption before it makes it out anywhere. If we
867 # reject it here then we avoid making the pseudomerge which
868 # would be needed to push it.
870 my $badanchor = sub { $unknown->("git-debrebase \`anchor' but @_"); };
871 @p == 2 or return $badanchor->("has other than two parents");
872 $haspatches and return $badanchor->("contains debian/patches");
874 # How to decide about l/r ordering of anchors ? git
875 # --topo-order prefers to expand 2nd parent first. There's
876 # already an easy rune to look for debian/ history anyway (git log
877 # debian/) so debian breakwater branch should be 1st parent; that
878 # way also there's also an easy rune to look for the upstream
879 # patches (--topo-order).
881 # Also this makes --first-parent be slightly more likely to
882 # be useful - it makes it provide a linearised breakwater history.
884 # Of course one can say somthing like
885 # gitk -- ':/' ':!/debian'
886 # to get _just_ the commits touching upstream files, and by
887 # the TREESAME logic in git-rev-list this will leave the
888 # breakwater into upstream at the first anchor. But that
889 # doesn't report debian/ changes at all.
891 # Other observations about gitk: by default, gitk seems to
892 # produce output in a different order to git-rev-list. I
893 # can't seem to find this documented anywhere. gitk
894 # --date-order DTRT. But, gitk always seems to put the
895 # parents from left to right, in order, so it's easy to see
896 # which way round a pseudomerge is.
898 $p[0]{IsOrigin} and $badanchor->("is an origin commit");
899 $p[1]{Differs} & ~DS_DEB and
900 $badanchor->("upstream files differ from left parent");
901 $p[0]{Differs} & ~D_UPS and
902 $badanchor->("debian/ differs from right parent");
904 return $classify->(qw(Anchor),
905 OrigParents => [ $p[1] ]);
909 my $d = $r->{Parents}[0]{Differs};
910 if ($d == D_PAT_ADD) {
911 return $classify->(qw(AddPatches));
912 } elsif ($d & (D_PAT_ADD|D_PAT_OTH)) {
913 return $unknown->("edits debian/patches");
914 } elsif ($d & DS_DEB and !($d & ~DS_DEB)) {
915 my ($ty,$dummy) = git_cat_file "$p[0]{CommitId}:debian";
917 if ($d == D_DEB_CLOG) {
918 return $classify->(qw(Changelog));
920 return $classify->(qw(Packaging));
922 } elsif ($ty eq 'missing') {
923 return $classify->(qw(BreakwaterStart));
925 return $unknown->("parent's debian is not a directory");
927 } elsif ($d == D_UPS) {
928 return $classify->(qw(Upstream));
929 } elsif ($d & DS_DEB and $d & D_UPS and !($d & ~(DS_DEB|D_UPS))) {
930 return $classify->(qw(Mixed));
932 return $unknown->("no changes");
934 confess "internal error $objid ?";
938 return $unknown->("origin commit");
941 if (@p == 2 && @identical == 1) {
942 my @overwritten = grep { $_->{Differs} } @p;
943 confess "internal error $objid ?" unless @overwritten==1;
944 return $classify->(qw(Pseudomerge),
945 Overwritten => [ $overwritten[0] ],
946 Contributor => $identical[0]);
948 if (@p == 2 && @identical == 2) {
950 my ($ph,$pm) = get_commit $_[0]{CommitId};
951 $ph =~ m/^committer .* (\d+) [-+]\d+$/m or die "$_->{CommitId} ?";
955 my $order = $get_t->($bytime[0]) <=> $get_t->($bytime[1]);
956 if ($order > 0) { # newer first
957 } elsif ($order < 0) {
958 @bytime = reverse @bytime;
960 # same age, default to order made by -s ours
961 # that is, commit was made by someone who preferred L
963 return $classify->(qw(Pseudomerge),
964 SubType => qw(Ambiguous),
965 Contributor => $bytime[0],
966 Overwritten => [ $bytime[1] ]);
969 my ($p_h, $p_m) = get_commit $p->{CommitId};
970 $p->{IsOrigin} = $p_h !~ m/^parent \w+$/m;
971 ($p->{IsDgitImport},) = $p_m =~ m/^\[dgit import ([0-9a-z]+) .*\]$/m;
973 my @orig_ps = grep { ($_->{IsDgitImport}//'X') eq 'orig' } @p;
975 if (!(grep { !$_->{IsOrigin} } @p) and
976 (@orig_ps >= @p - 1) and
977 $m2 =~ s{^\[(dgit import unpatched .*)\]$}{[was: $1]}m) {
979 return $classify->(qw(DgitImportUnpatched),
980 OrigParents => \@orig_ps);
984 $r->{Msg} =~ m{^\[git-debrebase merged-breakwater.*\]$}m) {
985 # xxx ^ metadata tag needs adding to (5)
986 return $classify->("MergedBreakwaters");
988 if ($r->{Msg} =~ m{^\[(git-debrebase|dgit)[: ].*\]$}m) {
989 return $unknown->("unknown kind of merge from $1");
992 return $unknown->("octopus merge");
995 if (!$ENV{GIT_DEBREBASE_EXPERIMENTAL_MERGE}) {
996 return $unknown->("general two-parent merge");
999 return $classify->("VanillaMerge");
1002 sub keycommits ($;$$$$$);
1004 sub mergedbreakwaters_anchor ($) {
1007 foreach my $p (@{ $cl->{Parents} }) {
1008 my ($panchor, $pbw) = keycommits $p->{CommitId},
1009 undef,undef,undef,undef, 1;
1010 $best_anchor = $panchor
1011 if !defined $best_anchor
1012 or is_fast_fwd $best_anchor, $panchor;
1013 fail "inconsistent anchors in merged-breakwaters $p->{CommitId}"
1014 unless is_fast_fwd $panchor, $best_anchor;
1016 return $best_anchor;
1019 sub keycommits ($;$$$$$) {
1020 my ($head, $furniture, $unclean, $trouble, $fatal, $claimed_bw) = @_;
1021 # => ($anchor, $breakwater)
1023 # $unclean->("unclean-$tagsfx", $msg, $cl)
1024 # $furniture->("unclean-$tagsfx", $msg, $cl)
1025 # $dgitimport->("unclean-$tagsfx", $msg, $cl))
1026 # is callled for each situation or commit that
1027 # wouldn't be found in a laundered branch
1028 # $furniture is for furniture commits such as might be found on an
1029 # interchange branch (pseudomerge, d/patches, changelog)
1030 # $trouble is for things whnich prevent the return of
1031 # anchor and breakwater information; if that is ignored,
1032 # then keycommits returns (undef, undef) instead.
1033 # $fatal is for unprocessable commits, and should normally cause
1034 # a failure. If ignored, agaion, (undef, undef) is returned.
1036 # If $claimed_bw, this is supposed to be a breakwater commit.
1038 # If a callback is undef, fail is called instead.
1039 # If a callback is defined but false, the situation is ignored.
1040 # Callbacks may say:
1041 # no warnings qw(exiting); last;
1042 # if the answer is no longer wanted.
1044 my ($anchor, $breakwater);
1045 $breakwater = $head if $claimed_bw;
1049 $fatal //= sub { fail $_[1]; };
1051 my ($cb, $tagsfx, $mainwhy, $xwhy) = @_;
1052 my $why = $mainwhy.$xwhy;
1053 my $m = "branch needs laundering (run git-debrebase): $why";
1054 fail $m unless defined $cb;
1056 $cb->("unclean-$tagsfx", $why, $cl, $mainwhy);
1058 my $found_anchor = sub {
1060 $breakwater //= $clogonly;
1061 $breakwater //= $head;
1062 no warnings qw(exiting);
1066 $cl = classify $head;
1067 my $ty = $cl->{Type};
1068 if ($ty eq 'Packaging') {
1069 $breakwater //= $clogonly;
1070 $breakwater //= $head;
1071 } elsif ($ty eq 'Changelog') {
1072 # this is going to count as the tip of the breakwater
1073 # only if it has no upstream stuff before it
1074 $clogonly //= $head;
1075 } elsif ($ty eq 'Anchor' or
1076 $ty eq 'TreatAsAnchor' or
1077 $ty eq 'BreakwaterStart') {
1078 $found_anchor->($head);
1079 } elsif ($ty eq 'Upstream') {
1080 $x->($unclean, 'ordering',
1081 "packaging change ($breakwater) follows upstream change"," (eg $head)")
1082 if defined $breakwater;
1084 $breakwater = undef;
1085 } elsif ($ty eq 'Mixed') {
1086 $x->($unclean, 'mixed',
1087 "found mixed upstream/packaging commit"," ($head)");
1089 $breakwater = undef;
1090 } elsif ($ty eq 'Pseudomerge' or
1091 $ty eq 'AddPatches') {
1093 $x->($furniture, (lc $ty),
1094 "found interchange bureaucracy commit ($ty)"," ($head)");
1095 } elsif ($ty eq 'DgitImportUnpatched') {
1097 $x->($trouble, 'dgitimport',
1098 "found dgit dsc import"," ($head)");
1099 return (undef,undef);
1101 $x->($fatal, 'unprocessable',
1102 "found bare dgit dsc import with no prior history",
1104 return (undef,undef);
1106 } elsif ($ty eq 'VanillaMerge') {
1107 $x->($trouble, 'vanillamerge',
1108 "found vanilla merge"," ($head)");
1109 return (undef,undef);
1110 } elsif ($ty eq 'MergedBreakwaters') {
1111 $found_anchor->(mergedbreakwaters_anchor $cl);
1113 $x->($fatal, 'unprocessable',
1114 "found unprocessable commit, cannot cope: $cl->{Why}",
1116 return (undef,undef);
1118 $head = $cl->{Parents}[0]{CommitId};
1120 return ($anchor, $breakwater);
1126 $nogenerate,$report, $report_lprefix) = @_;
1127 # => ($tip, $breakwater_tip, $last_anchor)
1128 # (or nothing, if $nogenerate)
1130 printdebug "*** WALK $input ".($nogenerate//0)." ".($report//'-')."\n";
1131 $report_lprefix //= '';
1133 # go through commits backwards
1134 # we generate two lists of commits to apply:
1135 # breakwater branch and upstream patches
1136 my (@brw_cl, @upp_cl, @processed);
1143 my ($prose, $info) = @_;
1144 my $ms = $cl->{Msg};
1147 $ms .= "\n\n[git-debrebase$info: $prose]\n";
1148 return (Msg => $ms);
1150 my $rewrite_from_here = sub {
1152 my $sp_cl = { SpecialMethod => 'StartRewrite' };
1154 push @processed, $sp_cl;
1159 my $prprdelim = sub { print $report $prdelim if $report; $prdelim=""; };
1162 return unless $report;
1163 print $report $prdelim, $report_lprefix, @_;
1167 my $bomb = sub { # usage: return $bomb->();
1168 print $report " Unprocessable" if $report;
1169 print $report " ($cl->{Why})" if $report && defined $cl->{Why};
1172 return (undef,undef);
1174 fail "found unprocessable commit, cannot cope".
1175 (defined $cl->{Why} ? "; $cl->{Why}:": ':').
1176 " (commit $cur) (d.".
1177 (join ' ', map { sprintf "%#x", $_->{Differs} }
1178 @{ $cl->{Parents} }).
1185 my $build_start = sub {
1186 my ($msg, $parent) = @_;
1189 no warnings qw(exiting); last;
1194 merge_failed $cl->{MergeWreckNotes}, $emsg;
1197 my $mwrecknote = sub { &mwrecknote($cl->{MergeWreckNotes}, @_); };
1202 $cl = classify $cur;
1203 $cl->{MergeWreckNotes} //= {};
1204 my $ty = $cl->{Type};
1205 my $st = $cl->{SubType};
1206 $prline->("$cl->{CommitId} $cl->{Type}");
1207 $found{$ty. ( defined($st) ? "-$st" : '' )}++;
1208 push @processed, $cl;
1209 my $p0 = @{ $cl->{Parents} }==1 ? $cl->{Parents}[0]{CommitId} : undef;
1210 if ($ty eq 'AddPatches') {
1212 $rewrite_from_here->(\@upp_cl);
1214 } elsif ($ty eq 'Packaging' or $ty eq 'Changelog') {
1218 } elsif ($ty eq 'BreakwaterStart') {
1219 $last_anchor = $cur;
1220 $build_start->('FirstPackaging', $cur);
1221 } elsif ($ty eq 'Upstream') {
1225 } elsif ($ty eq 'Mixed') {
1228 my $cls = { %$cl, $xmsg->("split mixed commit: $wh part") };
1231 $queue->(\@brw_cl, "debian");
1232 $queue->(\@upp_cl, "upstream");
1233 $rewrite_from_here->(\@brw_cl);
1236 } elsif ($ty eq 'Pseudomerge') {
1237 my $contrib = $cl->{Contributor}{CommitId};
1238 print $report " Contributor=$contrib" if $report;
1239 push @pseudomerges, $cl;
1240 $rewrite_from_here->(\@upp_cl);
1243 } elsif ($ty eq 'Anchor' or $ty eq 'TreatAsAnchor') {
1244 $last_anchor = $cur;
1245 $build_start->("Anchor", $cur);
1246 } elsif ($ty eq 'DgitImportUnpatched') {
1247 my $pm = $pseudomerges[-1];
1249 # To an extent, this is heuristic. Imports don't have
1250 # a useful history of the debian/ branch. We assume
1251 # that the first pseudomerge after an import has a
1252 # useful history of debian/, and ignore the histories
1253 # from later pseudomerges. Often the first pseudomerge
1254 # will be the dgit import of the upload to the actual
1255 # suite intended by the non-dgit NMUer, and later
1256 # pseudomerges may represent in-archive copies.
1257 my $ovwrs = $pm->{Overwritten};
1258 printf $report " PM=%s \@Overwr:%d",
1259 $pm->{CommitId}, (scalar @$ovwrs)
1262 printdebug "*** WALK BOMB DgitImportUnpatched\n";
1265 my $ovwr = $ovwrs->[0]{CommitId};
1266 printf $report " Overwr=%s", $ovwr if $report;
1267 # This import has a tree which is just like a
1268 # breakwater tree, but it has the wrong history. It
1269 # ought to have the previous breakwater (which the
1270 # pseudomerge overwrote) as an ancestor. That will
1271 # make the history of the debian/ files correct. As
1272 # for the upstream version: either it's the same as
1273 # was ovewritten (ie, same as the previous
1274 # breakwater), in which case that history is precisely
1275 # right; or, otherwise, it was a non-gitish upload of a
1276 # new upstream version. We can tell these apart by
1277 # looking at the tree of the supposed upstream.
1280 SpecialMethod => 'DgitImportDebianUpdate',
1281 $xmsg->("convert dgit import: debian changes")
1284 SpecialMethod => 'DgitImportUpstreamUpdate',
1285 $xmsg->("convert dgit import: upstream update",
1288 $prline->(" Import");
1289 $rewrite_from_here->(\@brw_cl);
1290 $upp_limit //= $#upp_cl; # further, deeper, patches discarded
1294 # Everything is from this import. This kind of import
1295 # is already nearly in valid breakwater format, with the
1296 # patches as commits. Unfortunately it contains
1298 printdebug "*** WALK BOMB bare dgit import\n";
1299 $cl->{Why} = "bare dgit dsc import";
1303 } elsif ($ty eq 'MergedBreakwaters') {
1304 $last_anchor = mergedbreakwaters_anchor $cl;
1305 $build_start->(' MergedBreakwaters', $cur);
1307 } elsif ($ty eq 'VanillaMerge') {
1308 # User may have merged unstitched branch(es). We will
1309 # have now lost what ffq-prev was then (since the later
1310 # pseudomerge may introduce further changes). The effect
1311 # of resolving such a merge is that we may have to go back
1312 # further in history to find a merge base, since the one
1313 # which was reachable via ffq-prev is no longer findable.
1314 # This is suboptimal, but if it all works we'll have done
1316 # xxx we should warn the user in the docs about this
1320 # We expect to find a dominating anchor amongst the
1321 # inputs' anchors. That will be the new anchor.
1323 # More complicated is finding a merge base for the
1324 # breakwaters. We need a merge base that is a breakwater
1325 # commit. The ancestors of breakwater commits are more
1326 # breakwater commits and possibly upstream commits and the
1327 # ancestors of those upstream. Upstreams might have
1328 # arbitrary ancestors. But any upstream commit U is
1329 # either included in both anchors, in which case the
1330 # earlier anchor is a better merge base than any of U's
1331 # ancestors; or U is not included in the older anchor, in
1332 # which case U is not an ancestor of the vanilla merge at
1333 # all. So no upstream commit, nor any ancestor thereof,
1334 # is a best merge base. As for non-breakwater Debian
1335 # commits: these are never ancestors of any breakwater.
1337 # So any best merge base as found by git-merge-base
1338 # is a suitable breakwater anchor. Usually there will
1341 printdebug "*** MERGE\n";
1343 my @bwbcmd = (@git, qw(merge-base));
1344 my @ibcmd = (@git, qw(merge-base --all));
1345 my $might_be_in_bw = 1;
1347 my $ps = $cl->{Parents};
1349 $mwrecknote->('vanilla-merge', $cl->{CommitId});
1351 foreach my $p (@$ps) {
1352 $prline->(" VanillaMerge ".$p->{Ix});
1354 my ($ptip, $pbw, $panchor) =
1355 walk $p->{CommitId}, 0, $report,
1356 $report_lprefix.' ';
1357 $p->{Laundered} = $p->{SeriesTip} = $ptip;
1358 $p->{Breakwater} = $p->{SeriesBase} = $pbw;
1359 $p->{Anchor} = $panchor;
1361 my $lr = $p->{LeftRight} = (qw(left right))[$p->{Ix}];
1362 $mwrecknote->("$lr-input", $p->{CommitId});
1364 my $mwrecknote_parent = sub {
1366 $mwrecknote->("$lr-".(lc $which), $p->{$which});
1368 $mwrecknote_parent->('Laundered');
1369 $mwrecknote_parent->('Breakwater');
1370 $mwrecknote_parent->('Anchor');
1372 $best_anchor = $panchor if
1373 !defined $best_anchor or
1374 is_fast_fwd $best_anchor, $panchor;
1376 printdebug " MERGE BA best=".($best_anchor//'-').
1380 $mwrecknote->('result-anchor', $best_anchor);
1382 foreach my $p (@$ps) {
1383 $prline->(" VanillaMerge ".$p->{Ix});
1384 if (!is_fast_fwd $p->{Anchor}, $best_anchor) {
1385 $nomerge->('divergent anchors');
1386 } elsif ($p->{Anchor} eq $best_anchor) {
1387 print $report " SameAnchor" if $report;
1389 print $report " SupersededAnchor" if $report;
1391 if ($p->{Breakwater} eq $p->{CommitId}) {
1392 # this parent commit was its own breakwater,
1393 # ie it is part of the breakwater
1394 print $report " Breakwater" if $report;
1396 $might_be_in_bw = 0;
1398 push @bwbcmd, $p->{Breakwater};
1399 push @ibcmd, $p->{CommitId};
1402 if ($ok && $might_be_in_bw) {
1403 # We could rewrite this to contaion the metadata
1404 # declaring it to be MergedBreakwaters, but
1405 # unnecessarily rewriting a merge seems unhelpful.
1406 $prline->(" VanillaMerge MergedBreakwaters");
1407 $last_anchor = $best_anchor;
1408 $build_start->('MergedBreakwaters', $cur);
1411 my $bwb = cmdoutput @bwbcmd;
1413 # OK, now we have a breakwater base, but we need the merge
1414 # base for the interchange branch because we need the delta
1417 # This a the best merge base of our inputs which has the
1418 # breakwater merge base as an ancestor.
1425 @ibs or confess 'internal error, expected anchor at least ?';
1429 foreach my $tibix (0..$#ibs) {
1430 my $tib = $ibs[$tibix];
1431 my $ff = is_fast_fwd $bwb, $tib;
1432 my $ok = !$ff ? 'rej' : $ib ? 'extra' : 'ok';
1433 my $tibleaf = "interchange-mbcand-$ok-$tibix";
1434 $mwrecknote->($tibleaf, $tib);
1441 $ib or $nomerge->("no suitable interchange merge base");
1443 $prline->(" VanillaMerge Base");
1445 my ($btip, $bbw, $banchor) = eval {
1446 walk $ib, 0, $report, $report_lprefix.' ';
1448 $nomerge->("walking interchange branch merge base ($ibleaf):\n".
1452 $mwrecknote->("mergebase-laundered", $btip);
1453 $mwrecknote->("mergebase-breakwater", $bbw);
1454 $mwrecknote->("mergebase-anchor", $banchor);
1456 my $ibinfo = { SeriesTip => $btip,
1459 LeftRight => 'mergebase' };
1462 or $nomerge->("interchange merge-base ($ib)'s".
1463 " breakwater ($bbw)".
1464 " != breakwaters' merge-base ($bwb)");
1466 grep { $_->{Anchor} eq $ibinfo->{Anchor} } @$ps
1467 or $nomerge->("interchange merge-base ($ib)'s".
1468 " anchor ($ibinfo->{SeriesBase})".
1469 " != any merge input's anchor (".
1470 (join ' ', map { $_->{Anchor} } @$ps).
1473 $cl->{MergeInterchangeBaseInfo} = $ibinfo;
1474 $cl->{MergeBestAnchor} = $best_anchor;
1477 SpecialMethod => 'MergeCreateMergedBreakwaters',
1478 $xmsg->('constructed from vanilla merge',
1479 ' merged-breakwater'),
1483 SpecialMethod => 'MergeMergeSeries',
1485 $build_start->('MergeBreakwaters', $cur);
1487 printdebug "*** WALK BOMB unrecognised\n";
1493 printdebug "*** WALK prep done cur=$cur".
1494 " brw $#brw_cl upp $#upp_cl proc $#processed pm $#pseudomerges\n";
1496 return if $nogenerate;
1498 # Now we build it back up again
1504 $#upp_cl = $upp_limit if defined $upp_limit;
1506 my $committer_authline = calculate_committer_authline();
1508 printdebug "WALK REBUILD $build ".(scalar @processed)."\n";
1510 confess "internal error" unless $build eq (pop @processed)->{CommitId};
1513 mkdir $rd or $!==EEXIST or die $!;
1515 my $want_debian = $build;
1516 my $want_upstream = $build;
1518 my $read_tree_upstream = sub { ($want_upstream) = @_; };
1519 my $read_tree_debian = sub { ($want_debian) = @_; };
1521 foreach my $cl (qw(Debian), (reverse @brw_cl),
1522 { SpecialMethod => 'RecordBreakwaterTip' },
1523 qw(Upstream), (reverse @upp_cl)) {
1525 $current_method = $cl;
1528 my $method = $cl->{SpecialMethod} // $current_method;
1529 my @parents = ($build);
1530 my $cltree = $cl->{CommitId};
1531 printdebug "WALK BUILD ".($cltree//'undef').
1532 " $method (rewriting=$rewriting)\n";
1533 if ($method eq 'Debian') {
1534 $read_tree_debian->($cltree);
1535 } elsif ($method eq 'Upstream') {
1536 $read_tree_upstream->($cltree);
1537 } elsif ($method eq 'StartRewrite') {
1540 } elsif ($method eq 'RecordBreakwaterTip') {
1541 $breakwater = $build;
1543 } elsif ($method eq 'DgitImportDebianUpdate') {
1544 $read_tree_debian->($cltree);
1545 } elsif ($method eq 'DgitImportUpstreamUpdate') {
1546 confess unless $rewriting;
1547 my $differs = (get_differs $build, $cltree);
1548 next unless $differs & D_UPS;
1549 $read_tree_upstream->($cltree);
1550 push @parents, map { $_->{CommitId} } @{ $cl->{OrigParents} };
1551 } elsif ($method eq 'MergeCreateMergedBreakwaters') {
1552 print "Found a general merge, will try to tidy it up.\n";
1554 $read_tree_upstream->($cl->{MergeBestAnchor});
1555 $read_tree_debian->($cltree);
1556 @parents = map { $_->{Breakwater} } @{ $cl->{Parents} };
1557 } elsif ($method eq 'MergeMergeSeries') {
1558 my $cachehit = reflog_cache_lookup
1559 $merge_cache_ref, "vanilla-merge $cl->{CommitId}";
1561 print "Using supplied resolution for $cl->{CommitId}...\n";
1563 $mwrecknote->('cached-resolution', $build);
1565 print "Running merge resolution for $cl->{CommitId}...\n";
1566 $mwrecknote->('new-base', $build);
1567 $build = merge_series
1568 $build, $cl->{MergeWreckNotes},
1569 $cl->{MergeInterchangeBaseInfo},
1570 @{ $cl->{Parents} };
1572 $last_anchor = $cl->{MergeBestAnchor};
1574 # Check for mismerges:
1576 my ($against, $allow, $what) = @_;
1577 my $differs = get_differs $build, $against;
1579 "merge misresolved: %s are not the same (%s %s d.%#x)",
1580 $what, $against, $build, $differs)
1581 if $differs & ~($allow | D_PAT_ADD);
1584 # Breakwater changes which were in each side of the
1585 # merge will have been incorporated into the
1586 # MergeCreateMergedBreakwaters output. Because the
1587 # upstream series was rebased onto the new breakwater,
1588 # so should all of the packaging changes which were in
1590 $check->($input, D_UPS, 'debian files');
1592 # Upstream files are merge_series, which ought to
1593 # have been identical to the original merge.
1594 $check->($cl->{CommitId}, DS_DEB, 'upstream files');
1596 print "Merge resolution successful.\n";
1599 confess "$method ?";
1602 my $procd = (pop @processed) // 'UNDEF';
1603 if ($cl ne $procd) {
1605 printdebug "WALK REWRITING NOW cl=$cl procd=$procd\n";
1608 if ($rewriting || $opt_careful) {
1609 read_tree_upstream $want_upstream, 0, $want_debian;
1611 my $newtree = cmdoutput @git, qw(write-tree);
1612 my $ch = $cl->{Hdr};
1613 $ch =~ s{^tree .*}{tree $newtree}m or confess "$ch ?";
1614 $ch =~ s{^parent .*\n}{}mg;
1615 $ch =~ s{(?=^author)}{
1616 join '', map { "parent $_\n" } @parents
1617 }me or confess "$ch ?";
1619 $ch =~ s{^committer .*$}{$committer_authline}m
1622 my $cf = "$rd/m$rewriting";
1623 open CD, ">", $cf or die $!;
1624 print CD $ch, "\n", $cl->{Msg} or die $!;
1626 my @cmd = (@git, qw(hash-object));
1627 push @cmd, qw(-w) if $rewriting;
1628 push @cmd, qw(-t commit), $cf;
1629 my $newcommit = cmdoutput @cmd;
1630 confess "$ch ?" unless $rewriting
1631 or $newcommit eq $cl->{CommitId};
1632 $build = $newcommit;
1634 $build = $cl->{CommitId};
1635 trees_diff_walk "$want_upstream:", "$build:", sub {
1637 no warnings qw(exiting);
1638 next if $n eq 'debian/';
1639 confess "mismatch @_ ?";
1641 trees_diff_walk "$want_debian:debian", "$build:debian", sub {
1642 confess "mismatch @_ ?";
1644 my @old_parents = map { $_->{CommitId} } @{ $cl->{Parents} };
1645 confess "mismatch @parents != @old_parents ?"
1646 unless "@parents" eq "@old_parents";
1648 if (grep { $method eq $_ } qw(DgitImportUpstreamUpdate)) {
1649 $last_anchor = $cur;
1654 my $final_check = get_differs $build, $input;
1655 die sprintf "internal error %#x %s %s", $final_check, $input, $build
1656 if $final_check & ~D_PAT_ADD;
1658 my @r = ($build, $breakwater, $last_anchor);
1659 printdebug "*** WALK RETURN @r\n";
1664 git_check_unmodified();
1665 return git_rev_parse qw(HEAD);
1668 sub update_head ($$$) {
1669 my ($old, $new, $mrest) = @_;
1670 push @deferred_updates, "update HEAD $new $old";
1671 run_deferred_updates $mrest;
1674 sub update_head_checkout ($$$) {
1675 my ($old, $new, $mrest) = @_;
1676 update_head $old, $new, $mrest;
1677 runcmd @git, qw(reset --hard);
1680 sub update_head_postlaunder ($$$) {
1681 my ($old, $tip, $reflogmsg) = @_;
1682 return if $tip eq $old && !@deferred_updates;
1683 print "git-debrebase: laundered (head was $old)\n";
1684 update_head $old, $tip, $reflogmsg;
1685 # no tree changes except debian/patches
1686 runcmd @git, qw(rm --quiet --ignore-unmatch -rf debian/patches);
1689 sub currently_rebasing() {
1690 foreach (qw(rebase-merge rebase-apply)) {
1691 return 1 if stat_exists "$maindir_gitdir/$_";
1696 sub bail_if_rebasing() {
1697 fail "you are in the middle of a git-rebase already"
1698 if currently_rebasing();
1701 sub do_launder_head ($) {
1702 my ($reflogmsg) = @_;
1703 my $old = get_head();
1705 my ($tip,$breakwater) = walk $old;
1707 update_head_postlaunder $old, $tip, $reflogmsg;
1708 return ($tip,$breakwater);
1711 sub cmd_launder_v0 () {
1712 badusage "no arguments to launder-v0 allowed" if @ARGV;
1713 my $old = get_head();
1714 my ($tip,$breakwater,$last_anchor) = walk $old;
1715 update_head_postlaunder $old, $tip, 'launder';
1716 printf "# breakwater tip\n%s\n", $breakwater;
1717 printf "# working tip\n%s\n", $tip;
1718 printf "# last anchor\n%s\n", $last_anchor;
1721 sub defaultcmd_rebase () {
1722 push @ARGV, @{ $opt_defaultcmd_interactive // [] };
1723 my ($tip,$breakwater) = do_launder_head 'launder for rebase';
1724 runcmd @git, qw(rebase), @ARGV, $breakwater if @ARGV;
1727 sub cmd_analyse () {
1728 badusage "analyse does not support any options"
1729 if @ARGV and $ARGV[0] =~ m/^-/;
1730 badusage "too many arguments to analyse" if @ARGV>1;
1733 $old = git_rev_parse $old;
1735 $old = git_rev_parse 'HEAD';
1737 my ($dummy,$breakwater) = walk $old, 1,*STDOUT;
1738 STDOUT->error and die $!;
1741 sub ffq_prev_branchinfo () {
1742 my $current = git_get_symref();
1743 return gdr_ffq_prev_branchinfo($current);
1746 sub ffq_check ($;$$) {
1747 # calls $ff and/or $notff zero or more times
1748 # then returns either (status,message) where status is
1753 # or (undef,undef, $ffq_prev,$gdrlast)
1754 # $ff and $notff are called like this:
1755 # $ff->("message for stdout\n");
1756 # $notff->('snag-name', $message);
1757 # normally $currentval should be HEAD
1758 my ($currentval, $ff, $notff) =@_;
1760 $ff //= sub { print $_[0] or die $!; };
1763 my ($status, $message, $current, $ffq_prev, $gdrlast)
1764 = ffq_prev_branchinfo();
1765 return ($status, $message) unless $status eq 'branch';
1767 my $exists = git_get_ref $ffq_prev;
1768 return ('exists',"$ffq_prev already exists") if $exists;
1770 return ('not-branch', 'HEAD symref is not to refs/heads/')
1771 unless $current =~ m{^refs/heads/};
1774 my @check_specs = split /\;/, (cfg "branch.$branch.ffq-ffrefs",1) // '*';
1777 printdebug "ffq check_specs @check_specs\n";
1780 my ($lrref, $desc) = @_;
1781 printdebug "ffq might check $lrref ($desc)\n";
1783 for my $chk (@check_specs) {
1785 $invert = $glob =~ s{^[!^]}{};
1786 last if fnmatch $glob, $lrref;
1789 my $lrval = git_get_ref $lrref;
1790 return unless length $lrval;
1792 if (is_fast_fwd $lrval, $currentval) {
1793 $ff->("OK, you are ahead of $lrref\n");
1794 $checked{$lrref} = 1;
1795 } elsif (is_fast_fwd $currentval, $lrval) {
1796 $checked{$lrref} = -1;
1797 $notff->('behind', "you are behind $lrref, divergence risk");
1799 $checked{$lrref} = -1;
1800 $notff->('diverged', "you have diverged from $lrref");
1804 my $merge = cfg "branch.$branch.merge",1;
1805 if (defined $merge and $merge =~ m{^refs/heads/}) {
1807 printdebug "ffq merge $rhs\n";
1808 my $check_remote = sub {
1809 my ($remote, $desc) = @_;
1810 printdebug "ffq check_remote ".($remote//'undef')." $desc\n";
1811 return unless defined $remote;
1812 $check->("refs/remotes/$remote/$rhs", $desc);
1814 $check_remote->((scalar cfg "branch.$branch.remote",1),
1815 'remote fetch/merge branch');
1816 $check_remote->((scalar cfg "branch.$branch.pushRemote",1) //
1817 (scalar cfg "branch.$branch.pushDefault",1),
1818 'remote push branch');
1820 if ($branch =~ m{^dgit/}) {
1821 $check->("refs/remotes/dgit/$branch", 'remote dgit branch');
1822 } elsif ($branch =~ m{^master$}) {
1823 $check->("refs/remotes/dgit/dgit/sid", 'remote dgit branch for sid');
1825 return (undef, undef, $ffq_prev, $gdrlast);
1828 sub record_ffq_prev_deferred () {
1829 # => ('status', "message")
1831 # deferred message is undef
1836 # if not ff from some branch we should be ff from, is an snag
1837 # if "deferred", will have added something about that to
1838 # @deferred_update_messages, and also maybe printed (already)
1839 # some messages about ff checks
1841 my $currentval = get_head();
1843 my ($status,$message, $ffq_prev,$gdrlast) = ffq_check $currentval;
1844 return ($status,$message) if defined $status;
1848 push @deferred_updates, "update $ffq_prev $currentval $git_null_obj";
1849 push @deferred_updates, "delete $gdrlast";
1850 push @deferred_update_messages, "Recorded previous head for preservation";
1851 return ('deferred', undef);
1854 sub record_ffq_auto () {
1855 my ($status, $message) = record_ffq_prev_deferred();
1856 if ($status eq 'deferred' || $status eq 'exists') {
1858 snag $status, "could not record ffq-prev: $message";
1863 sub ffq_prev_info () {
1865 # => ($ffq_prev, $gdrlast, $ffq_prev_commitish)
1866 my ($status, $message, $current, $ffq_prev, $gdrlast)
1867 = ffq_prev_branchinfo();
1868 if ($status ne 'branch') {
1869 snag $status, "could not check ffq-prev: $message";
1872 my $ffq_prev_commitish = $ffq_prev && git_get_ref $ffq_prev;
1873 return ($ffq_prev, $gdrlast, $ffq_prev_commitish);
1876 sub stitch ($$$$$) {
1877 my ($old_head, $ffq_prev, $gdrlast, $ffq_prev_commitish, $prose) = @_;
1879 push @deferred_updates, "delete $ffq_prev $ffq_prev_commitish";
1881 if (is_fast_fwd $old_head, $ffq_prev_commitish) {
1882 my $differs = get_differs $old_head, $ffq_prev_commitish;
1883 unless ($differs & ~D_PAT_ADD) {
1884 # ffq-prev is ahead of us, and the only tree changes it has
1885 # are possibly addition of things in debian/patches/.
1886 # Just wind forwards rather than making a pointless pseudomerge.
1887 push @deferred_updates,
1888 "update $gdrlast $ffq_prev_commitish $git_null_obj";
1889 update_head_checkout $old_head, $ffq_prev_commitish,
1890 "stitch (fast forward)";
1895 # We make pseudomerges with L as the contributing parent.
1896 # This makes git rev-list --first-parent work properly.
1897 my $new_head = make_commit [ $old_head, $ffq_prev ], [
1898 'Declare fast forward / record previous work',
1899 "[git-debrebase pseudomerge: $prose]",
1901 push @deferred_updates, "update $gdrlast $new_head $git_null_obj";
1902 update_head $old_head, $new_head, "stitch: $prose";
1905 sub do_stitch ($;$) {
1906 my ($prose, $unclean) = @_;
1908 my ($ffq_prev, $gdrlast, $ffq_prev_commitish) = ffq_prev_info();
1909 if (!$ffq_prev_commitish) {
1910 fail "No ffq-prev to stitch." unless $opt_noop_ok;
1913 my $dangling_head = get_head();
1915 keycommits $dangling_head, $unclean,$unclean,$unclean;
1918 stitch($dangling_head, $ffq_prev, $gdrlast, $ffq_prev_commitish, $prose);
1921 sub upstream_commitish_search ($$) {
1922 my ($upstream_version, $tried) = @_;
1923 # todo: at some point maybe use git-deborig to do this
1924 foreach my $tagpfx ('', 'v', 'upstream/') {
1925 my $tag = $tagpfx.(dep14_version_mangle $upstream_version);
1926 my $new_upstream = git_get_ref "refs/tags/$tag";
1928 return $new_upstream if length $new_upstream;
1932 sub resolve_upstream_version ($$) {
1933 my ($new_upstream, $upstream_version) = @_;
1935 if (!defined $new_upstream) {
1937 $new_upstream = upstream_commitish_search $upstream_version, \@tried;
1938 if (!length $new_upstream) {
1939 fail "Could not determine appropriate upstream commitish.\n".
1940 " (Tried these tags: @tried)\n".
1941 " Check version, and specify upstream commitish explicitly.";
1944 $new_upstream = git_rev_parse $new_upstream;
1946 return $new_upstream;
1949 sub cmd_new_upstream () {
1950 # automatically and unconditionally launders before rebasing
1951 # if rebase --abort is used, laundering has still been done
1955 badusage "need NEW-VERSION [UPS-COMMITTISH]" unless @ARGV >= 1;
1957 # parse args - low commitment
1958 my $spec_version = shift @ARGV;
1959 my $new_version = (new Dpkg::Version $spec_version, check => 1);
1960 fail "bad version number \`$spec_version'" unless defined $new_version;
1961 if ($new_version->is_native()) {
1962 $new_version = (new Dpkg::Version "$spec_version-1", check => 1);
1965 my $new_upstream = shift @ARGV;
1966 my $new_upstream_version = upstreamversion $new_version;
1968 resolve_upstream_version $new_upstream, $new_upstream_version;
1973 my ($n, @x) = @_; # may be ''
1974 my $pc = $pieces{$n} //= {
1976 Desc => ($n ? "upstream piece \`$n'" : "upstream (main piece"),
1978 while (my $k = shift @x) { $pc->{$k} = shift @x; }
1983 my $newpiece = sub {
1984 my ($n, @x) = @_; # may be ''
1985 my $pc = $piece->($n, @x, NewIx => (scalar @newpieces));
1986 push @newpieces, $pc;
1991 New => $new_upstream,
1993 while (@ARGV && $ARGV[0] !~ m{^-}) {
1994 my $n = shift @ARGV;
1996 badusage "for each EXTRA-UPS-NAME need EXTRA-UPS-COMMITISH"
1997 unless @ARGV && $ARGV[0] !~ m{^-};
1999 my $c = git_rev_parse shift @ARGV;
2000 die unless $n =~ m/^$extra_orig_namepart_re$/;
2001 $newpiece->($n, New => $c);
2004 # now we need to investigate the branch this generates the
2005 # laundered version but we don't switch to it yet
2006 my $old_head = get_head();
2007 my ($old_laundered_tip,$old_bw,$old_anchor) = walk $old_head;
2009 my $old_bw_cl = classify $old_bw;
2010 my $old_anchor_cl = classify $old_anchor;
2012 if (!$old_anchor_cl->{OrigParents}) {
2013 snag 'anchor-treated',
2014 'old anchor is recognised due to --anchor, cannot check upstream';
2016 $old_upstream = parsecommit
2017 $old_anchor_cl->{OrigParents}[0]{CommitId};
2018 $piece->('', Old => $old_upstream->{CommitId});
2021 if ($old_upstream && $old_upstream->{Msg} =~ m{^\[git-debrebase }m) {
2022 if ($old_upstream->{Msg} =~
2023 m{^\[git-debrebase upstream-combine (\.(?: $extra_orig_namepart_re)+)\:.*\]$}m
2025 my @oldpieces = (split / /, $1);
2026 my $old_n_parents = scalar @{ $old_upstream->{Parents} };
2027 if ($old_n_parents != @oldpieces &&
2028 $old_n_parents != @oldpieces + 1) {
2029 snag 'upstream-confusing', sprintf
2030 "previous upstream combine %s".
2031 " mentions %d pieces (each implying one parent)".
2032 " but has %d parents".
2033 " (one per piece plus maybe a previous combine)",
2034 $old_upstream->{CommitId},
2035 (scalar @oldpieces),
2037 } elsif ($oldpieces[0] ne '.') {
2038 snag 'upstream-confusing', sprintf
2039 "previous upstream combine %s".
2040 " first piece is not \`.'",
2044 foreach my $i (0..$#oldpieces) {
2045 my $n = $oldpieces[$i];
2046 my $hat = 1 + $i + ($old_n_parents - @oldpieces);
2047 $piece->($n, Old => $old_upstream->{CommitId}.'^'.$hat);
2051 snag 'upstream-confusing',
2052 "previous upstream $old_upstream->{CommitId} is from".
2053 " git-debrebase but not an \`upstream-combine' commit";
2057 foreach my $pc (values %pieces) {
2058 if (!$old_upstream) {
2059 # we have complained already
2060 } elsif (!$pc->{Old}) {
2061 snag 'upstream-new-piece',
2062 "introducing upstream piece \`$pc->{Name}'";
2063 } elsif (!$pc->{New}) {
2064 snag 'upstream-rm-piece',
2065 "dropping upstream piece \`$pc->{Name}'";
2066 } elsif (!is_fast_fwd $pc->{Old}, $pc->{New}) {
2067 snag 'upstream-not-ff',
2068 "not fast forward: $pc->{Name} $pc->{Old}..$pc->{New}";
2072 printdebug "%pieces = ", (dd \%pieces), "\n";
2073 printdebug "\@newpieces = ", (dd \@newpieces), "\n";
2081 my @upstream_merge_parents;
2084 push @upstream_merge_parents, $old_upstream->{CommitId};
2087 foreach my $pc (@newpieces) { # always has '' first
2089 read_tree_subdir $pc->{Name}, $pc->{New};
2091 runcmd @git, qw(read-tree), $pc->{New};
2093 push @upstream_merge_parents, $pc->{New};
2096 # index now contains the new upstream
2098 if (@newpieces > 1) {
2099 # need to make the upstream subtree merge commit
2100 $new_upstream = make_commit \@upstream_merge_parents,
2101 [ "Combine upstreams for $new_upstream_version",
2102 ("[git-debrebase upstream-combine . ".
2103 (join " ", map { $_->{Name} } @newpieces[1..$#newpieces]).
2108 # $new_upstream is either the single upstream commit, or the
2109 # combined commit we just made. Either way it will be the
2110 # "upstream" parent of the anchor merge.
2112 read_tree_subdir 'debian', "$old_bw:debian";
2114 # index now contains the anchor merge contents
2115 $new_bw = make_commit [ $old_bw, $new_upstream ],
2116 [ "Update to upstream $new_upstream_version",
2117 "[git-debrebase anchor: new upstream $new_upstream_version, merge]",
2120 my $clogsignoff = cmdoutput qw(git show),
2121 '--pretty=format:%an <%ae> %aD',
2124 # Now we have to add a changelog stanza so the Debian version
2126 die if unlink "debian";
2127 die $! unless $!==ENOENT or $!==ENOTEMPTY;
2128 unlink "debian/changelog" or $!==ENOENT or die $!;
2129 mkdir "debian" or die $!;
2130 open CN, ">", "debian/changelog" or die $!;
2131 my $oldclog = git_cat_file ":debian/changelog";
2132 $oldclog =~ m/^($package_re) \(\S+\) / or
2133 fail "cannot parse old changelog to get package name";
2135 print CN <<END, $oldclog or die $!;
2136 $p ($new_version) UNRELEASED; urgency=medium
2138 * Update to new upstream version $new_upstream_version.
2144 runcmd @git, qw(update-index --add --replace), 'debian/changelog';
2146 # Now we have the final new breakwater branch in the index
2147 $new_bw = make_commit [ $new_bw ],
2148 [ "Update changelog for new upstream $new_upstream_version",
2149 "[git-debrebase: new upstream $new_upstream_version, changelog]",
2153 # we have constructed the new breakwater. we now need to commit to
2154 # the laundering output, because git-rebase can't easily be made
2155 # to make a replay list which is based on some other branch
2157 update_head_postlaunder $old_head, $old_laundered_tip,
2158 'launder for new upstream';
2160 my @cmd = (@git, qw(rebase --onto), $new_bw, $old_bw, @ARGV);
2161 local $ENV{GIT_REFLOG_ACTION} = git_reflog_action_msg
2162 "debrebase new-upstream $new_version: rebase";
2164 # now it's for the user to sort out
2167 sub cmd_record_ffq_prev () {
2168 badusage "no arguments allowed" if @ARGV;
2169 my ($status, $msg) = record_ffq_prev_deferred();
2170 if ($status eq 'exists' && $opt_noop_ok) {
2171 print "Previous head already recorded\n" or die $!;
2172 } elsif ($status eq 'deferred') {
2173 run_deferred_updates 'record-ffq-prev';
2175 fail "Could not preserve: $msg";
2180 badusage "no arguments allowed" if @ARGV;
2181 my ($anchor, $bw) = keycommits +(git_rev_parse 'HEAD'), 0,0;
2182 print "$bw\n" or die $!;
2185 sub cmd_breakwater () {
2186 badusage "no arguments allowed" if @ARGV;
2187 my ($anchor, $bw) = keycommits +(git_rev_parse 'HEAD'), 0,0;
2188 print "$bw\n" or die $!;
2192 badusage "no arguments allowed" if @ARGV;
2194 # todo: gdr status should print divergence info
2195 # todo: gdr status should print upstream component(s) info
2196 # todo: gdr should leave/maintain some refs with this kind of info ?
2198 my $oldest = { Badness => 0 };
2201 my ($badness, $ourmsg, $snagname, $dummy, $cl, $kcmsg) = @_;
2202 if ($oldest->{Badness} < $badness) {
2203 $oldest = $newest = undef;
2206 Badness => $badness,
2207 CommitId => $cl->{CommitId},
2211 $newest //= $oldest;
2213 my ($anchor, $bw) = keycommits +(git_rev_parse 'HEAD'),
2214 sub { $note->(1, 'branch contains furniture (not laundered)', @_); },
2215 sub { $note->(2, 'branch is unlaundered', @_); },
2216 sub { $note->(3, 'branch needs laundering', @_); },
2217 sub { $note->(4, 'branch not in git-debrebase form', @_); };
2219 my $prcommitinfo = sub {
2221 flush STDOUT or die $!;
2222 runcmd @git, qw(--no-pager log -n1),
2223 '--pretty=format: %h %s%n',
2227 print "current branch contents, in git-debrebase terms:\n";
2228 if (!$oldest->{Badness}) {
2229 print " branch is laundered\n";
2231 print " $oldest->{OurMsg}\n";
2233 foreach my $info ($oldest, $newest) {
2234 my $cid = $info->{CommitId};
2235 next if $cid eq $printed;
2237 print " $info->{KcMsg}\n";
2238 $prcommitinfo->($cid);
2243 my ($cid, $what) = @_;
2244 if (!defined $cid) {
2245 print " $what is not well-defined\n";
2248 $prcommitinfo->($cid);
2251 print "key git-debrebase commits:\n";
2252 $prab->($anchor, 'anchor');
2253 $prab->($bw, 'breakwater');
2255 my ($ffqstatus, $ffq_msg, $current, $ffq_prev, $gdrlast) =
2256 ffq_prev_branchinfo();
2258 print "branch and ref status, in git-debrebase terms:\n";
2260 print " $ffq_msg\n";
2262 $ffq_prev = git_get_ref $ffq_prev;
2263 $gdrlast = git_get_ref $gdrlast;
2265 print " unstitched; previous tip was:\n";
2266 $prcommitinfo->($ffq_prev);
2267 } elsif (!$gdrlast) {
2268 print " stitched? (no record of git-debrebase work)\n";
2269 } elsif (is_fast_fwd $gdrlast, 'HEAD') {
2270 print " stitched\n";
2272 print " not git-debrebase (diverged since last stitch)\n"
2275 print "you are currently rebasing\n" if currently_rebasing();
2279 my $prose = 'stitch';
2280 getoptions("stitch",
2281 'prose=s', \$prose);
2282 badusage "no arguments allowed" if @ARGV;
2283 do_stitch $prose, 0;
2285 sub cmd_prepush () {
2291 badusage "no arguments allowed" if @ARGV;
2292 do_launder_head 'launder for git-debrebase quick';
2296 sub cmd_conclude () {
2297 my ($ffq_prev, $gdrlast, $ffq_prev_commitish) = ffq_prev_info();
2298 if (!$ffq_prev_commitish) {
2299 fail "No ongoing git-debrebase session." unless $opt_noop_ok;
2302 my $dangling_head = get_head();
2304 badusage "no arguments allowed" if @ARGV;
2305 do_launder_head 'launder for git-debrebase quick';
2310 if (currently_rebasing()) {
2311 runcmd @git, qw(rebase --abort);
2312 push @deferred_updates, 'verify HEAD HEAD';
2313 # noop, but stops us complaining that scrap was a noop
2315 badusage "no arguments allowed" if @ARGV;
2316 my ($ffq_prev, $gdrlast, $ffq_prev_commitish) = ffq_prev_info();
2318 if ($ffq_prev_commitish) {
2319 $scrapping_head = get_head();
2320 push @deferred_updates,
2321 "update $gdrlast $ffq_prev_commitish $git_null_obj",
2322 "update $ffq_prev $git_null_obj $ffq_prev_commitish";
2324 if (git_get_ref $merge_cache_ref) {
2325 push @deferred_updates,
2326 "delete $merge_cache_ref";
2328 if (!@deferred_updates) {
2329 fail "No ongoing git-debrebase session." unless $opt_noop_ok;
2333 if ($scrapping_head) {
2334 update_head_checkout $scrapping_head, $ffq_prev_commitish, "scrap";
2336 run_deferred_updates "scrap";
2340 sub make_patches_staged ($) {
2342 # Produces the patches that would result from $head if it were
2344 my ($secret_head, $secret_bw, $last_anchor) = walk $head;
2347 gbp_pq_export 'bw', $secret_bw, $secret_head;
2351 sub make_patches ($) {
2353 keycommits $head, 0, \&snag;
2354 make_patches_staged $head;
2357 my $ptree = cmdoutput @git, qw(write-tree --prefix=debian/patches/);
2358 runcmd @git, qw(read-tree), $head;
2359 read_tree_subdir 'debian/patches', $ptree;
2360 $out = make_commit [$head], [
2361 'Commit patch queue (exported by git-debrebase)',
2362 '[git-debrebase: export and commit patches]',
2368 sub cmd_make_patches () {
2369 my $opt_quiet_would_amend;
2370 getoptions("make-patches",
2371 'quiet-would-amend!', \$opt_quiet_would_amend);
2372 badusage "no arguments allowed" if @ARGV;
2374 my $old_head = get_head();
2375 my $new = make_patches $old_head;
2376 my $d = get_differs $old_head, $new;
2378 fail "No (more) patches to export." unless $opt_noop_ok;
2380 } elsif ($d == D_PAT_ADD) {
2382 update_head_checkout $old_head, $new, 'make-patches';
2384 print STDERR failmsg
2385 "Patch export produced patch amendments".
2386 " (abandoned output commit $new).".
2387 " Try laundering first."
2388 unless $opt_quiet_would_amend;
2393 sub check_series_has_all_patches ($) {
2395 my $seriesfn = 'debian/patches/series';
2396 my ($dummy, $series) = git_cat_file "$head:$seriesfn",
2400 foreach my $f (grep /\S/, grep {!m/^\s\#/} split /\n/, $series) {
2401 fail "patch $f repeated in $seriesfn !" if $series{$f}++;
2403 foreach my $patchfile (get_tree "$head:debian/patches", 1,1) {
2404 my ($f,$i) = @$patchfile;
2405 next if $series{$f};
2406 next if $f eq 'series';
2407 snag 'unused-patches', "Unused patch file $f will be discarded";
2411 sub cmd_convert_from_gbp () {
2412 badusage "want only 1 optional argument, the upstream git commitish"
2415 my $clogp = parsechangelog();
2416 my $version = $clogp->{'Version'}
2417 // die "missing Version from changelog";
2419 my ($upstream_spec) = @ARGV;
2421 my $upstream_version = upstreamversion $version;
2423 resolve_upstream_version($upstream_spec, $upstream_version);
2425 my $old_head = get_head();
2427 my $upsdiff = get_differs $upstream, $old_head;
2428 if ($upsdiff & D_UPS) {
2429 runcmd @git, qw(--no-pager diff --stat),
2430 $upstream, $old_head,
2431 qw( -- :!/debian :/);
2433 upstream ($upstream_spec) and HEAD are not
2434 identical in upstream files. See diffstat above, or run
2435 git diff $upstream_spec HEAD -- :!/debian :/
2439 if (!is_fast_fwd $upstream, $old_head) {
2440 snag 'upstream-not-ancestor',
2441 "upstream ($upstream) is not an ancestor of HEAD";
2443 my $wrong = cmdoutput
2444 (@git, qw(rev-list --ancestry-path), "$upstream..HEAD",
2445 qw(-- :/ :!/debian));
2446 if (length $wrong) {
2447 snag 'unexpected-upstream-changes',
2448 "history between upstream ($upstream) and HEAD contains direct changes to upstream files - are you sure this is a gbp (patches-unapplied) branch?";
2449 print STDERR "list expected changes with: git log --stat --ancestry-path $upstream_spec..HEAD -- :/ ':!/debian'\n";
2453 if ((git_cat_file "$upstream:debian")[0] ne 'missing') {
2454 snag 'upstream-has-debian',
2455 "upstream ($upstream) contains debian/ directory";
2458 check_series_has_all_patches $old_head;
2460 my $previous_dgit_view = eval {
2461 my @clogcmd = qw(dpkg-parsechangelog --format rfc822 -n2);
2463 parsechangelog_loop \@clogcmd, 'debian/changelog', sub {
2464 my ($stz, $desc) = @_;
2465 no warnings qw(exiting);
2466 printdebug 'CHANGELOG ', Dumper($desc, $stz);
2467 next unless $stz->{Date};
2468 next unless $stz->{Distribution} ne 'UNRELEASED';
2469 $lvsn = $stz->{Version};
2470 $suite = $stz->{Distribution};
2473 die "neither of the first two changelog entries are released\n"
2474 unless defined $lvsn;
2475 print "last finished-looking changelog entry: ($lvsn) $suite\n";
2476 my $mtag_pat = debiantag_maintview $lvsn, '*';
2477 my $mtag = cmdoutput @git, qw(describe --always --abbrev=0 --match),
2479 die "could not find suitable maintainer view tag $mtag_pat\n"
2480 unless $mtag_pat =~ m{/};
2481 is_fast_fwd $mtag, 'HEAD' or
2482 die "HEAD is not FF from maintainer tag $mtag!";
2483 my $dtag = "archive/$mtag";
2484 is_fast_fwd $mtag, $dtag or
2485 die "dgit view tag $dtag is not FF from maintainer tag $mtag";
2486 print "will stitch in dgit view, $dtag\n";
2487 git_rev_parse $dtag;
2489 if (!$previous_dgit_view) {
2492 print STDERR "cannot stitch in dgit view: $@\n";
2495 snags_maybe_bail_early();
2501 runcmd @git, qw(checkout -q -b gdr-internal), $old_head;
2502 # make a branch out of the patch queue - we'll want this in a mo
2503 runcmd qw(gbp pq import);
2504 # strip the patches out
2505 runcmd @git, qw(checkout -q gdr-internal~0);
2506 rm_subdir_cached 'debian/patches';
2507 $work = make_commit ['HEAD'], [
2508 'git-debrebase convert-from-gbp: drop patches from tree',
2509 'Delete debian/patches, as part of converting to git-debrebase format.',
2510 '[git-debrebase convert-from-gbp: drop patches from tree]'
2512 # make the anchor merge
2513 # the tree is already exactly right
2514 $work = make_commit [$work, $upstream], [
2515 'git-debrebase import: declare upstream',
2516 'First breakwater merge.',
2517 '[git-debrebase anchor: declare upstream]'
2520 # rebase the patch queue onto the new breakwater
2521 runcmd @git, qw(reset --quiet --hard patch-queue/gdr-internal);
2522 runcmd @git, qw(rebase --quiet --onto), $work, qw(gdr-internal);
2523 $work = git_rev_parse 'HEAD';
2525 if ($previous_dgit_view) {
2526 $work = make_commit [$work, $previous_dgit_view], [
2527 'git-debrebase import: declare ff from dgit archive view',
2528 '[git-debrebase pseudomerge: import-from-gbp]',
2535 update_head_checkout $old_head, $work, 'convert-from-gbp';
2536 print <<END or die $!;
2537 git-debrebase: converted from patched-unapplied (gbp) branch format, OK
2541 sub cmd_convert_to_gbp () {
2542 badusage "no arguments allowed" if @ARGV;
2543 my $head = get_head();
2544 my (undef, undef, undef, $ffq, $gdrlast) = ffq_prev_branchinfo();
2545 keycommits $head, 0;
2547 make_patches_staged $head;
2549 $out = make_commit ['HEAD'], [
2550 'Commit patch queue (converted from git-debrebase format)',
2551 '[git-debrebase convert-to-gbp: commit patches]',
2555 push @deferred_updates, "delete $ffq";
2556 push @deferred_updates, "delete $gdrlast";
2559 update_head_checkout $head, $out, "convert to gbp (v0)";
2560 print <<END or die $!;
2561 git-debrebase: converted to git-buildpackage branch format
2562 git-debrebase: WARNING: do not now run "git-debrebase" any more
2563 git-debrebase: WARNING: doing so would drop all upstream patches!
2567 sub cmd_convert_from_dgit_view () {
2568 my $clogp = parsechangelog();
2570 my $bpd = (cfg 'dgit.default.build-products-dir',1) // '..';
2576 getoptions("convert-from-dgit-view",
2577 'diagnose!', \$diagnose,
2578 'build-products-dir:s', \$bpd,
2579 'origs!', \$do_origs,
2581 'always-convert-anyway!', \$always);
2582 fail "takes 1 optional argument, the upstream commitish" if @ARGV>1;
2587 my $spec = shift @ARGV;
2588 my $commit = git_rev_parse "$spec^{commit}";
2589 push @upstreams, { Commit => $commit,
2590 Source => "$ARGV[0], from command line",
2595 my $head = get_head();
2599 my $trouble = sub { $troubles++; };
2600 keycommits $head, sub{}, sub{}, $trouble, $trouble;
2601 printdebug "troubles=$troubles\n";
2604 $us: Branch already seems to be in git-debrebase format!
2605 $us: --always-convert-anyway would do the conversion operation anyway
2606 $us: but is probably a bad idea. Probably, you wanted to do nothing.
2608 fail "Branch already in git-debrebase format." unless $opt_noop_ok;
2613 check_series_has_all_patches $head;
2615 snags_maybe_bail_early();
2617 my $version = upstreamversion $clogp->{Version};
2618 print STDERR "Considering possible commits corresponding to upstream:\n";
2623 my $ups_tag = upstream_commitish_search $version, \@tried;
2625 my $this = "git tag $tried[-1]";
2626 push @upstreams, { Commit => $ups_tag,
2631 " git tag: no suitable tag found (tried %s)\n",
2636 my $p = $clogp->{'Source'};
2637 # we do a quick check to see if there are plausible origs
2639 if (!opendir BPD, $bpd) {
2640 die "$bpd: opendir: $!" unless $!==ENOENT;
2642 while ($!=0, my $f = readdir BPD) {
2643 next unless is_orig_file_of_p_v $f, $p, $version;
2645 " orig: found what looks like a .orig, %s\n",
2650 die "read $bpd: $!" if $!;
2654 my $tree = cmdoutput
2655 @dgit, qw(--build-products-dir), $bpd,
2656 qw(print-unapplied-treeish);
2659 runcmd @git, qw(reset --quiet), $tree, qw(-- .);
2660 rm_subdir_cached 'debian';
2661 $tree = cmdoutput @git, qw(write-tree);
2662 my $ups_synth = make_commit [], [ <<END, <<END,
2663 Import effective orig tree for upstream version $version
2665 This includes the contents of the .orig(s), minus any debian/ directory.
2667 [git-debrebase import-from-dgit-view upstream-import-convert: $version]
2670 push @upstreams, { Commit => $ups_synth,
2671 Source => "orig(s) imported via dgit",
2676 " orig: no suitable origs found (looked for %s in %s)\n",
2677 "${p}_".(stripeoch $version)."...", $bpd;
2682 my $some_patches = stat_exists 'debian/patches/series';
2684 print STDERR "Evaluating possible commits corresponding to upstream:\n";
2687 foreach my $u (@upstreams) {
2691 runcmd @git, qw(reset --quiet), $u->{Commit}, qw(-- .);
2692 runcmd @git, qw(checkout), $u->{Commit}, qw(-- .);
2693 runcmd @git, qw(clean -xdff);
2694 runcmd @git, qw(checkout), $head, qw(-- debian);
2695 if ($some_patches) {
2696 rm_subdir_cached 'debian/patches';
2697 $work = make_commit [ $work ], [
2698 'git-debrebase convert-from-dgit-view: drop upstream changes from breakwater',
2699 "Drop upstream changes, and delete debian/patches, as part of converting\n".
2700 "to git-debrebase format. Upstream changes will appear as commits.",
2701 '[git-debrebase convert-from-dgit-view: drop patches from tree]'
2704 $work = make_commit [ $work, $u->{Commit} ], [
2705 'git-debrebase convert-from-dgit-view: declare upstream',
2706 '(Re)constructed breakwater merge.',
2707 '[git-debrebase anchor: declare upstream]'
2709 runcmd @git, qw(checkout --quiet -b mk), $work;
2710 if ($some_patches) {
2711 runcmd @git, qw(checkout), $head, qw(-- debian/patches);
2712 runcmd @git, qw(reset --quiet);
2713 my @gbp_cmd = (qw(gbp pq import));
2715 my $gbp_err = "../gbp-pq-err";
2716 @gbp_cmd = shell_cmd "exec >$gbp_err 2>&1", @gbp_cmd;
2718 my $r = system @gbp_cmd;
2721 " %s: couldn't apply patches: gbp pq %s",
2722 $u->{Source}, waitstatusmsg();
2726 my $work = git_rev_parse qw(HEAD);
2727 my $diffout = cmdoutput @git, qw(diff-tree --stat HEAD), $work;
2728 if (length $diffout) {
2730 " $u->{Source}: applying patches gives different tree\n";
2731 print STDERR $diffout if $diagnose;
2735 $u->{Result} = $work;
2743 Could not find or construct a suitable upstream commit.
2744 Rerun adding --diagnose after convert-from-dgit-view, or pass a
2745 upstream commmit explicitly or provide suitable origs.
2749 printf STDERR "Yes, will base new branch on %s\n", $result->{Source};
2751 ffq_check $result->{Result};
2753 update_head_checkout $head, $result->{Result},
2754 'convert-from-dgit-view';
2757 sub cmd_record_resolved_merge () {
2758 badusage "record-resolved-merge takes no further arguments" if @ARGV;
2759 # xxx needs documentation
2760 my $new = get_head();
2763 print "Checking how you have resolved the merge problem\n";
2764 my $nope = sub { print "Not $method: @_"; 0; };
2766 my $maybe = sub { print "Seems to be $method.\n"; };
2768 my ($key, $ref) = @_;
2769 reflog_cache_insert $merge_cache_ref, $key, $ref;
2770 print "OK. You can switch branches and try git-debrebase again.\n";
2774 fresh_workarea 'merge';
2776 $method = 'vanilla-merge patchqueue';
2777 my $vanilla = git_get_ref "$wrecknoteprefix/vanilla-merge";
2778 $vanilla or return $nope->("wreckage was not of vanilla-merge");
2779 foreach my $lr (qw(left right)) {
2780 my $n = "$wrecknoteprefix/$lr-patchqueue";
2781 my $lrpq = git_get_ref $n;
2782 $lrpq or return $nope->("wreckage did not contain patchqueues");
2783 is_fast_fwd $lrpq, $new or return $nope->("HEAD not ff of $n");
2786 my $newbase = git_get_ref "$wrecknoteprefix/new-base"
2787 or die "wreckage element $wrecknoteprefix/new-base missing";
2788 my $result = merge_series_patchqueue_convert
2790 $yes->("vanilla-merge $vanilla", $result);
2793 fail "No resolved merge method seems applicable.\n";
2797 sub cmd_downstream_rebase_launder_v0 () {
2798 badusage "needs 1 argument, the baseline" unless @ARGV==1;
2800 $base = git_rev_parse $base;
2801 my $old_head = get_head();
2802 my $current = $old_head;
2805 if ($current eq $base) {
2806 $topmost_keep //= $current;
2807 print " $current BASE stop\n";
2810 my $cl = classify $current;
2811 print " $current $cl->{Type}";
2813 my $p0 = $cl->{Parents}[0]{CommitId};
2815 if ($cl->{Type} eq 'Pseudomerge') {
2816 print " ^".($cl->{Contributor}{Ix}+1);
2817 $next = $cl->{Contributor}{CommitId};
2818 } elsif ($cl->{Type} eq 'AddPatches' or
2819 $cl->{Type} eq 'Changelog') {
2829 $topmost_keep //= $current;
2831 die "to-be stripped changes not on top of the branch\n"
2836 if ($topmost_keep eq $old_head) {
2837 print "unchanged\n";
2839 print "updating to $topmost_keep\n";
2840 update_head_checkout
2841 $old_head, $topmost_keep,
2842 'downstream-rebase-launder-v0';
2848 "D+" => \$debuglevel,
2849 'noop-ok', => \$opt_noop_ok,
2850 'f=s' => \@snag_force_opts,
2851 'anchor=s' => \@opt_anchors,
2852 '--dgit=s' => \($dgit[0]),
2855 my ($opt,$val) = @_;
2856 badusage "git-debrebase: no cuddling to -i for git-rebase"
2858 die if $opt_defaultcmd_interactive; # should not happen
2859 $opt_defaultcmd_interactive = [ qw(-i) ];
2860 # This access to @ARGV is excessive familiarity with
2861 # Getopt::Long, but there isn't another sensible
2862 # approach. '-i=s{0,}' does not work with bundling.
2863 push @$opt_defaultcmd_interactive, @ARGV;
2866 'help' => sub { print $usage_message or die $!; finish 0; },
2869 initdebug('git-debrebase ');
2870 enabledebug if $debuglevel;
2872 my $toplevel = cmdoutput @git, qw(rev-parse --show-toplevel);
2873 chdir $toplevel or die "chdir $toplevel: $!";
2875 $rd = fresh_playground "$playprefix/misc";
2877 @opt_anchors = map { git_rev_parse $_ } @opt_anchors;
2879 if (!@ARGV || $opt_defaultcmd_interactive || $ARGV[0] =~ m{^-}) {
2880 defaultcmd_rebase();
2882 my $cmd = shift @ARGV;
2885 $cmdfn = ${*::}{"cmd_$cmdfn"};
2887 $cmdfn or badusage "unknown git-debrebase sub-operation $cmd";