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_noop_ok, @opt_anchors);
54 our ($opt_defaultcmd_interactive);
56 our $us = qw(git-debrebase);
58 our $wrecknoteprefix = 'refs/debrebase/wreckage';
64 print STDERR "$us: bad usage: $m\n";
70 local $SIG{__WARN__}; # GetOptions calls `warn' to print messages
71 GetOptions @_ or badusage $m;
75 getoptions_main "bad options follow \`git-debrebase $sc'", @_;
79 my ($k, $optional) = @_;
81 my @cmd = qw(git config -z);
82 push @cmd, qw(--get-all) if wantarray;
84 my $out = cmdoutput_errok @cmd;
86 fail "missing required git config $k" unless $optional;
89 my @l = split /\0/, $out;
90 return wantarray ? @l : $l[0];
97 my $dd = new Data::Dumper [ $v ];
98 Terse $dd 1; Indent $dd 0; Useqq $dd 1;
104 my $data = (git_cat_file $objid, 'commit');
105 $data =~ m/(?<=\n)\n/ or die "$objid ($data) ?";
109 sub D_UPS () { 0x02; } # upstream files
110 sub D_PAT_ADD () { 0x04; } # debian/patches/ extra patches at end
111 sub D_PAT_OTH () { 0x08; } # debian/patches other changes
112 sub D_DEB_CLOG () { 0x10; } # debian/ (not patches/ or changelog)
113 sub D_DEB_OTH () { 0x20; } # debian/changelog
114 sub DS_DEB () { D_DEB_CLOG | D_DEB_OTH; } # debian/ (not patches/)
116 our $playprefix = 'debrebase';
121 our @dgit = qw(dgit);
123 sub in_workarea ($) {
126 my $r = eval { $sub->(); };
127 { local $@; changedir $maindir; }
131 sub fresh_workarea (;$) {
134 $workarea = fresh_playground "$playprefix/$subdir";
135 in_workarea sub { playtree_setup };
138 sub run_ref_updates_now ($$) {
139 my ($mrest, $updates) = @_;
140 # @$updates is a list of lines for git-update-ref, without \ns
142 my @upd_cmd = (git_update_ref_cmd "debrebase: $mrest", qw(--stdin));
143 debugcmd '>|', @upd_cmd;
144 open U, "|-", @upd_cmd or die $!;
145 foreach (@$updates) {
146 printdebug ">= ", $_, "\n";
147 print U $_, "\n" or die $!;
150 close U or failedcmd @upd_cmd;
153 our $snags_forced = 0;
154 our $snags_tripped = 0;
155 our $snags_summarised = 0;
156 our @deferred_updates;
157 our @deferred_update_messages;
159 sub merge_wreckage_cleaning ($) {
161 git_for_each_ref("$wrecknoteprefix/*", sub {
162 my ($objid,$objtype,$fullrefname,$reftail) = @_;
163 push @$updates, "delete $fullrefname";
167 sub all_snags_summarised () {
168 $snags_forced + $snags_tripped == $snags_summarised;
170 sub run_deferred_updates ($) {
173 confess 'dangerous internal error' unless all_snags_summarised();
175 merge_wreckage_cleaning \@deferred_updates;
176 run_ref_updates_now $mrest, \@deferred_updates;
177 print $_, "\n" foreach @deferred_update_messages;
179 @deferred_updates = ();
180 @deferred_update_messages = ();
183 sub get_differs ($$) {
185 # This resembles quiltify_trees_differ, in dgit, a bit.
186 # But we don't care about modes, or dpkg-source-unrepresentable
187 # changes, and we don't need the plethora of different modes.
188 # Conversely we need to distinguish different kinds of changes to
189 # debian/ and debian/patches/.
194 my ($opts, $limits, $fn) = @_;
195 my @cmd = (@git, qw(diff-tree -z --no-renames));
197 push @cmd, "$_:" foreach $x, $y;
198 push @cmd, '--', @$limits;
199 my $diffs = cmdoutput @cmd;
200 foreach (split /\0/, $diffs) { $fn->(); }
203 $rundiff->([qw(--name-only)], [], sub {
204 $differs |= $_ eq 'debian' ? DS_DEB : D_UPS;
207 if ($differs & DS_DEB) {
209 $rundiff->([qw(--name-only -r)], [qw(debian)], sub {
211 m{^debian/patches/} ? D_PAT_OTH :
212 $_ eq 'debian/changelog' ? D_DEB_CLOG :
215 die "mysterious debian changes $x..$y"
216 unless $differs & (D_PAT_OTH|DS_DEB);
219 if ($differs & D_PAT_OTH) {
221 $differs &= ~D_PAT_OTH;
223 $differs |= D_PAT_OTH;
224 no warnings qw(exiting); last;
226 $rundiff->([qw(--name-status -r)], [qw(debian/patches/)], sub {
227 no warnings qw(exiting);
228 if (!defined $mode) {
231 die unless s{^debian/patches/}{};
233 if ($mode eq 'A' && !m/\.series$/s) {
235 } elsif ($mode eq 'M' && $_ eq 'series') {
236 my $x_s = (git_cat_file "$x:debian/patches/series", 'blob');
237 my $y_s = (git_cat_file "$y:debian/patches/series", 'blob');
238 chomp $x_s; $x_s .= "\n";
239 $ok = $x_s eq substr($y_s, 0, length $x_s);
244 $differs |= $ok ? D_PAT_ADD : D_PAT_OTH;
246 die "mysterious debian/patches changes $x..$y"
247 unless $differs & (D_PAT_ADD|D_PAT_OTH);
250 printdebug sprintf "get_differs %s %s = %#x\n", $x, $y, $differs;
255 sub commit_pr_info ($) {
257 return Data::Dumper->dump([$r], [qw(commit)]);
260 sub calculate_committer_authline () {
261 my $c = cmdoutput @git, qw(commit-tree --no-gpg-sign -m),
262 'DUMMY COMMIT (git-debrebase)', "HEAD:";
263 my ($h,$m) = get_commit $c;
264 $h =~ m/^committer .*$/m or confess "($h) ?";
268 sub rm_subdir_cached ($) {
270 runcmd @git, qw(rm --quiet -rf --cached --ignore-unmatch), $subdir;
273 sub read_tree_subdir ($$) {
274 my ($subdir, $new_tree_object) = @_;
275 rm_subdir_cached $subdir;
276 runcmd @git, qw(read-tree), "--prefix=$subdir/", $new_tree_object;
279 sub read_tree_debian ($) {
281 read_tree_subdir 'debian', "$treeish:debian";
282 rm_subdir_cached 'debian/patches';
285 sub read_tree_upstream ($;$$) {
286 my ($treeish, $keep_patches, $tree_with_debian) = @_;
287 # if $tree_with_debian is supplied, will use that for debian/
288 # otherwise will save and restore it.
290 $tree_with_debian ? "$tree_with_debian:debian"
291 : cmdoutput @git, qw(write-tree --prefix=debian/);
292 runcmd @git, qw(read-tree), $treeish;
293 read_tree_subdir 'debian', $debian;
294 rm_subdir_cached 'debian/patches' unless $keep_patches;
297 sub make_commit ($$) {
298 my ($parents, $message_paras) = @_;
299 my $tree = cmdoutput @git, qw(write-tree);
300 my @cmd = (@git, qw(commit-tree), $tree);
301 push @cmd, qw(-p), $_ foreach @$parents;
302 push @cmd, qw(-m), $_ foreach @$message_paras;
303 return cmdoutput @cmd;
306 our @snag_force_opts;
308 my ($tag,$msg) = @_; # ignores extra args, for benefit of keycommits
309 if (grep { $_ eq $tag } @snag_force_opts) {
311 print STDERR "git-debrebase: snag ignored (-f$tag): $msg\n";
314 print STDERR "git-debrebase: snag detected (-f$tag): $msg\n";
318 # Important: all mainline code must call snags_maybe_bail after
319 # any point where snag might be called, but before making changes
320 # (eg before any call to run_deferred_updates). snags_maybe_bail
321 # may be called more than once if necessary (but this is not ideal
322 # because then the messages about number of snags may be confusing).
323 sub snags_maybe_bail () {
324 return if all_snags_summarised();
327 "%s: snags: %d overriden by individual -f options\n",
330 if ($snags_tripped) {
333 "%s: snags: %d overriden by global --force\n",
337 "%s: snags: %d blocker(s) (you could -f<tag>, or --force)",
341 $snags_summarised = $snags_forced + $snags_tripped;
343 sub snags_maybe_bail_early () {
344 # useful to bail out early without doing a lot of work;
345 # not a substitute for snags_maybe_bail.
346 snags_maybe_bail() if $snags_tripped && !$opt_force;
349 return $snags_forced || $snags_tripped;
352 sub gbp_pq_export ($$$) {
353 my ($bname, $base, $tip) = @_;
354 # must be run in a workarea. $bname and patch-queue/$bname
355 # ought not to exist. Leaves you on patch-queue/$bname with
356 # the patches staged but not committed.
357 printdebug "gbp_pq_export $bname $base $tip\n";
358 runcmd @git, qw(checkout -q -b), $bname, $base;
359 runcmd @git, qw(checkout -q -b), "patch-queue/$bname", $tip;
360 my @gbp_cmd = (qw(gbp pq export));
361 my $r = system shell_cmd 'exec >../gbp-pq-err 2>&1', @gbp_cmd;
363 { local ($!,$?); copy('../gbp-pq-err', \*STDERR); }
366 runcmd @git, qw(add -f debian/patches) if stat_exists 'debian/patches';
370 # xxx allow merge resolution separately from laundering, before git merge
372 # xxx general gdr docs highlight forbidden things
373 # xxx general gdr docs list allowable things ?
374 # xxx general gdr docs explicitly forbid some rebase
376 # xxx provide a way for the user to help
377 # xxx (eg, provide wreckage provide way to continue)
380 # use git-format-patch?
381 # our own patch identification algorithm?
382 # this is an alternative strategy
384 sub merge_failed ($$;@) {
385 my ($wrecknotes, $emsg, @xmsgs) = @_;
387 push @m, "Merge resolution failed: $emsg";
393 merge_wreckage_cleaning \@updates;
394 run_ref_updates_now "merge failed", \@updates;
398 while (my ($k,$v) = each %$wrecknotes) {
399 push @updates, "create $wrecknoteprefix/$k $v";
401 run_ref_updates_now "merge failed", \@updates;
402 push @m, "Wreckage left in $wrecknoteprefix/*.";
404 push @m, "See git-debrebase(1) section FAILED MERGES for suggestions.";
406 # use finish rather than fail, in case we are within an eval
407 # (that can happen inside walk!)
409 print STDERR "$us: $_\n" foreach @m;
413 sub mwrecknote ($$$) {
414 my ($wrecknotes, $reftail, $commitish) = @_;
415 confess unless defined $commitish;
416 printdebug "mwrecknote $reftail $commitish\n";
417 $wrecknotes->{$reftail} = $commitish;
420 sub merge_attempt_cmd {
421 my $wrecknotes = shift @_;
425 merge_failed $wrecknotes,
426 failedcmd_waitstatus(),
427 "failed command: @_";
431 sub merge_series_patchqueue_convert ($$$);
433 sub merge_series ($$$;@) {
434 my ($newbase, $wrecknotes, $base_q, @input_qs) = @_;
435 # $base_q{SeriesBase} $input_qs[]{SeriesBase}
436 # $base_q{SeriesTip} $input_qs[]{SeriesTip}
437 # ^ specifies several patch series (currently we only support exactly 2)
438 # return value is a commit which is the result of
439 # merging the two versions of the same topic branch
440 # $input_q[0] and $input_q[1]
441 # with respect to the old version
445 # Creates, in *_q, a key MR for its private use
447 printdebug "merge_series newbase=$newbase\n";
449 $input_qs[$_]{MR}{S} = $_ foreach (0..$#input_qs);
450 $base_q->{MR}{S} = 'base';
453 # $prereq{<patch filename>}{<possible prereq}{<S>} = 1 or absent
454 # $prereq{<patch filename>}{<possible prereq} exists or not (later)
455 # $prereq{<patch filename>} exists or not (even later)
459 my $mwrecknote = sub { &mwrecknote($wrecknotes, @_); };
461 my $attempt_cmd = sub { &merge_attempt_cmd($wrecknotes, @_); };
464 fresh_workarea "merge";
465 my $seriesfile = "debian/patches/series";
468 foreach my $q ($base_q, reverse @input_qs) {
470 gbp_pq_export "p-$s", $q->{SeriesBase}, $q->{SeriesTip};
472 if (open S, $seriesfile) {
473 while (my $patch = <S>) {
474 chomp $patch or die $!;
475 $prereq{$patch} //= {};
476 foreach my $earlier (@earlier) {
477 $prereq{$patch}{$earlier}{$s}++ and die;
479 push @earlier, $patch;
480 stat "debian/patches/$patch" or die "$patch ?";
482 S->error and die "$seriesfile $!";
485 die "$seriesfile $!" unless $!==ENOENT;
487 read_tree_upstream $newbase, 1;
488 my $pec = make_commit [ grep { defined } $base_q->{MR}{PEC} ], [
489 "Convert $s to patch queue for merging",
490 "[git-debrebase merge-innards patch-queue import:".
493 printdebug "merge_series pec $pec ";
494 runcmd @git, qw(rm -q --ignore-unmatch --cached), $seriesfile;
495 $pec = make_commit [ $pec ], [
496 "Drop series file from $s to avoid merge trouble",
497 "[git-debrebase merge-innards patch-queue prep:".
501 read_tree_debian $newbase;
503 read_tree_subdir 'debian/patches', "$pec:debian/patches";
505 rm_subdir_cached 'debian/patches';
507 $pec = make_commit [ $pec ], [
508 "Update debian/ (excluding patches) to final to avoid re-merging",
509 "debian/ was already merged and we need to just take that.",
510 "[git-debrebase merge-innards patch-queue packaging:".
514 printdebug "pec' $pec\n";
515 runcmd @git, qw(reset -q --hard), $pec;
516 $q->{MR}{PEC} = $pec;
517 $mwrecknote->("$q->{LeftRight}-patchqueue", $pec);
519 # now, because of reverse, we are on $input_q->{MR}{OQC}
520 runcmd @git, qw(checkout -q -b merge);
521 printdebug "merge_series merging...\n";
522 my @mergecmd = (@git, qw(merge --quiet --no-edit), "p-1");
524 $attempt_cmd->(@mergecmd);
526 printdebug "merge_series merge ok, series...\n";
527 # We need to construct a new series file
528 # Firstly, resolve prereq
529 foreach my $f (sort keys %prereq) {
530 printdebug "merge_series patch\t$f\t";
531 if (!stat_exists "debian/patches/$f") {
532 print DEBUG " drop\n" if $debuglevel;
533 # git merge deleted it; that's how we tell it's not wanted
537 print DEBUG " keep\n" if $debuglevel;
538 foreach my $g (sort keys %{ $prereq{$f} }) {
539 my $gfp = $prereq{$f}{$g};
540 printdebug "merge_series prereq\t$f\t-> $g\t";
541 if (!!$gfp->{0} == !!$gfp->{1}
544 print DEBUG "\tkeep\n" if $debuglevel;
546 print DEBUG "\tdrop\n" if $debuglevel;
547 delete $prereq{$f}{$g};
554 return scalar keys %{ $prereq{$f} };
557 my $nodate = time + 1;
559 # $authordate{<patch filename>};
560 my $authordate = sub {
562 $authordate{$f} //= do {
563 open PF, "<", "debian/patches/$f" or die "$f $!";
565 return $nodate if m/^$/;
566 last if s{^Date: }{};
569 return cmdoutput qw(date +%s -d), $_;
573 open NS, '>', $seriesfile or die $!;
575 while (keys %prereq) {
577 foreach my $try (sort keys %prereq) {
580 $unsat->($try) <=> $unsat->($best) or
581 $authordate->($try) <=> $authordate->($best) or
587 printdebug "merge_series series next $best\n";
588 print NS "$best\n" or die $!;
589 delete $prereq{$best};
590 foreach my $gp (values %prereq) {
595 runcmd @git, qw(add), $seriesfile;
596 runcmd @git, qw(commit --quiet -m), 'Merged patch queue form';
597 $merged_pq = git_rev_parse 'HEAD';
598 $mwrecknote->('merged-patchqueue', $merged_pq);
600 return merge_series_patchqueue_convert
601 $wrecknotes, $newbase, $merged_pq;
604 sub merge_series_patchqueue_convert ($$$) {
605 my ($wrecknotes, $newbase, $merged_pq) = @_;
610 printdebug "merge_series series gbp pq import\n";
611 runcmd @git, qw(checkout -q -b mergec), $merged_pq;
613 merge_attempt_cmd($wrecknotes, qw(gbp pq import));
615 # OK now we are on patch-queue/merge, and we need to rebase
616 # onto the intended parent and drop the patches from each one
618 printdebug "merge_series series ok, building...\n";
619 my $build = $newbase;
620 my @lcmd = (@git, qw(rev-list --reverse mergec..patch-queue/mergec));
621 foreach my $c (grep /./, split /\n/, cmdoutput @lcmd) {
622 my $commit = git_cat_file $c, 'commit';
623 printdebug "merge_series series ok, building $c\n";
624 read_tree_upstream $c, 0, $newbase;
625 my $tree = cmdoutput @git, qw(write-tree);
626 $commit =~ s{^parent (\S+)$}{parent $build}m or confess;
627 $commit =~ s{^tree (\S+)$}{tree $tree}m or confess;
628 open C, ">", "../mcommit" or die $!;
629 print C $commit or die $!;
631 $build = cmdoutput @git, qw(hash-object -w -t commit ../mcommit);
634 mwrecknote($wrecknotes, 'merged-result', $result);
636 runcmd @git, qw(update-ref refs/heads/result), $result;
638 runcmd @git, qw(checkout -q -b debug);
639 runcmd @git, qw(commit --allow-empty -q -m M-INDEX);
640 runcmd @git, qw(add .);
641 runcmd @git, qw(commit --allow-empty -q -m M-WORKTREE);
642 my $mdebug = git_rev_parse 'HEAD';
643 printdebug sprintf "merge_series done debug=%s\n", $mdebug;
644 mwrecknote($wrecknotes, 'merged-debug', $mdebug);
646 printdebug "merge_series returns $result\n";
650 # classify returns an info hash like this
652 # Hdr => # commit headers, including 1 final newline
653 # Msg => # commit message (so one newline is dropped)
655 # Type => (see below)
657 # Ix => $index # ie 0, 1, 2, ...
659 # Differs => return value from get_differs
661 # IsDggitImport => 'orig' 'tarball' 'unpatched' 'package' (as from dgit)
663 # NewMsg => # commit message, but with any [dgit import ...] edited
664 # # to say "[was: ...]"
674 # has additional entres in classification result
675 # Overwritten = [ subset of Parents ]
676 # Contributor = $the_remaining_Parent
678 # DgitImportUnpatched
679 # has additional entry in classification result
680 # OrigParents = [ subset of Parents ]
683 # has additional entry in classification result
684 # OrigParents = [ subset of Parents ] # singleton list
691 # has additional entry in classification result
694 sub parsecommit ($;$) {
695 my ($objid, $p_ref) = @_;
696 # => hash with CommitId Hdr Msg Tree Parents
697 # Parents entries have only Ix CommitId
698 # $p_ref, if provided, must be [] and is used as a base for Parents
703 my ($h,$m) = get_commit $objid;
705 my ($t) = $h =~ m/^tree (\w+)$/m or die $objid;
706 my (@ph) = $h =~ m/^parent (\w+)$/mg;
716 foreach my $ph (@ph) {
718 Ix => scalar @$p_ref,
730 my $r = parsecommit($objid, \@p);
734 $p->{Differs} = (get_differs $p->{CommitId}, $t),
737 printdebug "classify $objid \$t=$t \@p",
738 (map { sprintf " %s/%#x", $_->{CommitId}, $_->{Differs} } @p),
742 my ($type, @rest) = @_;
743 $r = { %$r, Type => $type, @rest };
745 printdebug " = $type ".(dd $r)."\n";
751 $r = { %$r, Type => qw(Unknown), Why => $why };
752 printdebug " ** Unknown\n";
756 if (grep { $_ eq $objid } @opt_anchors) {
757 return $classify->('TreatAsAnchor');
760 my @identical = grep { !$_->{Differs} } @p;
761 my ($stype, $series) = git_cat_file "$t:debian/patches/series";
762 my $haspatches = $stype ne 'missing' && $series =~ m/^\s*[^#\n\t ]/m;
764 if ($r->{Msg} =~ m{^\[git-debrebase anchor.*\]$}m) {
765 # multi-orig upstreams are represented with an anchor merge
766 # from a single upstream commit which combines the orig tarballs
768 # Every anchor tagged this way must be a merge.
769 # We are relying on the
770 # [git-debrebase anchor: ...]
771 # commit message annotation in "declare" anchor merges (which
772 # do not have any upstream changes), to distinguish those
773 # anchor merges from ordinary pseudomerges (which we might
774 # just try to strip).
776 # However, the user is going to be doing git-rebase a lot. We
777 # really don't want them to rewrite an anchor commit.
778 # git-rebase trips up on merges, so that is a useful safety
781 # BreakwaterStart commits are also anchors in the terminology
782 # of git-debrebase(5), but they are untagged (and always
783 # manually generated).
785 # We cannot not tolerate any tagged linear commit (ie,
786 # BreakwaterStart commits tagged `[anchor:') because such a
787 # thing could result from an erroneous linearising raw git
788 # rebase of a merge anchor. That would represent a corruption
789 # of the branch. and we want to detect and reject the results
790 # of such corruption before it makes it out anywhere. If we
791 # reject it here then we avoid making the pseudomerge which
792 # would be needed to push it.
794 my $badanchor = sub { $unknown->("git-debrebase \`anchor' but @_"); };
795 @p == 2 or return $badanchor->("has other than two parents");
796 $haspatches and return $badanchor->("contains debian/patches");
798 # How to decide about l/r ordering of anchors ? git
799 # --topo-order prefers to expand 2nd parent first. There's
800 # already an easy rune to look for debian/ history anyway (git log
801 # debian/) so debian breakwater branch should be 1st parent; that
802 # way also there's also an easy rune to look for the upstream
803 # patches (--topo-order).
805 # Also this makes --first-parent be slightly more likely to
806 # be useful - it makes it provide a linearised breakwater history.
808 # Of course one can say somthing like
809 # gitk -- ':/' ':!/debian'
810 # to get _just_ the commits touching upstream files, and by
811 # the TREESAME logic in git-rev-list this will leave the
812 # breakwater into upstream at the first anchor. But that
813 # doesn't report debian/ changes at all.
815 # Other observations about gitk: by default, gitk seems to
816 # produce output in a different order to git-rev-list. I
817 # can't seem to find this documented anywhere. gitk
818 # --date-order DTRT. But, gitk always seems to put the
819 # parents from left to right, in order, so it's easy to see
820 # which way round a pseudomerge is.
822 $p[0]{IsOrigin} and $badanchor->("is an origin commit");
823 $p[1]{Differs} & ~DS_DEB and
824 $badanchor->("upstream files differ from left parent");
825 $p[0]{Differs} & ~D_UPS and
826 $badanchor->("debian/ differs from right parent");
828 return $classify->(qw(Anchor),
829 OrigParents => [ $p[1] ]);
833 my $d = $r->{Parents}[0]{Differs};
834 if ($d == D_PAT_ADD) {
835 return $classify->(qw(AddPatches));
836 } elsif ($d & (D_PAT_ADD|D_PAT_OTH)) {
837 return $unknown->("edits debian/patches");
838 } elsif ($d & DS_DEB and !($d & ~DS_DEB)) {
839 my ($ty,$dummy) = git_cat_file "$p[0]{CommitId}:debian";
841 if ($d == D_DEB_CLOG) {
842 return $classify->(qw(Changelog));
844 return $classify->(qw(Packaging));
846 } elsif ($ty eq 'missing') {
847 return $classify->(qw(BreakwaterStart));
849 return $unknown->("parent's debian is not a directory");
851 } elsif ($d == D_UPS) {
852 return $classify->(qw(Upstream));
853 } elsif ($d & DS_DEB and $d & D_UPS and !($d & ~(DS_DEB|D_UPS))) {
854 return $classify->(qw(Mixed));
856 return $unknown->("no changes");
858 confess "internal error $objid ?";
862 return $unknown->("origin commit");
865 if (@p == 2 && @identical == 1) {
866 my @overwritten = grep { $_->{Differs} } @p;
867 confess "internal error $objid ?" unless @overwritten==1;
868 return $classify->(qw(Pseudomerge),
869 Overwritten => [ $overwritten[0] ],
870 Contributor => $identical[0]);
872 if (@p == 2 && @identical == 2) {
874 my ($ph,$pm) = get_commit $_[0]{CommitId};
875 $ph =~ m/^committer .* (\d+) [-+]\d+$/m or die "$_->{CommitId} ?";
879 my $order = $get_t->($bytime[0]) <=> $get_t->($bytime[1]);
880 if ($order > 0) { # newer first
881 } elsif ($order < 0) {
882 @bytime = reverse @bytime;
884 # same age, default to order made by -s ours
885 # that is, commit was made by someone who preferred L
887 return $classify->(qw(Pseudomerge),
888 SubType => qw(Ambiguous),
889 Contributor => $bytime[0],
890 Overwritten => [ $bytime[1] ]);
893 my ($p_h, $p_m) = get_commit $p->{CommitId};
894 $p->{IsOrigin} = $p_h !~ m/^parent \w+$/m;
895 ($p->{IsDgitImport},) = $p_m =~ m/^\[dgit import ([0-9a-z]+) .*\]$/m;
897 my @orig_ps = grep { ($_->{IsDgitImport}//'X') eq 'orig' } @p;
899 if (!(grep { !$_->{IsOrigin} } @p) and
900 (@orig_ps >= @p - 1) and
901 $m2 =~ s{^\[(dgit import unpatched .*)\]$}{[was: $1]}m) {
903 return $classify->(qw(DgitImportUnpatched),
904 OrigParents => \@orig_ps);
908 $r->{Msg} =~ m{^\[git-debrebase merged-breakwater.*\]$}m) {
909 # xxx ^ metadata tag needs adding to (5)
910 return $classify->("MergedBreakwaters");
912 if ($r->{Msg} =~ m{^\[(git-debrebase|dgit)[: ].*\]$}m) {
913 return $unknown->("unknown kind of merge from $1");
916 return $unknown->("octopus merge");
919 if (!$ENV{GIT_DEBREBASE_EXPERIMENTAL_MERGE}) {
920 return $unknown->("general two-parent merge");
923 return $classify->("VanillaMerge");
926 sub keycommits ($;$$$$$);
928 sub mergedbreakwaters_anchor ($) {
931 foreach my $p (@{ $cl->{Parents} }) {
932 my ($panchor, $pbw) = keycommits $p->{CommitId},
933 undef,undef,undef,undef, 1;
934 $best_anchor = $panchor
935 if !defined $best_anchor
936 or is_fast_fwd $best_anchor, $panchor;
937 fail "inconsistent anchors in merged-breakwaters $p->{CommitId}"
938 unless is_fast_fwd $panchor, $best_anchor;
943 sub keycommits ($;$$$$$) {
944 my ($head, $furniture, $unclean, $trouble, $fatal, $claimed_bw) = @_;
945 # => ($anchor, $breakwater)
947 # $unclean->("unclean-$tagsfx", $msg, $cl)
948 # $furniture->("unclean-$tagsfx", $msg, $cl)
949 # $dgitimport->("unclean-$tagsfx", $msg, $cl))
950 # is callled for each situation or commit that
951 # wouldn't be found in a laundered branch
952 # $furniture is for furniture commits such as might be found on an
953 # interchange branch (pseudomerge, d/patches, changelog)
954 # $trouble is for things whnich prevent the return of
955 # anchor and breakwater information; if that is ignored,
956 # then keycommits returns (undef, undef) instead.
957 # $fatal is for unprocessable commits, and should normally cause
958 # a failure. If ignored, agaion, (undef, undef) is returned.
960 # If $claimed_bw, this is supposed to be a breakwater commit.
962 # If a callback is undef, fail is called instead.
963 # If a callback is defined but false, the situation is ignored.
965 # no warnings qw(exiting); last;
966 # if the answer is no longer wanted.
968 my ($anchor, $breakwater);
969 $breakwater = $head if $claimed_bw;
973 $fatal //= sub { fail $_[1]; };
975 my ($cb, $tagsfx, $mainwhy, $xwhy) = @_;
976 my $why = $mainwhy.$xwhy;
977 my $m = "branch needs laundering (run git-debrebase): $why";
978 fail $m unless defined $cb;
980 $cb->("unclean-$tagsfx", $why, $cl, $mainwhy);
982 my $found_anchor = sub {
984 $breakwater //= $clogonly;
985 $breakwater //= $head;
986 no warnings qw(exiting);
990 $cl = classify $head;
991 my $ty = $cl->{Type};
992 if ($ty eq 'Packaging') {
993 $breakwater //= $clogonly;
994 $breakwater //= $head;
995 } elsif ($ty eq 'Changelog') {
996 # this is going to count as the tip of the breakwater
997 # only if it has no upstream stuff before it
999 } elsif ($ty eq 'Anchor' or
1000 $ty eq 'TreatAsAnchor' or
1001 $ty eq 'BreakwaterStart') {
1002 $found_anchor->($head);
1003 } elsif ($ty eq 'Upstream') {
1004 $x->($unclean, 'ordering',
1005 "packaging change ($breakwater) follows upstream change"," (eg $head)")
1006 if defined $breakwater;
1008 $breakwater = undef;
1009 } elsif ($ty eq 'Mixed') {
1010 $x->($unclean, 'mixed',
1011 "found mixed upstream/packaging commit"," ($head)");
1013 $breakwater = undef;
1014 } elsif ($ty eq 'Pseudomerge' or
1015 $ty eq 'AddPatches') {
1017 $x->($furniture, (lc $ty),
1018 "found interchange bureaucracy commit ($ty)"," ($head)");
1019 } elsif ($ty eq 'DgitImportUnpatched') {
1021 $x->($trouble, 'dgitimport',
1022 "found dgit dsc import"," ($head)");
1023 return (undef,undef);
1025 $x->($fatal, 'unprocessable',
1026 "found bare dgit dsc import with no prior history",
1028 return (undef,undef);
1030 } elsif ($ty eq 'VanillaMerge') {
1031 $x->($trouble, 'vanillamerge',
1032 "found vanilla merge"," ($head)");
1033 return (undef,undef);
1034 } elsif ($ty eq 'MergedBreakwaters') {
1035 $found_anchor->(mergedbreakwaters_anchor $cl);
1037 $x->($fatal, 'unprocessable',
1038 "found unprocessable commit, cannot cope: $cl->{Why}",
1040 return (undef,undef);
1042 $head = $cl->{Parents}[0]{CommitId};
1044 return ($anchor, $breakwater);
1050 $nogenerate,$report, $report_lprefix) = @_;
1051 # => ($tip, $breakwater_tip, $last_anchor)
1052 # (or nothing, if $nogenerate)
1054 printdebug "*** WALK $input ".($nogenerate//0)." ".($report//'-')."\n";
1055 $report_lprefix //= '';
1057 # go through commits backwards
1058 # we generate two lists of commits to apply:
1059 # breakwater branch and upstream patches
1060 my (@brw_cl, @upp_cl, @processed);
1067 my ($prose, $info) = @_;
1068 my $ms = $cl->{Msg};
1071 $ms .= "\n\n[git-debrebase$info: $prose]\n";
1072 return (Msg => $ms);
1074 my $rewrite_from_here = sub {
1076 my $sp_cl = { SpecialMethod => 'StartRewrite' };
1078 push @processed, $sp_cl;
1083 my $prprdelim = sub { print $report $prdelim if $report; $prdelim=""; };
1086 return unless $report;
1087 print $report $prdelim, $report_lprefix, @_;
1091 my $bomb = sub { # usage: return $bomb->();
1092 print $report " Unprocessable" if $report;
1093 print $report " ($cl->{Why})" if $report && defined $cl->{Why};
1096 return (undef,undef);
1098 fail "found unprocessable commit, cannot cope".
1099 (defined $cl->{Why} ? "; $cl->{Why}:": ':').
1100 " (commit $cur) (d.".
1101 (join ' ', map { sprintf "%#x", $_->{Differs} }
1102 @{ $cl->{Parents} }).
1109 my $build_start = sub {
1110 my ($msg, $parent) = @_;
1113 no warnings qw(exiting); last;
1118 merge_failed $cl->{MergeWreckNotes}, $emsg;
1121 my $mwrecknote = sub { &mwrecknote($cl->{MergeWreckNotes}, @_); };
1126 $cl = classify $cur;
1127 $cl->{MergeWreckNotes} //= {};
1128 my $ty = $cl->{Type};
1129 my $st = $cl->{SubType};
1130 $prline->("$cl->{CommitId} $cl->{Type}");
1131 $found{$ty. ( defined($st) ? "-$st" : '' )}++;
1132 push @processed, $cl;
1133 my $p0 = @{ $cl->{Parents} }==1 ? $cl->{Parents}[0]{CommitId} : undef;
1134 if ($ty eq 'AddPatches') {
1136 $rewrite_from_here->(\@upp_cl);
1138 } elsif ($ty eq 'Packaging' or $ty eq 'Changelog') {
1142 } elsif ($ty eq 'BreakwaterStart') {
1143 $last_anchor = $cur;
1144 $build_start->('FirstPackaging', $cur);
1145 } elsif ($ty eq 'Upstream') {
1149 } elsif ($ty eq 'Mixed') {
1152 my $cls = { %$cl, $xmsg->("split mixed commit: $wh part") };
1155 $queue->(\@brw_cl, "debian");
1156 $queue->(\@upp_cl, "upstream");
1157 $rewrite_from_here->(\@brw_cl);
1160 } elsif ($ty eq 'Pseudomerge') {
1161 my $contrib = $cl->{Contributor}{CommitId};
1162 print $report " Contributor=$contrib" if $report;
1163 push @pseudomerges, $cl;
1164 $rewrite_from_here->(\@upp_cl);
1167 } elsif ($ty eq 'Anchor' or $ty eq 'TreatAsAnchor') {
1168 $last_anchor = $cur;
1169 $build_start->("Anchor", $cur);
1170 } elsif ($ty eq 'DgitImportUnpatched') {
1171 my $pm = $pseudomerges[-1];
1173 # To an extent, this is heuristic. Imports don't have
1174 # a useful history of the debian/ branch. We assume
1175 # that the first pseudomerge after an import has a
1176 # useful history of debian/, and ignore the histories
1177 # from later pseudomerges. Often the first pseudomerge
1178 # will be the dgit import of the upload to the actual
1179 # suite intended by the non-dgit NMUer, and later
1180 # pseudomerges may represent in-archive copies.
1181 my $ovwrs = $pm->{Overwritten};
1182 printf $report " PM=%s \@Overwr:%d",
1183 $pm->{CommitId}, (scalar @$ovwrs)
1186 printdebug "*** WALK BOMB DgitImportUnpatched\n";
1189 my $ovwr = $ovwrs->[0]{CommitId};
1190 printf $report " Overwr=%s", $ovwr if $report;
1191 # This import has a tree which is just like a
1192 # breakwater tree, but it has the wrong history. It
1193 # ought to have the previous breakwater (which the
1194 # pseudomerge overwrote) as an ancestor. That will
1195 # make the history of the debian/ files correct. As
1196 # for the upstream version: either it's the same as
1197 # was ovewritten (ie, same as the previous
1198 # breakwater), in which case that history is precisely
1199 # right; or, otherwise, it was a non-gitish upload of a
1200 # new upstream version. We can tell these apart by
1201 # looking at the tree of the supposed upstream.
1204 SpecialMethod => 'DgitImportDebianUpdate',
1205 $xmsg->("convert dgit import: debian changes")
1208 SpecialMethod => 'DgitImportUpstreamUpdate',
1209 $xmsg->("convert dgit import: upstream update",
1212 $prline->(" Import");
1213 $rewrite_from_here->(\@brw_cl);
1214 $upp_limit //= $#upp_cl; # further, deeper, patches discarded
1218 # Everything is from this import. This kind of import
1219 # is already nearly in valid breakwater format, with the
1220 # patches as commits. Unfortunately it contains
1222 printdebug "*** WALK BOMB bare dgit import\n";
1223 $cl->{Why} = "bare dgit dsc import";
1227 } elsif ($ty eq 'MergedBreakwaters') {
1228 $last_anchor = mergedbreakwaters_anchor $cl;
1229 $build_start->(' MergedBreakwaters', $cur);
1231 } elsif ($ty eq 'VanillaMerge') {
1232 # User may have merged unstitched branch(es). We will
1233 # have now lost what ffq-prev was then (since the later
1234 # pseudomerge may introduce further changes). The effect
1235 # of resolving such a merge is that we may have to go back
1236 # further in history to find a merge base, since the one
1237 # which was reachable via ffq-prev is no longer findable.
1238 # This is suboptimal, but if it all works we'll have done
1240 # xxx we should warn the user in the docs about this
1244 # We expect to find a dominating anchor amongst the
1245 # inputs' anchors. That will be the new anchor.
1247 # More complicated is finding a merge base for the
1248 # breakwaters. We need a merge base that is a breakwater
1249 # commit. The ancestors of breakwater commits are more
1250 # breakwater commits and possibly upstream commits and the
1251 # ancestors of those upstream. Upstreams might have
1252 # arbitrary ancestors. But any upstream commit U is
1253 # either included in both anchors, in which case the
1254 # earlier anchor is a better merge base than any of U's
1255 # ancestors; or U is not included in the older anchor, in
1256 # which case U is not an ancestor of the vanilla merge at
1257 # all. So no upstream commit, nor any ancestor thereof,
1258 # is a best merge base. As for non-breakwater Debian
1259 # commits: these are never ancestors of any breakwater.
1261 # So any best merge base as found by git-merge-base
1262 # is a suitable breakwater anchor. Usually there will
1265 printdebug "*** MERGE\n";
1267 my @bwbcmd = (@git, qw(merge-base));
1268 my @ibcmd = (@git, qw(merge-base --all));
1269 my $might_be_in_bw = 1;
1271 my $ps = $cl->{Parents};
1273 $mwrecknote->('vanilla-merge', $cl->{CommitId});
1275 foreach my $p (@$ps) {
1276 $prline->(" VanillaMerge ".$p->{Ix});
1278 my ($ptip, $pbw, $panchor) =
1279 walk $p->{CommitId}, 0, $report,
1280 $report_lprefix.' ';
1281 $p->{Laundered} = $p->{SeriesTip} = $ptip;
1282 $p->{Breakwater} = $p->{SeriesBase} = $pbw;
1283 $p->{Anchor} = $panchor;
1285 my $lr = $p->{LeftRight} = (qw(left right))[$p->{Ix}];
1286 $mwrecknote->("$lr-input", $p->{CommitId});
1288 my $mwrecknote_parent = sub {
1290 $mwrecknote->("$lr-".(lc $which), $p->{$which});
1292 $mwrecknote_parent->('Laundered');
1293 $mwrecknote_parent->('Breakwater');
1294 $mwrecknote_parent->('Anchor');
1296 $best_anchor = $panchor if
1297 !defined $best_anchor or
1298 is_fast_fwd $best_anchor, $panchor;
1300 printdebug " MERGE BA best=".($best_anchor//'-').
1304 $mwrecknote->('result-anchor', $best_anchor);
1306 foreach my $p (@$ps) {
1307 $prline->(" VanillaMerge ".$p->{Ix});
1308 if (!is_fast_fwd $p->{Anchor}, $best_anchor) {
1309 $nomerge->('divergent anchors');
1310 } elsif ($p->{Anchor} eq $best_anchor) {
1311 print $report " SameAnchor" if $report;
1313 print $report " SupersededAnchor" if $report;
1315 if ($p->{Breakwater} eq $p->{CommitId}) {
1316 # this parent commit was its own breakwater,
1317 # ie it is part of the breakwater
1318 print $report " Breakwater" if $report;
1320 $might_be_in_bw = 0;
1322 push @bwbcmd, $p->{Breakwater};
1323 push @ibcmd, $p->{CommitId};
1326 if ($ok && $might_be_in_bw) {
1327 # We could rewrite this to contaion the metadata
1328 # declaring it to be MergedBreakwaters, but
1329 # unnecessarily rewriting a merge seems unhelpful.
1330 $prline->(" VanillaMerge MergedBreakwaters");
1331 $last_anchor = $best_anchor;
1332 $build_start->('MergedBreakwaters', $cur);
1335 my $bwb = cmdoutput @bwbcmd;
1337 # OK, now we have a breakwater base, but we need the merge
1338 # base for the interchange branch because we need the delta
1341 # This a the best merge base of our inputs which has the
1342 # breakwater merge base as an ancestor.
1349 @ibs or confess 'internal error, expected anchor at least ?';
1353 foreach my $tibix (0..$#ibs) {
1354 my $tib = $ibs[$tibix];
1355 my $ff = is_fast_fwd $bwb, $tib;
1356 my $ok = !$ff ? 'rej' : $ib ? 'extra' : 'ok';
1357 my $tibleaf = "interchange-mbcand-$ok-$tibix";
1358 $mwrecknote->($tibleaf, $tib);
1365 $ib or $nomerge->("no suitable interchange merge base");
1367 $prline->(" VanillaMerge Base");
1369 my ($btip, $bbw, $banchor) = eval {
1370 walk $ib, 0, $report, $report_lprefix.' ';
1372 $nomerge->("walking interchange branch merge base ($ibleaf):\n".
1376 $mwrecknote->("mergebase-laundered", $btip);
1377 $mwrecknote->("mergebase-breakwater", $bbw);
1378 $mwrecknote->("mergebase-anchor", $banchor);
1380 my $ibinfo = { SeriesTip => $btip,
1383 LeftRight => 'mergebase' };
1386 or $nomerge->("interchange merge-base ($ib)'s".
1387 " breakwater ($bbw)".
1388 " != breakwaters' merge-base ($bwb)");
1390 grep { $_->{Anchor} eq $ibinfo->{Anchor} } @$ps
1391 or $nomerge->("interchange merge-base ($ib)'s".
1392 " anchor ($ibinfo->{SeriesBase})".
1393 " != any merge input's anchor (".
1394 (join ' ', map { $_->{Anchor} } @$ps).
1397 $cl->{MergeInterchangeBaseInfo} = $ibinfo;
1398 $cl->{MergeBestAnchor} = $best_anchor;
1401 SpecialMethod => 'MergeCreateMergedBreakwaters',
1402 $xmsg->('constructed from vanilla merge',
1403 ' merged-breakwater'),
1407 SpecialMethod => 'MergeMergeSeries',
1409 $build_start->('MergeBreakwaters', $cur);
1411 printdebug "*** WALK BOMB unrecognised\n";
1417 printdebug "*** WALK prep done cur=$cur".
1418 " brw $#brw_cl upp $#upp_cl proc $#processed pm $#pseudomerges\n";
1420 return if $nogenerate;
1422 # Now we build it back up again
1428 my $read_tree_upstream = sub {
1430 read_tree_upstream $treeish, 0, $build;
1433 $#upp_cl = $upp_limit if defined $upp_limit;
1435 my $committer_authline = calculate_committer_authline();
1437 printdebug "WALK REBUILD $build ".(scalar @processed)."\n";
1439 confess "internal error" unless $build eq (pop @processed)->{CommitId};
1442 mkdir $rd or $!==EEXIST or die $!;
1444 runcmd @git, qw(read-tree), $build;
1445 foreach my $cl (qw(Debian), (reverse @brw_cl),
1446 { SpecialMethod => 'RecordBreakwaterTip' },
1447 qw(Upstream), (reverse @upp_cl)) {
1449 $current_method = $cl;
1452 my $method = $cl->{SpecialMethod} // $current_method;
1453 my @parents = ($build);
1454 my $cltree = $cl->{CommitId};
1455 printdebug "WALK BUILD ".($cltree//'undef').
1456 " $method (rewriting=$rewriting)\n";
1457 if ($method eq 'Debian') {
1458 read_tree_debian($cltree);
1459 } elsif ($method eq 'Upstream') {
1460 $read_tree_upstream->($cltree);
1461 } elsif ($method eq 'StartRewrite') {
1464 } elsif ($method eq 'RecordBreakwaterTip') {
1465 $breakwater = $build;
1467 } elsif ($method eq 'DgitImportDebianUpdate') {
1468 read_tree_debian($cltree);
1469 } elsif ($method eq 'DgitImportUpstreamUpdate') {
1470 confess unless $rewriting;
1471 my $differs = (get_differs $build, $cltree);
1472 next unless $differs & D_UPS;
1473 $read_tree_upstream->($cltree);
1474 push @parents, map { $_->{CommitId} } @{ $cl->{OrigParents} };
1475 } elsif ($method eq 'MergeCreateMergedBreakwaters') {
1476 print "Found a general merge, will try to tidy it up.\n";
1478 $read_tree_upstream->($cl->{MergeBestAnchor});
1479 $read_tree_upstream->($cl->{MergeBestAnchor});
1480 read_tree_debian($cltree);
1481 @parents = map { $_->{Breakwater} } @{ $cl->{Parents} };
1482 } elsif ($method eq 'MergeMergeSeries') {
1483 print "Running merge resolution for $cl->{CommitId}...\n";
1484 $mwrecknote->('new-base', $build);
1485 $build = merge_series
1486 $build, $cl->{MergeWreckNotes},
1487 $cl->{MergeInterchangeBaseInfo},
1488 @{ $cl->{Parents} };
1489 $last_anchor = $cl->{MergeBestAnchor};
1491 # Check for mismerges:
1493 my ($against, $allow, $what) = @_;
1494 my $differs = get_differs $build, $against;
1496 "merge misresolved: %s are not the same (%s %s d.%#x)",
1497 $what, $against, $build, $differs)
1498 if $differs & ~($allow | D_PAT_ADD);
1501 # Breakwater changes which were in each side of the
1502 # merge will have been incorporated into the
1503 # MergeCreateMergedBreakwaters output. Because the
1504 # upstream series was rebased onto the new breakwater,
1505 # so should all of the packaging changes which were in
1507 $check->($input, D_UPS, 'debian files');
1509 # Upstream files are merge_series, which ought to
1510 # have been identical to the original merge.
1511 $check->($cl->{CommitId}, DS_DEB, 'upstream files');
1513 print "Merge resolution successful.\n";
1516 confess "$method ?";
1519 my $procd = (pop @processed) // 'UNDEF';
1520 if ($cl ne $procd) {
1522 printdebug "WALK REWRITING NOW cl=$cl procd=$procd\n";
1525 my $newtree = cmdoutput @git, qw(write-tree);
1526 my $ch = $cl->{Hdr};
1527 $ch =~ s{^tree .*}{tree $newtree}m or confess "$ch ?";
1528 $ch =~ s{^parent .*\n}{}mg;
1529 $ch =~ s{(?=^author)}{
1530 join '', map { "parent $_\n" } @parents
1531 }me or confess "$ch ?";
1533 $ch =~ s{^committer .*$}{$committer_authline}m
1536 my $cf = "$rd/m$rewriting";
1537 open CD, ">", $cf or die $!;
1538 print CD $ch, "\n", $cl->{Msg} or die $!;
1540 my @cmd = (@git, qw(hash-object));
1541 push @cmd, qw(-w) if $rewriting;
1542 push @cmd, qw(-t commit), $cf;
1543 my $newcommit = cmdoutput @cmd;
1544 confess "$ch ?" unless $rewriting or $newcommit eq $cl->{CommitId};
1545 $build = $newcommit;
1546 if (grep { $method eq $_ } qw(DgitImportUpstreamUpdate)) {
1547 $last_anchor = $cur;
1552 my $final_check = get_differs $build, $input;
1553 die sprintf "internal error %#x %s %s", $final_check, $input, $build
1554 if $final_check & ~D_PAT_ADD;
1556 my @r = ($build, $breakwater, $last_anchor);
1557 printdebug "*** WALK RETURN @r\n";
1562 git_check_unmodified();
1563 return git_rev_parse qw(HEAD);
1566 sub update_head ($$$) {
1567 my ($old, $new, $mrest) = @_;
1568 push @deferred_updates, "update HEAD $new $old";
1569 run_deferred_updates $mrest;
1572 sub update_head_checkout ($$$) {
1573 my ($old, $new, $mrest) = @_;
1574 update_head $old, $new, $mrest;
1575 runcmd @git, qw(reset --hard);
1578 sub update_head_postlaunder ($$$) {
1579 my ($old, $tip, $reflogmsg) = @_;
1580 return if $tip eq $old;
1581 print "git-debrebase: laundered (head was $old)\n";
1582 update_head $old, $tip, $reflogmsg;
1583 # no tree changes except debian/patches
1584 runcmd @git, qw(rm --quiet --ignore-unmatch -rf debian/patches);
1587 sub currently_rebasing() {
1588 foreach (qw(rebase-merge rebase-apply)) {
1589 return 1 if stat_exists "$maindir_gitdir/$_";
1594 sub bail_if_rebasing() {
1595 fail "you are in the middle of a git-rebase already"
1596 if currently_rebasing();
1599 sub do_launder_head ($) {
1600 my ($reflogmsg) = @_;
1601 my $old = get_head();
1603 my ($tip,$breakwater) = walk $old;
1605 update_head_postlaunder $old, $tip, $reflogmsg;
1606 return ($tip,$breakwater);
1609 sub cmd_launder_v0 () {
1610 badusage "no arguments to launder-v0 allowed" if @ARGV;
1611 my $old = get_head();
1612 my ($tip,$breakwater,$last_anchor) = walk $old;
1613 update_head_postlaunder $old, $tip, 'launder';
1614 printf "# breakwater tip\n%s\n", $breakwater;
1615 printf "# working tip\n%s\n", $tip;
1616 printf "# last anchor\n%s\n", $last_anchor;
1619 sub defaultcmd_rebase () {
1620 push @ARGV, @{ $opt_defaultcmd_interactive // [] };
1621 my ($tip,$breakwater) = do_launder_head 'launder for rebase';
1622 runcmd @git, qw(rebase), @ARGV, $breakwater if @ARGV;
1625 sub cmd_analyse () {
1626 badusage "analyse does not support any options"
1627 if @ARGV and $ARGV[0] =~ m/^-/;
1628 badusage "too many arguments to analyse" if @ARGV>1;
1631 $old = git_rev_parse $old;
1633 $old = git_rev_parse 'HEAD';
1635 my ($dummy,$breakwater) = walk $old, 1,*STDOUT;
1636 STDOUT->error and die $!;
1639 sub ffq_prev_branchinfo () {
1640 my $current = git_get_symref();
1641 return gdr_ffq_prev_branchinfo($current);
1644 sub ffq_check ($;$$) {
1645 # calls $ff and/or $notff zero or more times
1646 # then returns either (status,message) where status is
1651 # or (undef,undef, $ffq_prev,$gdrlast)
1652 # $ff and $notff are called like this:
1653 # $ff->("message for stdout\n");
1654 # $notff->('snag-name', $message);
1655 # normally $currentval should be HEAD
1656 my ($currentval, $ff, $notff) =@_;
1658 $ff //= sub { print $_[0] or die $!; };
1661 my ($status, $message, $current, $ffq_prev, $gdrlast)
1662 = ffq_prev_branchinfo();
1663 return ($status, $message) unless $status eq 'branch';
1665 my $exists = git_get_ref $ffq_prev;
1666 return ('exists',"$ffq_prev already exists") if $exists;
1668 return ('not-branch', 'HEAD symref is not to refs/heads/')
1669 unless $current =~ m{^refs/heads/};
1672 my @check_specs = split /\;/, (cfg "branch.$branch.ffq-ffrefs",1) // '*';
1675 printdebug "ffq check_specs @check_specs\n";
1678 my ($lrref, $desc) = @_;
1679 printdebug "ffq might check $lrref ($desc)\n";
1681 for my $chk (@check_specs) {
1683 $invert = $glob =~ s{^[!^]}{};
1684 last if fnmatch $glob, $lrref;
1687 my $lrval = git_get_ref $lrref;
1688 return unless length $lrval;
1690 if (is_fast_fwd $lrval, $currentval) {
1691 $ff->("OK, you are ahead of $lrref\n");
1692 $checked{$lrref} = 1;
1693 } elsif (is_fast_fwd $currentval, $lrval) {
1694 $checked{$lrref} = -1;
1695 $notff->('behind', "you are behind $lrref, divergence risk");
1697 $checked{$lrref} = -1;
1698 $notff->('diverged', "you have diverged from $lrref");
1702 my $merge = cfg "branch.$branch.merge",1;
1703 if (defined $merge and $merge =~ m{^refs/heads/}) {
1705 printdebug "ffq merge $rhs\n";
1706 my $check_remote = sub {
1707 my ($remote, $desc) = @_;
1708 printdebug "ffq check_remote ".($remote//'undef')." $desc\n";
1709 return unless defined $remote;
1710 $check->("refs/remotes/$remote/$rhs", $desc);
1712 $check_remote->((scalar cfg "branch.$branch.remote",1),
1713 'remote fetch/merge branch');
1714 $check_remote->((scalar cfg "branch.$branch.pushRemote",1) //
1715 (scalar cfg "branch.$branch.pushDefault",1),
1716 'remote push branch');
1718 if ($branch =~ m{^dgit/}) {
1719 $check->("refs/remotes/dgit/$branch", 'remote dgit branch');
1720 } elsif ($branch =~ m{^master$}) {
1721 $check->("refs/remotes/dgit/dgit/sid", 'remote dgit branch for sid');
1723 return (undef, undef, $ffq_prev, $gdrlast);
1726 sub record_ffq_prev_deferred () {
1727 # => ('status', "message")
1729 # deferred message is undef
1734 # if not ff from some branch we should be ff from, is an snag
1735 # if "deferred", will have added something about that to
1736 # @deferred_update_messages, and also maybe printed (already)
1737 # some messages about ff checks
1739 my $currentval = get_head();
1741 my ($status,$message, $ffq_prev,$gdrlast) = ffq_check $currentval;
1742 return ($status,$message) if defined $status;
1746 push @deferred_updates, "update $ffq_prev $currentval $git_null_obj";
1747 push @deferred_updates, "delete $gdrlast";
1748 push @deferred_update_messages, "Recorded previous head for preservation";
1749 return ('deferred', undef);
1752 sub record_ffq_auto () {
1753 my ($status, $message) = record_ffq_prev_deferred();
1754 if ($status eq 'deferred' || $status eq 'exists') {
1756 snag $status, "could not record ffq-prev: $message";
1761 sub ffq_prev_info () {
1763 # => ($ffq_prev, $gdrlast, $ffq_prev_commitish)
1764 my ($status, $message, $current, $ffq_prev, $gdrlast)
1765 = ffq_prev_branchinfo();
1766 if ($status ne 'branch') {
1767 snag $status, "could not check ffq-prev: $message";
1770 my $ffq_prev_commitish = $ffq_prev && git_get_ref $ffq_prev;
1771 return ($ffq_prev, $gdrlast, $ffq_prev_commitish);
1774 sub stitch ($$$$$) {
1775 my ($old_head, $ffq_prev, $gdrlast, $ffq_prev_commitish, $prose) = @_;
1777 push @deferred_updates, "delete $ffq_prev $ffq_prev_commitish";
1779 if (is_fast_fwd $old_head, $ffq_prev_commitish) {
1780 my $differs = get_differs $old_head, $ffq_prev_commitish;
1781 unless ($differs & ~D_PAT_ADD) {
1782 # ffq-prev is ahead of us, and the only tree changes it has
1783 # are possibly addition of things in debian/patches/.
1784 # Just wind forwards rather than making a pointless pseudomerge.
1785 push @deferred_updates,
1786 "update $gdrlast $ffq_prev_commitish $git_null_obj";
1787 update_head_checkout $old_head, $ffq_prev_commitish,
1788 "stitch (fast forward)";
1793 # We make pseudomerges with L as the contributing parent.
1794 # This makes git rev-list --first-parent work properly.
1795 my $new_head = make_commit [ $old_head, $ffq_prev ], [
1796 'Declare fast forward / record previous work',
1797 "[git-debrebase pseudomerge: $prose]",
1799 push @deferred_updates, "update $gdrlast $new_head $git_null_obj";
1800 update_head $old_head, $new_head, "stitch: $prose";
1803 sub do_stitch ($;$) {
1804 my ($prose, $unclean) = @_;
1806 my ($ffq_prev, $gdrlast, $ffq_prev_commitish) = ffq_prev_info();
1807 if (!$ffq_prev_commitish) {
1808 fail "No ffq-prev to stitch." unless $opt_noop_ok;
1811 my $dangling_head = get_head();
1813 keycommits $dangling_head, $unclean,$unclean,$unclean;
1816 stitch($dangling_head, $ffq_prev, $gdrlast, $ffq_prev_commitish, $prose);
1819 sub upstream_commitish_search ($$) {
1820 my ($upstream_version, $tried) = @_;
1821 # todo: at some point maybe use git-deborig to do this
1822 foreach my $tagpfx ('', 'v', 'upstream/') {
1823 my $tag = $tagpfx.(dep14_version_mangle $upstream_version);
1824 my $new_upstream = git_get_ref "refs/tags/$tag";
1826 return $new_upstream if length $new_upstream;
1830 sub resolve_upstream_version ($$) {
1831 my ($new_upstream, $upstream_version) = @_;
1833 if (!defined $new_upstream) {
1835 $new_upstream = upstream_commitish_search $upstream_version, \@tried;
1836 if (!length $new_upstream) {
1837 fail "Could not determine appropriate upstream commitish.\n".
1838 " (Tried these tags: @tried)\n".
1839 " Check version, and specify upstream commitish explicitly.";
1842 $new_upstream = git_rev_parse $new_upstream;
1844 return $new_upstream;
1847 sub cmd_new_upstream () {
1848 # automatically and unconditionally launders before rebasing
1849 # if rebase --abort is used, laundering has still been done
1853 badusage "need NEW-VERSION [UPS-COMMITTISH]" unless @ARGV >= 1;
1855 # parse args - low commitment
1856 my $spec_version = shift @ARGV;
1857 my $new_version = (new Dpkg::Version $spec_version, check => 1);
1858 fail "bad version number \`$spec_version'" unless defined $new_version;
1859 if ($new_version->is_native()) {
1860 $new_version = (new Dpkg::Version "$spec_version-1", check => 1);
1863 my $new_upstream = shift @ARGV;
1864 my $new_upstream_version = upstreamversion $new_version;
1866 resolve_upstream_version $new_upstream, $new_upstream_version;
1871 my ($n, @x) = @_; # may be ''
1872 my $pc = $pieces{$n} //= {
1874 Desc => ($n ? "upstream piece \`$n'" : "upstream (main piece"),
1876 while (my $k = shift @x) { $pc->{$k} = shift @x; }
1881 my $newpiece = sub {
1882 my ($n, @x) = @_; # may be ''
1883 my $pc = $piece->($n, @x, NewIx => (scalar @newpieces));
1884 push @newpieces, $pc;
1889 New => $new_upstream,
1891 while (@ARGV && $ARGV[0] !~ m{^-}) {
1892 my $n = shift @ARGV;
1894 badusage "for each EXTRA-UPS-NAME need EXTRA-UPS-COMMITISH"
1895 unless @ARGV && $ARGV[0] !~ m{^-};
1897 my $c = git_rev_parse shift @ARGV;
1898 die unless $n =~ m/^$extra_orig_namepart_re$/;
1899 $newpiece->($n, New => $c);
1902 # now we need to investigate the branch this generates the
1903 # laundered version but we don't switch to it yet
1904 my $old_head = get_head();
1905 my ($old_laundered_tip,$old_bw,$old_anchor) = walk $old_head;
1907 my $old_bw_cl = classify $old_bw;
1908 my $old_anchor_cl = classify $old_anchor;
1910 if (!$old_anchor_cl->{OrigParents}) {
1911 snag 'anchor-treated',
1912 'old anchor is recognised due to --anchor, cannot check upstream';
1914 $old_upstream = parsecommit
1915 $old_anchor_cl->{OrigParents}[0]{CommitId};
1916 $piece->('', Old => $old_upstream->{CommitId});
1919 if ($old_upstream && $old_upstream->{Msg} =~ m{^\[git-debrebase }m) {
1920 if ($old_upstream->{Msg} =~
1921 m{^\[git-debrebase upstream-combine (\.(?: $extra_orig_namepart_re)+)\:.*\]$}m
1923 my @oldpieces = (split / /, $1);
1924 my $old_n_parents = scalar @{ $old_upstream->{Parents} };
1925 if ($old_n_parents != @oldpieces &&
1926 $old_n_parents != @oldpieces + 1) {
1927 snag 'upstream-confusing', sprintf
1928 "previous upstream combine %s".
1929 " mentions %d pieces (each implying one parent)".
1930 " but has %d parents".
1931 " (one per piece plus maybe a previous combine)",
1932 $old_upstream->{CommitId},
1933 (scalar @oldpieces),
1935 } elsif ($oldpieces[0] ne '.') {
1936 snag 'upstream-confusing', sprintf
1937 "previous upstream combine %s".
1938 " first piece is not \`.'",
1942 foreach my $i (0..$#oldpieces) {
1943 my $n = $oldpieces[$i];
1944 my $hat = 1 + $i + ($old_n_parents - @oldpieces);
1945 $piece->($n, Old => $old_upstream->{CommitId}.'^'.$hat);
1949 snag 'upstream-confusing',
1950 "previous upstream $old_upstream->{CommitId} is from".
1951 " git-debrebase but not an \`upstream-combine' commit";
1955 foreach my $pc (values %pieces) {
1956 if (!$old_upstream) {
1957 # we have complained already
1958 } elsif (!$pc->{Old}) {
1959 snag 'upstream-new-piece',
1960 "introducing upstream piece \`$pc->{Name}'";
1961 } elsif (!$pc->{New}) {
1962 snag 'upstream-rm-piece',
1963 "dropping upstream piece \`$pc->{Name}'";
1964 } elsif (!is_fast_fwd $pc->{Old}, $pc->{New}) {
1965 snag 'upstream-not-ff',
1966 "not fast forward: $pc->{Name} $pc->{Old}..$pc->{New}";
1970 printdebug "%pieces = ", (dd \%pieces), "\n";
1971 printdebug "\@newpieces = ", (dd \@newpieces), "\n";
1979 my @upstream_merge_parents;
1982 push @upstream_merge_parents, $old_upstream->{CommitId};
1985 foreach my $pc (@newpieces) { # always has '' first
1987 read_tree_subdir $pc->{Name}, $pc->{New};
1989 runcmd @git, qw(read-tree), $pc->{New};
1991 push @upstream_merge_parents, $pc->{New};
1994 # index now contains the new upstream
1996 if (@newpieces > 1) {
1997 # need to make the upstream subtree merge commit
1998 $new_upstream = make_commit \@upstream_merge_parents,
1999 [ "Combine upstreams for $new_upstream_version",
2000 ("[git-debrebase upstream-combine . ".
2001 (join " ", map { $_->{Name} } @newpieces[1..$#newpieces]).
2006 # $new_upstream is either the single upstream commit, or the
2007 # combined commit we just made. Either way it will be the
2008 # "upstream" parent of the anchor merge.
2010 read_tree_subdir 'debian', "$old_bw:debian";
2012 # index now contains the anchor merge contents
2013 $new_bw = make_commit [ $old_bw, $new_upstream ],
2014 [ "Update to upstream $new_upstream_version",
2015 "[git-debrebase anchor: new upstream $new_upstream_version, merge]",
2018 my $clogsignoff = cmdoutput qw(git show),
2019 '--pretty=format:%an <%ae> %aD',
2022 # Now we have to add a changelog stanza so the Debian version
2024 die if unlink "debian";
2025 die $! unless $!==ENOENT or $!==ENOTEMPTY;
2026 unlink "debian/changelog" or $!==ENOENT or die $!;
2027 mkdir "debian" or die $!;
2028 open CN, ">", "debian/changelog" or die $!;
2029 my $oldclog = git_cat_file ":debian/changelog";
2030 $oldclog =~ m/^($package_re) \(\S+\) / or
2031 fail "cannot parse old changelog to get package name";
2033 print CN <<END, $oldclog or die $!;
2034 $p ($new_version) UNRELEASED; urgency=medium
2036 * Update to new upstream version $new_upstream_version.
2042 runcmd @git, qw(update-index --add --replace), 'debian/changelog';
2044 # Now we have the final new breakwater branch in the index
2045 $new_bw = make_commit [ $new_bw ],
2046 [ "Update changelog for new upstream $new_upstream_version",
2047 "[git-debrebase: new upstream $new_upstream_version, changelog]",
2051 # we have constructed the new breakwater. we now need to commit to
2052 # the laundering output, because git-rebase can't easily be made
2053 # to make a replay list which is based on some other branch
2055 update_head_postlaunder $old_head, $old_laundered_tip,
2056 'launder for new upstream';
2058 my @cmd = (@git, qw(rebase --onto), $new_bw, $old_bw, @ARGV);
2059 local $ENV{GIT_REFLOG_ACTION} = git_reflog_action_msg
2060 "debrebase new-upstream $new_version: rebase";
2062 # now it's for the user to sort out
2065 sub cmd_record_ffq_prev () {
2066 badusage "no arguments allowed" if @ARGV;
2067 my ($status, $msg) = record_ffq_prev_deferred();
2068 if ($status eq 'exists' && $opt_noop_ok) {
2069 print "Previous head already recorded\n" or die $!;
2070 } elsif ($status eq 'deferred') {
2071 run_deferred_updates 'record-ffq-prev';
2073 fail "Could not preserve: $msg";
2078 badusage "no arguments allowed" if @ARGV;
2079 my ($anchor, $bw) = keycommits +(git_rev_parse 'HEAD'), 0,0;
2080 print "$bw\n" or die $!;
2083 sub cmd_breakwater () {
2084 badusage "no arguments allowed" if @ARGV;
2085 my ($anchor, $bw) = keycommits +(git_rev_parse 'HEAD'), 0,0;
2086 print "$bw\n" or die $!;
2090 badusage "no arguments allowed" if @ARGV;
2092 # todo: gdr status should print divergence info
2093 # todo: gdr status should print upstream component(s) info
2094 # todo: gdr should leave/maintain some refs with this kind of info ?
2096 my $oldest = { Badness => 0 };
2099 my ($badness, $ourmsg, $snagname, $dummy, $cl, $kcmsg) = @_;
2100 if ($oldest->{Badness} < $badness) {
2101 $oldest = $newest = undef;
2104 Badness => $badness,
2105 CommitId => $cl->{CommitId},
2109 $newest //= $oldest;
2111 my ($anchor, $bw) = keycommits +(git_rev_parse 'HEAD'),
2112 sub { $note->(1, 'branch contains furniture (not laundered)', @_); },
2113 sub { $note->(2, 'branch is unlaundered', @_); },
2114 sub { $note->(3, 'branch needs laundering', @_); },
2115 sub { $note->(4, 'branch not in git-debrebase form', @_); };
2117 my $prcommitinfo = sub {
2119 flush STDOUT or die $!;
2120 runcmd @git, qw(--no-pager log -n1),
2121 '--pretty=format: %h %s%n',
2125 print "current branch contents, in git-debrebase terms:\n";
2126 if (!$oldest->{Badness}) {
2127 print " branch is laundered\n";
2129 print " $oldest->{OurMsg}\n";
2131 foreach my $info ($oldest, $newest) {
2132 my $cid = $info->{CommitId};
2133 next if $cid eq $printed;
2135 print " $info->{KcMsg}\n";
2136 $prcommitinfo->($cid);
2141 my ($cid, $what) = @_;
2142 if (!defined $cid) {
2143 print " $what is not well-defined\n";
2146 $prcommitinfo->($cid);
2149 print "key git-debrebase commits:\n";
2150 $prab->($anchor, 'anchor');
2151 $prab->($bw, 'breakwater');
2153 my ($ffqstatus, $ffq_msg, $current, $ffq_prev, $gdrlast) =
2154 ffq_prev_branchinfo();
2156 print "branch and ref status, in git-debrebase terms:\n";
2158 print " $ffq_msg\n";
2160 $ffq_prev = git_get_ref $ffq_prev;
2161 $gdrlast = git_get_ref $gdrlast;
2163 print " unstitched; previous tip was:\n";
2164 $prcommitinfo->($ffq_prev);
2165 } elsif (!$gdrlast) {
2166 print " stitched? (no record of git-debrebase work)\n";
2167 } elsif (is_fast_fwd $gdrlast, 'HEAD') {
2168 print " stitched\n";
2170 print " not git-debrebase (diverged since last stitch)\n"
2173 print "you are currently rebasing\n" if currently_rebasing();
2177 my $prose = 'stitch';
2178 getoptions("stitch",
2179 'prose=s', \$prose);
2180 badusage "no arguments allowed" if @ARGV;
2181 do_stitch $prose, 0;
2183 sub cmd_prepush () { cmd_stitch(); }
2186 badusage "no arguments allowed" if @ARGV;
2187 do_launder_head 'launder for git-debrebase quick';
2191 sub cmd_conclude () {
2192 my ($ffq_prev, $gdrlast, $ffq_prev_commitish) = ffq_prev_info();
2193 if (!$ffq_prev_commitish) {
2194 fail "No ongoing git-debrebase session." unless $opt_noop_ok;
2197 my $dangling_head = get_head();
2199 badusage "no arguments allowed" if @ARGV;
2200 do_launder_head 'launder for git-debrebase quick';
2205 if (currently_rebasing()) {
2206 runcmd @git, qw(rebase --abort);
2208 my ($ffq_prev, $gdrlast, $ffq_prev_commitish) = ffq_prev_info();
2209 if (!$ffq_prev_commitish) {
2210 fail "No ongoing git-debrebase session." unless $opt_noop_ok;
2213 my $scrapping_head = get_head();
2214 badusage "no arguments allowed" if @ARGV;
2215 push @deferred_updates,
2216 "update $gdrlast $ffq_prev_commitish $git_null_obj",
2217 "update $ffq_prev $git_null_obj $ffq_prev_commitish";
2219 update_head_checkout $scrapping_head, $ffq_prev_commitish, "scrap";
2222 sub make_patches_staged ($) {
2224 # Produces the patches that would result from $head if it were
2226 my ($secret_head, $secret_bw, $last_anchor) = walk $head;
2229 gbp_pq_export 'bw', $secret_bw, $secret_head;
2233 sub make_patches ($) {
2235 keycommits $head, 0, \&snag;
2236 make_patches_staged $head;
2239 my $ptree = cmdoutput @git, qw(write-tree --prefix=debian/patches/);
2240 runcmd @git, qw(read-tree), $head;
2241 read_tree_subdir 'debian/patches', $ptree;
2242 $out = make_commit [$head], [
2243 'Commit patch queue (exported by git-debrebase)',
2244 '[git-debrebase: export and commit patches]',
2250 sub cmd_make_patches () {
2251 my $opt_quiet_would_amend;
2252 getoptions("make-patches",
2253 'quiet-would-amend!', \$opt_quiet_would_amend);
2254 badusage "no arguments allowed" if @ARGV;
2256 my $old_head = get_head();
2257 my $new = make_patches $old_head;
2258 my $d = get_differs $old_head, $new;
2260 fail "No (more) patches to export." unless $opt_noop_ok;
2262 } elsif ($d == D_PAT_ADD) {
2264 update_head_checkout $old_head, $new, 'make-patches';
2266 print STDERR failmsg
2267 "Patch export produced patch amendments".
2268 " (abandoned output commit $new).".
2269 " Try laundering first."
2270 unless $opt_quiet_would_amend;
2275 sub cmd_convert_from_gbp () {
2276 badusage "want only 1 optional argument, the upstream git commitish"
2279 my $clogp = parsechangelog();
2280 my $version = $clogp->{'Version'}
2281 // die "missing Version from changelog";
2283 my ($upstream_spec) = @ARGV;
2285 my $upstream_version = upstreamversion $version;
2287 resolve_upstream_version($upstream_spec, $upstream_version);
2289 my $old_head = get_head();
2291 my $upsdiff = get_differs $upstream, $old_head;
2292 if ($upsdiff & D_UPS) {
2293 runcmd @git, qw(--no-pager diff --stat),
2294 $upstream, $old_head,
2295 qw( -- :!/debian :/);
2297 upstream ($upstream_spec) and HEAD are not
2298 identical in upstream files. See diffstat above, or run
2299 git diff $upstream_spec HEAD -- :!/debian :/
2303 if (!is_fast_fwd $upstream, $old_head) {
2304 snag 'upstream-not-ancestor',
2305 "upstream ($upstream) is not an ancestor of HEAD";
2307 my $wrong = cmdoutput
2308 (@git, qw(rev-list --ancestry-path), "$upstream..HEAD",
2309 qw(-- :/ :!/debian));
2310 if (length $wrong) {
2311 snag 'unexpected-upstream-changes',
2312 "history between upstream ($upstream) and HEAD contains direct changes to upstream files - are you sure this is a gbp (patches-unapplied) branch?";
2313 print STDERR "list expected changes with: git log --stat --ancestry-path $upstream_spec..HEAD -- :/ ':!/debian'\n";
2317 if ((git_cat_file "$upstream:debian")[0] ne 'missing') {
2318 snag 'upstream-has-debian',
2319 "upstream ($upstream) contains debian/ directory";
2322 my $previous_dgit_view = eval {
2323 my @clogcmd = qw(dpkg-parsechangelog --format rfc822 -n2);
2325 parsechangelog_loop \@clogcmd, 'debian/changelog', sub {
2326 my ($stz, $desc) = @_;
2327 no warnings qw(exiting);
2328 printdebug 'CHANGELOG ', Dumper($desc, $stz);
2329 next unless $stz->{Date};
2330 next unless $stz->{Distribution} ne 'UNRELEASED';
2331 $lvsn = $stz->{Version};
2332 $suite = $stz->{Distribution};
2335 die "neither of the first two changelog entries are released\n"
2336 unless defined $lvsn;
2337 print "last finished-looking changelog entry: ($lvsn) $suite\n";
2338 my $mtag_pat = debiantag_maintview $lvsn, '*';
2339 my $mtag = cmdoutput @git, qw(describe --always --abbrev=0 --match),
2341 die "could not find suitable maintainer view tag $mtag_pat\n"
2342 unless $mtag_pat =~ m{/};
2343 is_fast_fwd $mtag, 'HEAD' or
2344 die "HEAD is not FF from maintainer tag $mtag!";
2345 my $dtag = "archive/$mtag";
2346 is_fast_fwd $mtag, $dtag or
2347 die "dgit view tag $dtag is not FF from maintainer tag $mtag";
2348 print "will stitch in dgit view, $dtag\n";
2349 git_rev_parse $dtag;
2351 if (!$previous_dgit_view) {
2354 print STDERR "cannot stitch in dgit view: $@\n";
2357 snags_maybe_bail_early();
2363 runcmd @git, qw(checkout -q -b gdr-internal), $old_head;
2364 # make a branch out of the patch queue - we'll want this in a mo
2365 runcmd qw(gbp pq import);
2366 # strip the patches out
2367 runcmd @git, qw(checkout -q gdr-internal~0);
2368 rm_subdir_cached 'debian/patches';
2369 $work = make_commit ['HEAD'], [
2370 'git-debrebase convert-from-gbp: drop patches from tree',
2371 'Delete debian/patches, as part of converting to git-debrebase format.',
2372 '[git-debrebase convert-from-gbp: drop patches from tree]'
2374 # make the anchor merge
2375 # the tree is already exactly right
2376 $work = make_commit [$work, $upstream], [
2377 'git-debrebase import: declare upstream',
2378 'First breakwater merge.',
2379 '[git-debrebase anchor: declare upstream]'
2382 # rebase the patch queue onto the new breakwater
2383 runcmd @git, qw(reset --quiet --hard patch-queue/gdr-internal);
2384 runcmd @git, qw(rebase --quiet --onto), $work, qw(gdr-internal);
2385 $work = git_rev_parse 'HEAD';
2387 if ($previous_dgit_view) {
2388 $work = make_commit [$work, $previous_dgit_view], [
2389 'git-debrebase import: declare ff from dgit archive view',
2390 '[git-debrebase pseudomerge: import-from-gbp]',
2397 update_head_checkout $old_head, $work, 'convert-from-gbp';
2400 sub cmd_convert_to_gbp () {
2401 badusage "no arguments allowed" if @ARGV;
2402 my $head = get_head();
2403 my (undef, undef, undef, $ffq, $gdrlast) = ffq_prev_branchinfo();
2404 keycommits $head, 0;
2406 make_patches_staged $head;
2408 $out = make_commit ['HEAD'], [
2409 'Commit patch queue (converted from git-debrebase format)',
2410 '[git-debrebase convert-to-gbp: commit patches]',
2414 push @deferred_updates, "delete $ffq";
2415 push @deferred_updates, "delete $gdrlast";
2418 update_head_checkout $head, $out, "convert to gbp (v0)";
2419 print <<END or die $!;
2420 git-debrebase: converted to git-buildpackage branch format
2421 git-debrebase: WARNING: do not now run "git-debrebase" any more
2422 git-debrebase: WARNING: doing so would drop all upstream patches!
2426 sub cmd_convert_from_dgit_view () {
2427 my $clogp = parsechangelog();
2429 my $bpd = (cfg 'dgit.default.build-products-dir',1) // '..';
2435 getoptions("convert-from-dgit-view",
2436 'diagnose!', \$diagnose,
2437 'build-products-dir:s', \$bpd,
2438 'origs!', \$do_origs,
2440 'always-convert-anyway!', \$always);
2441 fail "takes 1 optional argument, the upstream commitish" if @ARGV>1;
2446 my $spec = shift @ARGV;
2447 my $commit = git_rev_parse "$spec^{commit}";
2448 push @upstreams, { Commit => $commit,
2449 Source => "$ARGV[0], from command line",
2454 my $head = get_head();
2458 my $trouble = sub { $troubles++; };
2459 keycommits $head, sub{}, sub{}, $trouble, $trouble;
2460 printdebug "troubles=$troubles\n";
2463 $us: Branch already seems to be in git-debrebase format!
2464 $us: --always-convert-anyway would do the conversion operation anyway
2465 $us: but is probably a bad idea. Probably, you wanted to do nothing.
2467 fail "Branch already in git-debrebase format." unless $opt_noop_ok;
2472 snags_maybe_bail_early();
2474 my $version = upstreamversion $clogp->{Version};
2475 print STDERR "Considering possible commits corresponding to upstream:\n";
2480 my $ups_tag = upstream_commitish_search $version, \@tried;
2482 my $this = "git tag $tried[-1]";
2483 push @upstreams, { Commit => $ups_tag,
2488 " git tag: no suitable tag found (tried %s)\n",
2493 my $p = $clogp->{'Source'};
2494 # we do a quick check to see if there are plausible origs
2496 if (!opendir BPD, $bpd) {
2497 die "$bpd: opendir: $!" unless $!==ENOENT;
2499 while ($!=0, my $f = readdir BPD) {
2500 next unless is_orig_file_of_p_v $f, $p, $version;
2502 " orig: found what looks like a .orig, %s\n",
2507 die "read $bpd: $!" if $!;
2511 my $tree = cmdoutput
2512 @dgit, qw(--build-products-dir), $bpd,
2513 qw(print-unapplied-treeish);
2516 runcmd @git, qw(reset --quiet), $tree, qw(-- .);
2517 rm_subdir_cached 'debian';
2518 $tree = cmdoutput @git, qw(write-tree);
2519 my $ups_synth = make_commit [], [ <<END, <<END,
2520 Import effective orig tree for upstream version $version
2522 This includes the contents of the .orig(s), minus any debian/ directory.
2524 [git-debrebase import-from-dgit-view upstream-import-convert: $version]
2527 push @upstreams, { Commit => $ups_synth,
2528 Source => "orig(s) imported via dgit",
2533 " orig: no suitable origs found (looked for %s in %s)\n",
2534 "${p}_".(stripeoch $version)."...", $bpd;
2539 my $some_patches = stat_exists 'debian/patches/series';
2541 print STDERR "Evaluating possible commits corresponding to upstream:\n";
2544 foreach my $u (@upstreams) {
2548 runcmd @git, qw(reset --quiet), $u->{Commit}, qw(-- .);
2549 runcmd @git, qw(checkout), $u->{Commit}, qw(-- .);
2550 runcmd @git, qw(clean -xdff);
2551 runcmd @git, qw(checkout), $head, qw(-- debian);
2552 if ($some_patches) {
2553 rm_subdir_cached 'debian/patches';
2554 $work = make_commit [ $work ], [
2555 'git-debrebase convert-from-dgit-view: drop upstream changes from breakwater',
2556 "Drop upstream changes, and delete debian/patches, as part of converting\n".
2557 "to git-debrebase format. Upstream changes will appear as commits.",
2558 '[git-debrebase convert-from-dgit-view: drop patches from tree]'
2561 $work = make_commit [ $work, $u->{Commit} ], [
2562 'git-debrebase convert-from-dgit-view: declare upstream',
2563 '(Re)constructed breakwater merge.',
2564 '[git-debrebase anchor: declare upstream]'
2566 runcmd @git, qw(checkout --quiet -b mk), $work;
2567 if ($some_patches) {
2568 runcmd @git, qw(checkout), $head, qw(-- debian/patches);
2569 runcmd @git, qw(reset --quiet);
2570 my @gbp_cmd = (qw(gbp pq import));
2572 my $gbp_err = "../gbp-pq-err";
2573 @gbp_cmd = shell_cmd "exec >$gbp_err 2>&1", @gbp_cmd;
2575 my $r = system @gbp_cmd;
2578 " %s: couldn't apply patches: gbp pq %s",
2579 $u->{Source}, waitstatusmsg();
2583 my $work = git_rev_parse qw(HEAD);
2584 my $diffout = cmdoutput @git, qw(diff-tree --stat HEAD), $work;
2585 if (length $diffout) {
2587 " $u->{Source}: applying patches gives different tree\n";
2588 print STDERR $diffout if $diagnose;
2592 $u->{Result} = $work;
2600 Could not find or construct a suitable upstream commit.
2601 Rerun adding --diagnose after convert-from-dgit-view, or pass a
2602 upstream commmit explicitly or provide suitable origs.
2606 printf STDERR "Yes, will base new branch on %s\n", $result->{Source};
2608 ffq_check $result->{Result};
2610 update_head_checkout $head, $result->{Result},
2611 'convert-from-dgit-view';
2614 sub cmd_record_resolved_merge () {
2615 badusage "record-resolved-merge takes no further arguments" if @ARGV;
2616 my $new = get_head();
2619 print "Checking how you have resolved the merge problem\n";
2620 my $nope = sub { print "Not $method: @_"; 0; };
2622 my $maybe = sub { print "Seems to be $method.\n"; };
2624 my ($key, $ref) = @_;
2625 print "OK. You can switch branches and try git-debrebase again.\n";
2626 confess "todo $ref"; # xxx
2630 fresh_workarea 'merge';
2632 $method = 'vanilla-merge patchqueue';
2633 my $vanilla = git_get_ref "$wrecknoteprefix/vanilla-merge";
2634 $vanilla or return $nope->("wreckage was not of vanilla-merge");
2635 foreach my $lr (qw(left right)) {
2636 my $n = "$wrecknoteprefix/$lr-patchqueue";
2637 my $lrpq = git_get_ref $n;
2638 $lrpq or return $nope->("wreckage did not contain patchqueues");
2639 is_fast_fwd $lrpq, $new or return $nope->("HEAD not ff of $n");
2642 my $newbase = git_get_ref "$wrecknoteprefix/new-base"
2643 or die "wreckage element $wrecknoteprefix/new-base missing";
2644 my $result = merge_series_patchqueue_convert
2646 $yes->("vanilla-merge $vanilla", $result);
2649 fail "No resolved merge method seems applicable.\n";
2653 sub cmd_downstream_rebase_launder_v0 () {
2654 badusage "needs 1 argument, the baseline" unless @ARGV==1;
2656 $base = git_rev_parse $base;
2657 my $old_head = get_head();
2658 my $current = $old_head;
2661 if ($current eq $base) {
2662 $topmost_keep //= $current;
2663 print " $current BASE stop\n";
2666 my $cl = classify $current;
2667 print " $current $cl->{Type}";
2669 my $p0 = $cl->{Parents}[0]{CommitId};
2671 if ($cl->{Type} eq 'Pseudomerge') {
2672 print " ^".($cl->{Contributor}{Ix}+1);
2673 $next = $cl->{Contributor}{CommitId};
2674 } elsif ($cl->{Type} eq 'AddPatches' or
2675 $cl->{Type} eq 'Changelog') {
2685 $topmost_keep //= $current;
2687 die "to-be stripped changes not on top of the branch\n"
2692 if ($topmost_keep eq $old_head) {
2693 print "unchanged\n";
2695 print "updating to $topmost_keep\n";
2696 update_head_checkout
2697 $old_head, $topmost_keep,
2698 'downstream-rebase-launder-v0';
2704 "D+" => \$debuglevel,
2705 'noop-ok', => \$opt_noop_ok,
2706 'f=s' => \@snag_force_opts,
2707 'anchor=s' => \@opt_anchors,
2708 '--dgit=s' => \($dgit[0]),
2711 my ($opt,$val) = @_;
2712 badusage "git-debrebase: no cuddling to -i for git-rebase"
2714 die if $opt_defaultcmd_interactive; # should not happen
2715 $opt_defaultcmd_interactive = [ qw(-i) ];
2716 # This access to @ARGV is excessive familiarity with
2717 # Getopt::Long, but there isn't another sensible
2718 # approach. '-i=s{0,}' does not work with bundling.
2719 push @$opt_defaultcmd_interactive, @ARGV;
2722 'help' => sub { print $usage_message or die $!; finish 0; },
2725 initdebug('git-debrebase ');
2726 enabledebug if $debuglevel;
2728 my $toplevel = cmdoutput @git, qw(rev-parse --show-toplevel);
2729 chdir $toplevel or die "chdir $toplevel: $!";
2731 $rd = fresh_playground "$playprefix/misc";
2733 @opt_anchors = map { git_rev_parse $_ } @opt_anchors;
2735 if (!@ARGV || $opt_defaultcmd_interactive || $ARGV[0] =~ m{^-}) {
2736 defaultcmd_rebase();
2738 my $cmd = shift @ARGV;
2741 $cmdfn = ${*::}{"cmd_$cmdfn"};
2743 $cmdfn or badusage "unknown git-debrebase sub-operation $cmd";