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);
62 print STDERR "$us: bad usage: $m\n";
68 local $SIG{__WARN__}; # GetOptions calls `warn' to print messages
69 GetOptions @_ or badusage $m;
73 getoptions_main "bad options follow \`git-debrebase $sc'", @_;
77 my ($k, $optional) = @_;
79 my @cmd = qw(git config -z);
80 push @cmd, qw(--get-all) if wantarray;
82 my $out = cmdoutput_errok @cmd;
84 fail "missing required git config $k" unless $optional;
87 my @l = split /\0/, $out;
88 return wantarray ? @l : $l[0];
95 my $dd = new Data::Dumper [ $v ];
96 Terse $dd 1; Indent $dd 0; Useqq $dd 1;
102 my $data = (git_cat_file $objid, 'commit');
103 $data =~ m/(?<=\n)\n/ or die "$objid ($data) ?";
107 sub D_UPS () { 0x02; } # upstream files
108 sub D_PAT_ADD () { 0x04; } # debian/patches/ extra patches at end
109 sub D_PAT_OTH () { 0x08; } # debian/patches other changes
110 sub D_DEB_CLOG () { 0x10; } # debian/ (not patches/ or changelog)
111 sub D_DEB_OTH () { 0x20; } # debian/changelog
112 sub DS_DEB () { D_DEB_CLOG | D_DEB_OTH; } # debian/ (not patches/)
114 our $playprefix = 'debrebase';
119 our @dgit = qw(dgit);
121 sub in_workarea ($) {
124 my $r = eval { $sub->(); };
125 { local $@; changedir $maindir; }
129 sub fresh_workarea () {
130 $workarea = fresh_playground "$playprefix/work";
131 in_workarea sub { playtree_setup };
134 our $snags_forced = 0;
135 our $snags_tripped = 0;
136 our $snags_summarised = 0;
137 our @deferred_updates;
138 our @deferred_update_messages;
140 sub all_snags_summarised () {
141 $snags_forced + $snags_tripped == $snags_summarised;
143 sub run_deferred_updates ($) {
146 confess 'dangerous internal error' unless all_snags_summarised();
148 my @upd_cmd = (git_update_ref_cmd "debrebase: $mrest", qw(--stdin));
149 debugcmd '>|', @upd_cmd;
150 open U, "|-", @upd_cmd or die $!;
151 foreach (@deferred_updates) {
152 printdebug ">= ", $_, "\n";
153 print U $_, "\n" or die $!;
156 close U or failedcmd @upd_cmd;
158 print $_, "\n" foreach @deferred_update_messages;
160 @deferred_updates = ();
161 @deferred_update_messages = ();
164 sub get_differs ($$) {
166 # This resembles quiltify_trees_differ, in dgit, a bit.
167 # But we don't care about modes, or dpkg-source-unrepresentable
168 # changes, and we don't need the plethora of different modes.
169 # Conversely we need to distinguish different kinds of changes to
170 # debian/ and debian/patches/.
175 my ($opts, $limits, $fn) = @_;
176 my @cmd = (@git, qw(diff-tree -z --no-renames));
178 push @cmd, "$_:" foreach $x, $y;
179 push @cmd, '--', @$limits;
180 my $diffs = cmdoutput @cmd;
181 foreach (split /\0/, $diffs) { $fn->(); }
184 $rundiff->([qw(--name-only)], [], sub {
185 $differs |= $_ eq 'debian' ? DS_DEB : D_UPS;
188 if ($differs & DS_DEB) {
190 $rundiff->([qw(--name-only -r)], [qw(debian)], sub {
192 m{^debian/patches/} ? D_PAT_OTH :
193 $_ eq 'debian/changelog' ? D_DEB_CLOG :
196 die "mysterious debian changes $x..$y"
197 unless $differs & (D_PAT_OTH|DS_DEB);
200 if ($differs & D_PAT_OTH) {
202 $differs &= ~D_PAT_OTH;
204 $differs |= D_PAT_OTH;
205 no warnings qw(exiting); last;
207 $rundiff->([qw(--name-status -r)], [qw(debian/patches/)], sub {
208 no warnings qw(exiting);
209 if (!defined $mode) {
212 die unless s{^debian/patches/}{};
214 if ($mode eq 'A' && !m/\.series$/s) {
216 } elsif ($mode eq 'M' && $_ eq 'series') {
217 my $x_s = (git_cat_file "$x:debian/patches/series", 'blob');
218 my $y_s = (git_cat_file "$y:debian/patches/series", 'blob');
219 chomp $x_s; $x_s .= "\n";
220 $ok = $x_s eq substr($y_s, 0, length $x_s);
225 $differs |= $ok ? D_PAT_ADD : D_PAT_OTH;
227 die "mysterious debian/patches changes $x..$y"
228 unless $differs & (D_PAT_ADD|D_PAT_OTH);
231 printdebug sprintf "get_differs %s %s = %#x\n", $x, $y, $differs;
236 sub commit_pr_info ($) {
238 return Data::Dumper->dump([$r], [qw(commit)]);
241 sub calculate_committer_authline () {
242 my $c = cmdoutput @git, qw(commit-tree --no-gpg-sign -m),
243 'DUMMY COMMIT (git-debrebase)', "HEAD:";
244 my ($h,$m) = get_commit $c;
245 $h =~ m/^committer .*$/m or confess "($h) ?";
249 sub rm_subdir_cached ($) {
251 runcmd @git, qw(rm --quiet -rf --cached --ignore-unmatch), $subdir;
254 sub read_tree_subdir ($$) {
255 my ($subdir, $new_tree_object) = @_;
256 rm_subdir_cached $subdir;
257 runcmd @git, qw(read-tree), "--prefix=$subdir/", $new_tree_object;
260 sub read_tree_debian ($) {
262 read_tree_subdir 'debian', "$treeish:debian";
263 rm_subdir_cached 'debian/patches';
266 sub read_tree_upstream ($;$) {
267 my ($treeish, $keep_patches) = @_;
268 my $save = cmdoutput @git, qw(write-tree --prefix=debian/);
269 runcmd @git, qw(read-tree), $treeish;
270 read_tree_subdir 'debian', $save;
271 rm_subdir_cached 'debian/patches' unless $keep_patches;
274 sub make_commit ($$) {
275 my ($parents, $message_paras) = @_;
276 my $tree = cmdoutput @git, qw(write-tree);
277 my @cmd = (@git, qw(commit-tree), $tree);
278 push @cmd, qw(-p), $_ foreach @$parents;
279 push @cmd, qw(-m), $_ foreach @$message_paras;
280 return cmdoutput @cmd;
283 our @snag_force_opts;
285 my ($tag,$msg) = @_; # ignores extra args, for benefit of keycommits
286 if (grep { $_ eq $tag } @snag_force_opts) {
288 print STDERR "git-debrebase: snag ignored (-f$tag): $msg\n";
291 print STDERR "git-debrebase: snag detected (-f$tag): $msg\n";
295 # Important: all mainline code must call snags_maybe_bail after
296 # any point where snag might be called, but before making changes
297 # (eg before any call to run_deferred_updates). snags_maybe_bail
298 # may be called more than once if necessary (but this is not ideal
299 # because then the messages about number of snags may be confusing).
300 sub snags_maybe_bail () {
301 return if all_snags_summarised();
304 "%s: snags: %d overriden by individual -f options\n",
307 if ($snags_tripped) {
310 "%s: snags: %d overriden by global --force\n",
314 "%s: snags: %d blocker(s) (you could -f<tag>, or --force)",
318 $snags_summarised = $snags_forced + $snags_tripped;
320 sub snags_maybe_bail_early () {
321 # useful to bail out early without doing a lot of work;
322 # not a substitute for snags_maybe_bail.
323 snags_maybe_bail() if $snags_tripped && !$opt_force;
326 return $snags_forced || $snags_tripped;
329 sub gbp_pq_export ($$$) {
330 my ($bname, $base, $tip) = @_;
331 # must be run in a workarea. $bname and patch-queue/$bname
332 # ought not to exist. Leaves you on patch-queue/$bname with
333 # the patches staged but not committed.
334 printdebug "gbp_pq_export $bname $base $tip\n";
335 runcmd @git, qw(checkout -q -b), $bname, $base;
336 runcmd @git, qw(checkout -q -b), "patch-queue/$bname", $tip;
337 my @gbp_cmd = (qw(gbp pq export));
338 my $r = system shell_cmd 'exec >../gbp-pq-err 2>&1', @gbp_cmd;
340 { local ($!,$?); copy('../gbp-pq-err', \*STDERR); }
343 runcmd @git, qw(add -f debian/patches);
347 # xxx allow merge resolution separately from laundering, before git merge
349 # xxx general gdr docs highlight forbidden things
350 # xxx general gdr docs list allowable things ?
351 # xxx general gdr docs explicitly forbid some rebase
353 # xxx provide a way for the user to help
354 # xxx (eg, provide wreckage provide way to continue)
357 # use git-format-patch?
358 # our own patch identification algorithm?
359 # this is an alternative strategy
361 sub merge_series ($$;@) {
362 my ($newbase, $base_q, @input_qs) = @_;
363 # $base_q{SeriesBase} $input_qs[]{SeriesBase}
364 # $base_q{SeriesTip} $input_qs[]{SeriesTip}
365 # ^ specifies several patch series (currently we only support exactly 2)
366 # return value is a commit which is the result of
367 # merging the two versions of the same topic branch
368 # $input_q[0] and $input_q[1]
369 # with respect to the old version
373 # Creates, in *_q, a key MR for its private use
375 printdebug "merge_series newbase=$newbase\n";
377 $input_qs[$_]{MR}{S} = $_ foreach (0..$#input_qs);
378 $base_q->{MR}{S} = 'base';
381 # $prereq{<patch filename>}{<possible prereq}{<S>} = 1 or absent
382 # $prereq{<patch filename>}{<possible prereq} exists or not (later)
383 # $prereq{<patch filename>} exists or not (even later)
387 local $workarea = fresh_playground "$playprefix/merge";
388 my $seriesfile = "debian/patches/series";
391 foreach my $q ($base_q, reverse @input_qs) {
393 gbp_pq_export "p-$s", $q->{SeriesBase}, $q->{SeriesTip};
394 if (open S, $seriesfile) {
396 while (my $patch = <S>) {
397 chomp $patch or die $!;
398 $prereq{$patch} //= {};
399 foreach my $earlier (@earlier) {
400 $prereq{$patch}{$earlier}{$s}++ and die;
402 push @earlier, $patch;
403 stat "debian/patches/$patch" or die "$patch ?";
405 S->error and die "$seriesfile $!";
408 die "$seriesfile $!" unless $!==ENOENT;
410 read_tree_upstream $newbase, 1;
411 my $pec = make_commit [ grep { defined } $base_q->{MR}{PEC} ], [
412 "Convert $s to patch queue for merging",
413 "[git-debrebase merge-innards patch-queue import:".
416 printdebug "merge_series pec $pec ";
417 runcmd @git, qw(rm -q --cached), $seriesfile;
418 $pec = make_commit [ $pec ], [
419 "Drop series file from $s to avoid merge trouble",
420 "[git-debrebase merge-innards patch-queue prep:".
423 printdebug "pec' $pec\n";
424 runcmd @git, qw(reset -q --hard), $pec;
425 $q->{MR}{PEC} = $pec;
427 # now, because of reverse, we are on $input_q->{MR}{OQC}
428 runcmd @git, qw(checkout -q -b merge);
429 printdebug "merge_series merging...\n";
430 my @mergecmd = (@git, qw(merge --quiet --no-edit), "p-1");
431 debugcmd '+', @mergecmd;
433 if (system @mergecmd) {
437 printdebug "merge_series merge ok, series...\n";
438 # We need to construct a new series file
439 # Firstly, resolve prereq
440 foreach my $f (sort keys %prereq) {
441 printdebug "merge_series patch\t$f\t";
442 if (!stat_exists "debian/patches/$f") {
443 print DEBUG " drop\n" if $debuglevel;
444 # git merge deleted it; that's how we tell it's not wanted
448 print DEBUG " keep\n" if $debuglevel;
449 foreach my $g (sort keys %{ $prereq{$f} }) {
450 my $gfp = $prereq{$f}{$g};
451 printdebug "merge_series prereq\t$f\t-> $g\t";
452 if (!!$gfp->{0} == !!$gfp->{1}
455 print DEBUG "\tkeep\n" if $debuglevel;
457 print DEBUG "\tdrop\n" if $debuglevel;
458 delete $prereq{$f}{$g};
465 return scalar keys %{ $prereq{$f} };
468 my $nodate = time + 1;
470 # $authordate{<patch filename>};
471 my $authordate = sub {
473 $authordate{$f} //= do {
474 open PF, "<", "debian/patches/$f" or die "$f $!";
476 return $nodate if m/^$/;
477 last if s{^Date: }{};
480 return cmdoutput qw(date +%s -d), $_;
484 open NS, '>', $seriesfile or die $!;
486 while (keys %prereq) {
488 foreach my $try (sort keys %prereq) {
491 $unsat->($try) <=> $unsat->($best) or
492 $authordate->($try) <=> $authordate->($best) or
498 printdebug "merge_series series next $best\n";
499 print NS "$best\n" or die $!;
500 delete $prereq{$best};
501 foreach my $gp (values %prereq) {
506 runcmd @git, qw(add), $seriesfile;
507 runcmd @git, qw(commit --quiet -m), 'Merged series';
509 printdebug "merge_series series gbp pq import\n";
510 runcmd qw(gbp pq import);
512 # OK now we are on patch-queue/merge, and we need to rebase
513 # onto the intended parent and drop the patches from each one
515 printdebug "merge_series series ok, building...\n";
516 my $build = $newbase;
517 my @lcmd = (@git, qw(rev-list --reverse merge..patch-queue/merge));
518 foreach my $c (grep /./, split /\n/, cmdoutput @lcmd) {
519 my $commit = git_cat_file $c, 'commit';
520 printdebug "merge_series series ok, building $c\n";
521 read_tree_upstream $c;
522 my $tree = cmdoutput @git, qw(write-tree);
523 $commit =~ s{^parent (\S+)$}{parent $build}m or confess;
524 $commit =~ s{^tree (\S+)$}{tree $tree}m or confess;
525 open C, ">", "../mcommit" or die $!;
526 print C $commit or die $!;
528 $build = cmdoutput @git, qw(hash-object -w -t commit ../mcommit);
531 runcmd @git, qw(update-ref refs/heads/result), $result;
533 printdebug "merge_series returns $result\n";
537 # classify returns an info hash like this
539 # Hdr => # commit headers, including 1 final newline
540 # Msg => # commit message (so one newline is dropped)
542 # Type => (see below)
544 # Ix => $index # ie 0, 1, 2, ...
546 # Differs => return value from get_differs
548 # IsDggitImport => 'orig' 'tarball' 'unpatched' 'package' (as from dgit)
550 # NewMsg => # commit message, but with any [dgit import ...] edited
551 # # to say "[was: ...]"
561 # has additional entres in classification result
562 # Overwritten = [ subset of Parents ]
563 # Contributor = $the_remaining_Parent
565 # DgitImportUnpatched
566 # has additional entry in classification result
567 # OrigParents = [ subset of Parents ]
570 # has additional entry in classification result
571 # OrigParents = [ subset of Parents ] # singleton list
578 # has additional entry in classification result
581 sub parsecommit ($;$) {
582 my ($objid, $p_ref) = @_;
583 # => hash with CommitId Hdr Msg Tree Parents
584 # Parents entries have only Ix CommitId
585 # $p_ref, if provided, must be [] and is used as a base for Parents
590 my ($h,$m) = get_commit $objid;
592 my ($t) = $h =~ m/^tree (\w+)$/m or die $objid;
593 my (@ph) = $h =~ m/^parent (\w+)$/mg;
603 foreach my $ph (@ph) {
605 Ix => scalar @$p_ref,
617 my $r = parsecommit($objid, \@p);
621 $p->{Differs} = (get_differs $p->{CommitId}, $t),
624 printdebug "classify $objid \$t=$t \@p",
625 (map { sprintf " %s/%#x", $_->{CommitId}, $_->{Differs} } @p),
629 my ($type, @rest) = @_;
630 $r = { %$r, Type => $type, @rest };
632 printdebug " = $type ".(dd $r)."\n";
638 $r = { %$r, Type => qw(Unknown), Why => $why };
639 printdebug " ** Unknown\n";
643 if (grep { $_ eq $objid } @opt_anchors) {
644 return $classify->('TreatAsAnchor');
647 my @identical = grep { !$_->{Differs} } @p;
648 my ($stype, $series) = git_cat_file "$t:debian/patches/series";
649 my $haspatches = $stype ne 'missing' && $series =~ m/^\s*[^#\n\t ]/m;
651 if ($r->{Msg} =~ m{^\[git-debrebase anchor.*\]$}m) {
652 # multi-orig upstreams are represented with an anchor merge
653 # from a single upstream commit which combines the orig tarballs
655 # Every anchor tagged this way must be a merge.
656 # We are relying on the
657 # [git-debrebase anchor: ...]
658 # commit message annotation in "declare" anchor merges (which
659 # do not have any upstream changes), to distinguish those
660 # anchor merges from ordinary pseudomerges (which we might
661 # just try to strip).
663 # However, the user is going to be doing git-rebase a lot. We
664 # really don't want them to rewrite an anchor commit.
665 # git-rebase trips up on merges, so that is a useful safety
668 # BreakwaterStart commits are also anchors in the terminology
669 # of git-debrebase(5), but they are untagged (and always
670 # manually generated).
672 # We cannot not tolerate any tagged linear commit (ie,
673 # BreakwaterStart commits tagged `[anchor:') because such a
674 # thing could result from an erroneous linearising raw git
675 # rebase of a merge anchor. That would represent a corruption
676 # of the branch. and we want to detect and reject the results
677 # of such corruption before it makes it out anywhere. If we
678 # reject it here then we avoid making the pseudomerge which
679 # would be needed to push it.
681 my $badanchor = sub { $unknown->("git-debrebase \`anchor' but @_"); };
682 @p == 2 or return $badanchor->("has other than two parents");
683 $haspatches and return $badanchor->("contains debian/patches");
685 # How to decide about l/r ordering of anchors ? git
686 # --topo-order prefers to expand 2nd parent first. There's
687 # already an easy rune to look for debian/ history anyway (git log
688 # debian/) so debian breakwater branch should be 1st parent; that
689 # way also there's also an easy rune to look for the upstream
690 # patches (--topo-order).
692 # Also this makes --first-parent be slightly more likely to
693 # be useful - it makes it provide a linearised breakwater history.
695 # Of course one can say somthing like
696 # gitk -- ':/' ':!/debian'
697 # to get _just_ the commits touching upstream files, and by
698 # the TREESAME logic in git-rev-list this will leave the
699 # breakwater into upstream at the first anchor. But that
700 # doesn't report debian/ changes at all.
702 # Other observations about gitk: by default, gitk seems to
703 # produce output in a different order to git-rev-list. I
704 # can't seem to find this documented anywhere. gitk
705 # --date-order DTRT. But, gitk always seems to put the
706 # parents from left to right, in order, so it's easy to see
707 # which way round a pseudomerge is.
709 $p[0]{IsOrigin} and $badanchor->("is an origin commit");
710 $p[1]{Differs} & ~DS_DEB and
711 $badanchor->("upstream files differ from left parent");
712 $p[0]{Differs} & ~D_UPS and
713 $badanchor->("debian/ differs from right parent");
715 return $classify->(qw(Anchor),
716 OrigParents => [ $p[1] ]);
720 my $d = $r->{Parents}[0]{Differs};
721 if ($d == D_PAT_ADD) {
722 return $classify->(qw(AddPatches));
723 } elsif ($d & (D_PAT_ADD|D_PAT_OTH)) {
724 return $unknown->("edits debian/patches");
725 } elsif ($d & DS_DEB and !($d & ~DS_DEB)) {
726 my ($ty,$dummy) = git_cat_file "$p[0]{CommitId}:debian";
728 if ($d == D_DEB_CLOG) {
729 return $classify->(qw(Changelog));
731 return $classify->(qw(Packaging));
733 } elsif ($ty eq 'missing') {
734 return $classify->(qw(BreakwaterStart));
736 return $unknown->("parent's debian is not a directory");
738 } elsif ($d == D_UPS) {
739 return $classify->(qw(Upstream));
740 } elsif ($d & DS_DEB and $d & D_UPS and !($d & ~(DS_DEB|D_UPS))) {
741 return $classify->(qw(Mixed));
743 return $unknown->("no changes");
745 confess "internal error $objid ?";
749 return $unknown->("origin commit");
752 if (@p == 2 && @identical == 1) {
753 my @overwritten = grep { $_->{Differs} } @p;
754 confess "internal error $objid ?" unless @overwritten==1;
755 return $classify->(qw(Pseudomerge),
756 Overwritten => [ $overwritten[0] ],
757 Contributor => $identical[0]);
759 if (@p == 2 && @identical == 2) {
761 my ($ph,$pm) = get_commit $_[0]{CommitId};
762 $ph =~ m/^committer .* (\d+) [-+]\d+$/m or die "$_->{CommitId} ?";
766 my $order = $get_t->($bytime[0]) <=> $get_t->($bytime[1]);
767 if ($order > 0) { # newer first
768 } elsif ($order < 0) {
769 @bytime = reverse @bytime;
771 # same age, default to order made by -s ours
772 # that is, commit was made by someone who preferred L
774 return $classify->(qw(Pseudomerge),
775 SubType => qw(Ambiguous),
776 Contributor => $bytime[0],
777 Overwritten => [ $bytime[1] ]);
780 my ($p_h, $p_m) = get_commit $p->{CommitId};
781 $p->{IsOrigin} = $p_h !~ m/^parent \w+$/m;
782 ($p->{IsDgitImport},) = $p_m =~ m/^\[dgit import ([0-9a-z]+) .*\]$/m;
784 my @orig_ps = grep { ($_->{IsDgitImport}//'X') eq 'orig' } @p;
786 if (!(grep { !$_->{IsOrigin} } @p) and
787 (@orig_ps >= @p - 1) and
788 $m2 =~ s{^\[(dgit import unpatched .*)\]$}{[was: $1]}m) {
790 return $classify->(qw(DgitImportUnpatched),
791 OrigParents => \@orig_ps);
795 $r->{Msg} =~ m{^\[git-debrebase merged-breakwater.*\]$}m) {
796 # xxx ^ metadata tag needs adding to (5)
797 return $classify->("MergedBreakwaters");
799 if ($r->{Msg} =~ m{^\[(git-debrebase|dgit)[: ].*\]$}m) {
800 return $unknown->("unknown kind of merge from $1");
803 return $unknown->("octopus merge");
806 if (!$ENV{GIT_DEBREBASE_EXPERIMENTAL_MERGE}) {
807 return $unknown->("general two-parent merge");
810 return $classify->("VanillaMerge");
813 sub keycommits ($;$$$$) {
814 my ($head, $furniture, $unclean, $trouble, $fatal) = @_;
815 # => ($anchor, $breakwater)
817 # $unclean->("unclean-$tagsfx", $msg, $cl)
818 # $furniture->("unclean-$tagsfx", $msg, $cl)
819 # $dgitimport->("unclean-$tagsfx", $msg, $cl))
820 # is callled for each situation or commit that
821 # wouldn't be found in a laundered branch
822 # $furniture is for furniture commits such as might be found on an
823 # interchange branch (pseudomerge, d/patches, changelog)
824 # $trouble is for things whnich prevent the return of
825 # anchor and breakwater information; if that is ignored,
826 # then keycommits returns (undef, undef) instead.
827 # $fatal is for unprocessable commits, and should normally cause
828 # a failure. If ignored, agaion, (undef, undef) is returned.
830 # If a callback is undef, fail is called instead.
831 # If a callback is defined but false, the situation is ignored.
833 # no warnings qw(exiting); last;
834 # if the answer is no longer wanted.
836 my ($anchor, $breakwater);
840 $fatal //= sub { fail $_[1]; };
842 my ($cb, $tagsfx, $mainwhy, $xwhy) = @_;
843 my $why = $mainwhy.$xwhy;
844 my $m = "branch needs laundering (run git-debrebase): $why";
845 fail $m unless defined $cb;
847 $cb->("unclean-$tagsfx", $why, $cl, $mainwhy);
850 $cl = classify $head;
851 my $ty = $cl->{Type};
852 if ($ty eq 'Packaging') {
853 $breakwater //= $clogonly;
854 $breakwater //= $head;
855 } elsif ($ty eq 'Changelog') {
856 # this is going to count as the tip of the breakwater
857 # only if it has no upstream stuff before it
859 } elsif ($ty eq 'Anchor' or
860 $ty eq 'TreatAsAnchor' or
861 $ty eq 'BreakwaterStart') {
863 $breakwater //= $clogonly;
864 $breakwater //= $head;
866 } elsif ($ty eq 'Upstream') {
867 $x->($unclean, 'ordering',
868 "packaging change ($breakwater) follows upstream change"," (eg $head)")
869 if defined $breakwater;
872 } elsif ($ty eq 'Mixed') {
873 $x->($unclean, 'mixed',
874 "found mixed upstream/packaging commit"," ($head)");
877 } elsif ($ty eq 'Pseudomerge' or
878 $ty eq 'AddPatches') {
880 $x->($furniture, (lc $ty),
881 "found interchange bureaucracy commit ($ty)"," ($head)");
882 } elsif ($ty eq 'DgitImportUnpatched') {
884 $x->($trouble, 'dgitimport',
885 "found dgit dsc import"," ($head)");
886 return (undef,undef);
888 $x->($fatal, 'unprocessable',
889 "found bare dgit dsc import with no prior history",
891 return (undef,undef);
893 } elsif ($ty eq 'VanillaMerge') {
894 $x->($trouble, 'vanillamerge',
895 "found vanilla merge"," ($head)");
896 return (undef,undef);
898 $x->($fatal, 'unprocessable',
899 "found unprocessable commit, cannot cope: $cl->{Why}",
901 return (undef,undef);
903 $head = $cl->{Parents}[0]{CommitId};
905 return ($anchor, $breakwater);
911 $nogenerate,$report, $report_lprefix) = @_;
912 # => ($tip, $breakwater_tip, $last_anchor)
913 # (or nothing, if $nogenerate)
915 printdebug "*** WALK $input ".($nogenerate//0)." ".($report//'-')."\n";
916 $report_lprefix //= '';
918 # go through commits backwards
919 # we generate two lists of commits to apply:
920 # breakwater branch and upstream patches
921 my (@brw_cl, @upp_cl, @processed);
928 my ($prose, $info) = @_;
932 $ms .= "\n\n[git-debrebase$info: $prose]\n";
935 my $rewrite_from_here = sub {
937 my $sp_cl = { SpecialMethod => 'StartRewrite' };
939 push @processed, $sp_cl;
944 my $prprdelim = sub { print $report $prdelim if $report; $prdelim=""; };
947 return unless $report;
948 print $report $prdelim, $report_lprefix, @_;
952 my $bomb = sub { # usage: return $bomb->();
953 print $report " Unprocessable" if $report;
954 print $report " ($cl->{Why})" if $report && defined $cl->{Why};
957 return (undef,undef);
959 fail "found unprocessable commit, cannot cope".
960 (defined $cl->{Why} ? "; $cl->{Why}:": ':').
961 " (commit $cur) (d.".
962 (join ' ', map { sprintf "%#x", $_->{Differs} }
963 @{ $cl->{Parents} }).
970 my $build_start = sub {
971 my ($msg, $parent) = @_;
974 no warnings qw(exiting); last;
978 fail "something useful about failed merge attempt @_ xxx".Dumper($cl);
985 my $ty = $cl->{Type};
986 my $st = $cl->{SubType};
987 $prline->("$cl->{CommitId} $cl->{Type}");
988 $found{$ty. ( defined($st) ? "-$st" : '' )}++;
989 push @processed, $cl;
990 my $p0 = @{ $cl->{Parents} }==1 ? $cl->{Parents}[0]{CommitId} : undef;
991 if ($ty eq 'AddPatches') {
993 $rewrite_from_here->(\@upp_cl);
995 } elsif ($ty eq 'Packaging' or $ty eq 'Changelog') {
999 } elsif ($ty eq 'BreakwaterStart') {
1000 $last_anchor = $cur;
1001 $build_start->('FirstPackaging', $cur);
1002 } elsif ($ty eq 'Upstream') {
1006 } elsif ($ty eq 'Mixed') {
1009 my $cls = { %$cl, $xmsg->("split mixed commit: $wh part") };
1012 $queue->(\@brw_cl, "debian");
1013 $queue->(\@upp_cl, "upstream");
1014 $rewrite_from_here->(\@brw_cl);
1017 } elsif ($ty eq 'Pseudomerge') {
1018 my $contrib = $cl->{Contributor}{CommitId};
1019 print $report " Contributor=$contrib" if $report;
1020 push @pseudomerges, $cl;
1021 $rewrite_from_here->(\@upp_cl);
1024 } elsif ($ty eq 'Anchor' or $ty eq 'TreatAsAnchor') {
1025 $last_anchor = $cur;
1026 $build_start->("Anchor", $cur);
1027 } elsif ($ty eq 'DgitImportUnpatched') {
1028 my $pm = $pseudomerges[-1];
1030 # To an extent, this is heuristic. Imports don't have
1031 # a useful history of the debian/ branch. We assume
1032 # that the first pseudomerge after an import has a
1033 # useful history of debian/, and ignore the histories
1034 # from later pseudomerges. Often the first pseudomerge
1035 # will be the dgit import of the upload to the actual
1036 # suite intended by the non-dgit NMUer, and later
1037 # pseudomerges may represent in-archive copies.
1038 my $ovwrs = $pm->{Overwritten};
1039 printf $report " PM=%s \@Overwr:%d",
1040 $pm->{CommitId}, (scalar @$ovwrs)
1043 printdebug "*** WALK BOMB DgitImportUnpatched\n";
1046 my $ovwr = $ovwrs->[0]{CommitId};
1047 printf $report " Overwr=%s", $ovwr if $report;
1048 # This import has a tree which is just like a
1049 # breakwater tree, but it has the wrong history. It
1050 # ought to have the previous breakwater (which the
1051 # pseudomerge overwrote) as an ancestor. That will
1052 # make the history of the debian/ files correct. As
1053 # for the upstream version: either it's the same as
1054 # was ovewritten (ie, same as the previous
1055 # breakwater), in which case that history is precisely
1056 # right; or, otherwise, it was a non-gitish upload of a
1057 # new upstream version. We can tell these apart by
1058 # looking at the tree of the supposed upstream.
1061 SpecialMethod => 'DgitImportDebianUpdate',
1062 $xmsg->("convert dgit import: debian changes")
1065 SpecialMethod => 'DgitImportUpstreamUpdate',
1066 $xmsg->("convert dgit import: upstream update",
1069 $prline->(" Import");
1070 $rewrite_from_here->(\@brw_cl);
1071 $upp_limit //= $#upp_cl; # further, deeper, patches discarded
1075 # Everything is from this import. This kind of import
1076 # is already nearly in valid breakwater format, with the
1077 # patches as commits. Unfortunately it contains
1079 printdebug "*** WALK BOMB bare dgit import\n";
1080 $cl->{Why} = "bare dgit dsc import";
1084 } elsif ($ty eq 'VanillaMerge' or $ty eq 'MergedBreakwaters') {
1085 # User may have merged unstitched branch(es). We will
1086 # have now lost what ffq-prev was then (since the later
1087 # pseudomerge may introduce further changes). The effect
1088 # of resolving such a merge is that we may have to go back
1089 # further in history to find a merge base, since the one
1090 # which was reachable via ffq-prev is no longer findable.
1091 # This is suboptimal, but if it all works we'll have done
1093 # xxx we should warn the user in the docs about this
1097 # We expect to find a dominating anchor amongst the
1098 # inputs' anchors. That will be the new anchor.
1100 # More complicated is finding a merge base for the
1101 # breakwaters. We need a merge base that is a breakwater
1102 # commit. The ancestors of breakwater commits are more
1103 # breakwater commits and possibly upstream commits and the
1104 # ancestors of those upstream. Upstreams might have
1105 # arbitrary ancestors. But any upstream commit U is
1106 # either included in both anchors, in which case the
1107 # earlier anchor is a better merge base than any of U's
1108 # ancestors; or U is not included in the older anchor, in
1109 # which case U is not an ancestor of the vanilla merge at
1110 # all. So no upstream commit, nor any ancestor thereof,
1111 # is a best merge base. As for non-breakwater Debian
1112 # commits: these are never ancestors of any breakwater.
1114 # So any best merge base as found by git-merge-base
1115 # is a suitable breakwater anchor. Usually there will
1118 printdebug "*** MERGE\n";
1120 # xxx avoid calling walk without nogenerate when
1121 # we have a MergedBreakwater; instead call keycommits ?
1123 my @bwbcmd = (@git, qw(merge-base));
1124 my @ibcmd = (@git, qw(merge-base --all));
1125 my $might_be_in_bw = 1;
1127 my $ps = $cl->{Parents};
1129 foreach my $p (@$ps) {
1130 $prline->(" VanillaMerge ".$p->{Ix});
1132 my ($ptip, $pbw, $panchor) =
1133 walk $p->{CommitId}, 0, $report,
1134 $report_lprefix.' ';
1135 $p->{Laundered} = $p->{SeriesTip} = $ptip;
1136 $p->{Breakwater} = $p->{SeriesBase} = $pbw;
1137 $p->{Anchor} = $panchor;
1139 $best_anchor = $panchor if
1140 !defined $best_anchor or
1141 is_fast_fwd $best_anchor, $panchor;
1143 printdebug " MERGE BA best=".($best_anchor//'-').
1147 foreach my $p (@$ps) {
1148 $prline->(" VanillaMerge ".$p->{Ix});
1149 if (!is_fast_fwd $p->{Anchor}, $best_anchor) {
1150 $nomerge->('DivergentAnchor');
1151 } elsif ($p->{Anchor} eq $best_anchor) {
1152 print $report " SameAnchor" if $report;
1154 print $report " SupersededAnchor" if $report;
1156 if ($p->{Breakwater} eq $p->{CommitId}) {
1157 # this parent commit was its own breakwater,
1158 # ie it is part of the breakwater
1159 print $report " Breakwater" if $report;
1161 $might_be_in_bw = 0;
1163 push @bwbcmd, $p->{Breakwater};
1164 push @ibcmd, $p->{CommitId};
1167 if ($ok && $might_be_in_bw) {
1168 $prline->(" VanillaMerge MergedBreakwaters");
1169 $last_anchor = $best_anchor;
1170 $build_start->('MergedBreakwaters', $cur);
1173 $nomerge->("alleged merged-breakwater is not a breakwater")
1174 unless $ty eq 'VanillaMerge';
1176 my $bwb = cmdoutput @bwbcmd;
1178 # OK, now we have a breakwater base, but we need the merge
1179 # base for the interchange branch because we need the delta
1182 # This a the best merge base of our inputs which has the
1183 # breakwater merge base as an ancestor.
1186 grep { is_fast_fwd $bwb, $_ }
1191 or $nomerge->("no suitable interchange merge base");
1193 $prline->(" VanillaMerge Base");
1195 my ($btip, $bbw, $banchor) =
1196 walk $ib, 0, $report, $report_lprefix.' ';
1198 my $ibinfo = { SeriesTip => $btip,
1200 Anchor => $banchor };
1202 or $nomerge->("interchange merge-base ($ib)'s".
1203 " breakwater ($bbw)".
1204 " != breakwaters' merge-base ($bwb)");
1205 grep { $_->{Anchor} eq $ibinfo->{Anchor} } @$ps
1206 or $nomerge->("interchange merge-base ($ib)'s".
1207 " anchor ($ibinfo->{SeriesBase})".
1208 " != any merge input's anchor (".
1209 (join ' ', map { $_->{Anchor} } @$ps).
1213 $cl->{MergeInterchangeBaseInfo} = $ibinfo;
1214 $cl->{MergeBestAnchor} = $best_anchor;
1217 SpecialMethod => 'MergeCreateMergedBreakwaters',
1218 $xmsg->('construct merged breakwater from vanilla merge'),
1222 SpecialMethod => 'MergeMergeSeries',
1224 $build_start->('MergeBreakwaters', $cur);
1226 printdebug "*** WALK BOMB unrecognised\n";
1232 printdebug "*** WALK prep done cur=$cur".
1233 " brw $#brw_cl upp $#upp_cl proc $#processed pm $#pseudomerges\n";
1235 return if $nogenerate;
1237 # Now we build it back up again
1243 $#upp_cl = $upp_limit if defined $upp_limit;
1245 my $committer_authline = calculate_committer_authline();
1247 printdebug "WALK REBUILD $build ".(scalar @processed)."\n";
1249 confess "internal error" unless $build eq (pop @processed)->{CommitId};
1252 mkdir $rd or $!==EEXIST or die $!;
1254 runcmd @git, qw(read-tree), $build;
1255 foreach my $cl (qw(Debian), (reverse @brw_cl),
1256 { SpecialMethod => 'RecordBreakwaterTip' },
1257 qw(Upstream), (reverse @upp_cl)) {
1259 $current_method = $cl;
1262 my $method = $cl->{SpecialMethod} // $current_method;
1263 my @parents = ($build);
1264 my $cltree = $cl->{CommitId};
1265 printdebug "WALK BUILD ".($cltree//'undef').
1266 " $method (rewriting=$rewriting)\n";
1267 if ($method eq 'Debian') {
1268 read_tree_debian($cltree);
1269 } elsif ($method eq 'Upstream') {
1270 read_tree_upstream($cltree);
1271 } elsif ($method eq 'StartRewrite') {
1274 } elsif ($method eq 'RecordBreakwaterTip') {
1275 $breakwater = $build;
1277 } elsif ($method eq 'DgitImportDebianUpdate') {
1278 read_tree_debian($cltree);
1279 } elsif ($method eq 'DgitImportUpstreamUpdate') {
1280 confess unless $rewriting;
1281 my $differs = (get_differs $build, $cltree);
1282 next unless $differs & D_UPS;
1283 read_tree_upstream($cltree);
1284 push @parents, map { $_->{CommitId} } @{ $cl->{OrigParents} };
1285 } elsif ($method eq 'MergeCreateMergedBreakwaters') {
1286 print "Found a general merge, will try to tidy it up.\n";
1288 read_tree_upstream($cl->{MergeBestAnchor});
1289 read_tree_upstream($cl->{MergeBestAnchor});
1290 read_tree_debian($cltree);
1291 @parents = map { $_->{Breakwater} } @{ $cl->{Parents} };
1292 } elsif ($method eq 'MergeMergeSeries') {
1293 print "Running merge resolution for $cl->{CommitId}...\n";
1294 $build = merge_series
1296 $cl->{MergeInterchangeBaseInfo},
1297 @{ $cl->{Parents} };
1298 $last_anchor = $cl->{MergeBestAnchor};
1299 my $check_differs = get_differs $build, $cl->{CommitId};
1300 # Breakwater changes which were in each side of the
1301 # merge should be in MergeCreateMergedBreakwaters
1302 # output. Upstream changes are exactly the result
1303 # of merge_series. So the only difference should
1304 # be potential laundry results.
1306 "merge misresolved: tree is not the same (%s %s d.%#x)",
1307 $cl->{CommitId}, $build, $check_differs)
1308 if $check_differs & ~D_PAT_ADD;
1309 print "Merge resolution successful.\n";
1312 confess "$method ?";
1315 my $procd = (pop @processed) // 'UNDEF';
1316 if ($cl ne $procd) {
1318 printdebug "WALK REWRITING NOW cl=$cl procd=$procd\n";
1321 my $newtree = cmdoutput @git, qw(write-tree);
1322 my $ch = $cl->{Hdr};
1323 $ch =~ s{^tree .*}{tree $newtree}m or confess "$ch ?";
1324 $ch =~ s{^parent .*\n}{}mg;
1325 $ch =~ s{(?=^author)}{
1326 join '', map { "parent $_\n" } @parents
1327 }me or confess "$ch ?";
1329 $ch =~ s{^committer .*$}{$committer_authline}m
1332 my $cf = "$rd/m$rewriting";
1333 open CD, ">", $cf or die $!;
1334 print CD $ch, "\n", $cl->{Msg} or die $!;
1336 my @cmd = (@git, qw(hash-object));
1337 push @cmd, qw(-w) if $rewriting;
1338 push @cmd, qw(-t commit), $cf;
1339 my $newcommit = cmdoutput @cmd;
1340 confess "$ch ?" unless $rewriting or $newcommit eq $cl->{CommitId};
1341 $build = $newcommit;
1342 if (grep { $method eq $_ } qw(DgitImportUpstreamUpdate)) {
1343 $last_anchor = $cur;
1348 my $final_check = get_differs $build, $input;
1349 die sprintf "internal error %#x %s %s", $final_check, $input, $build
1350 if $final_check & ~D_PAT_ADD;
1352 my @r = ($build, $breakwater, $last_anchor);
1353 printdebug "*** WALK RETURN @r\n";
1358 git_check_unmodified();
1359 return git_rev_parse qw(HEAD);
1362 sub update_head ($$$) {
1363 my ($old, $new, $mrest) = @_;
1364 push @deferred_updates, "update HEAD $new $old";
1365 run_deferred_updates $mrest;
1368 sub update_head_checkout ($$$) {
1369 my ($old, $new, $mrest) = @_;
1370 update_head $old, $new, $mrest;
1371 runcmd @git, qw(reset --hard);
1374 sub update_head_postlaunder ($$$) {
1375 my ($old, $tip, $reflogmsg) = @_;
1376 return if $tip eq $old;
1377 print "git-debrebase: laundered (head was $old)\n";
1378 update_head $old, $tip, $reflogmsg;
1379 # no tree changes except debian/patches
1380 runcmd @git, qw(rm --quiet --ignore-unmatch -rf debian/patches);
1383 sub currently_rebasing() {
1384 foreach (qw(rebase-merge rebase-apply)) {
1385 return 1 if stat_exists "$maindir_gitdir/$_";
1390 sub bail_if_rebasing() {
1391 fail "you are in the middle of a git-rebase already"
1392 if currently_rebasing();
1395 sub do_launder_head ($) {
1396 my ($reflogmsg) = @_;
1397 my $old = get_head();
1399 my ($tip,$breakwater) = walk $old;
1401 update_head_postlaunder $old, $tip, $reflogmsg;
1402 return ($tip,$breakwater);
1405 sub cmd_launder_v0 () {
1406 badusage "no arguments to launder-v0 allowed" if @ARGV;
1407 my $old = get_head();
1408 my ($tip,$breakwater,$last_anchor) = walk $old;
1409 update_head_postlaunder $old, $tip, 'launder';
1410 printf "# breakwater tip\n%s\n", $breakwater;
1411 printf "# working tip\n%s\n", $tip;
1412 printf "# last anchor\n%s\n", $last_anchor;
1415 sub defaultcmd_rebase () {
1416 push @ARGV, @{ $opt_defaultcmd_interactive // [] };
1417 my ($tip,$breakwater) = do_launder_head 'launder for rebase';
1418 runcmd @git, qw(rebase), @ARGV, $breakwater if @ARGV;
1421 sub cmd_analyse () {
1422 badusage "analyse does not support any options"
1423 if @ARGV and $ARGV[0] =~ m/^-/;
1424 badusage "too many arguments to analyse" if @ARGV>1;
1427 $old = git_rev_parse $old;
1429 $old = git_rev_parse 'HEAD';
1431 my ($dummy,$breakwater) = walk $old, 1,*STDOUT;
1432 STDOUT->error and die $!;
1435 sub ffq_prev_branchinfo () {
1436 my $current = git_get_symref();
1437 return gdr_ffq_prev_branchinfo($current);
1440 sub ffq_check ($;$$) {
1441 # calls $ff and/or $notff zero or more times
1442 # then returns either (status,message) where status is
1447 # or (undef,undef, $ffq_prev,$gdrlast)
1448 # $ff and $notff are called like this:
1449 # $ff->("message for stdout\n");
1450 # $notff->('snag-name', $message);
1451 # normally $currentval should be HEAD
1452 my ($currentval, $ff, $notff) =@_;
1454 $ff //= sub { print $_[0] or die $!; };
1457 my ($status, $message, $current, $ffq_prev, $gdrlast)
1458 = ffq_prev_branchinfo();
1459 return ($status, $message) unless $status eq 'branch';
1461 my $exists = git_get_ref $ffq_prev;
1462 return ('exists',"$ffq_prev already exists") if $exists;
1464 return ('not-branch', 'HEAD symref is not to refs/heads/')
1465 unless $current =~ m{^refs/heads/};
1468 my @check_specs = split /\;/, (cfg "branch.$branch.ffq-ffrefs",1) // '*';
1471 printdebug "ffq check_specs @check_specs\n";
1474 my ($lrref, $desc) = @_;
1475 printdebug "ffq might check $lrref ($desc)\n";
1477 for my $chk (@check_specs) {
1479 $invert = $glob =~ s{^[!^]}{};
1480 last if fnmatch $glob, $lrref;
1483 my $lrval = git_get_ref $lrref;
1484 return unless length $lrval;
1486 if (is_fast_fwd $lrval, $currentval) {
1487 $ff->("OK, you are ahead of $lrref\n");
1488 $checked{$lrref} = 1;
1489 } elsif (is_fast_fwd $currentval, $lrval) {
1490 $checked{$lrref} = -1;
1491 $notff->('behind', "you are behind $lrref, divergence risk");
1493 $checked{$lrref} = -1;
1494 $notff->('diverged', "you have diverged from $lrref");
1498 my $merge = cfg "branch.$branch.merge",1;
1499 if (defined $merge and $merge =~ m{^refs/heads/}) {
1501 printdebug "ffq merge $rhs\n";
1502 my $check_remote = sub {
1503 my ($remote, $desc) = @_;
1504 printdebug "ffq check_remote ".($remote//'undef')." $desc\n";
1505 return unless defined $remote;
1506 $check->("refs/remotes/$remote/$rhs", $desc);
1508 $check_remote->((scalar cfg "branch.$branch.remote",1),
1509 'remote fetch/merge branch');
1510 $check_remote->((scalar cfg "branch.$branch.pushRemote",1) //
1511 (scalar cfg "branch.$branch.pushDefault",1),
1512 'remote push branch');
1514 if ($branch =~ m{^dgit/}) {
1515 $check->("refs/remotes/dgit/$branch", 'remote dgit branch');
1516 } elsif ($branch =~ m{^master$}) {
1517 $check->("refs/remotes/dgit/dgit/sid", 'remote dgit branch for sid');
1519 return (undef, undef, $ffq_prev, $gdrlast);
1522 sub record_ffq_prev_deferred () {
1523 # => ('status', "message")
1525 # deferred message is undef
1530 # if not ff from some branch we should be ff from, is an snag
1531 # if "deferred", will have added something about that to
1532 # @deferred_update_messages, and also maybe printed (already)
1533 # some messages about ff checks
1535 my $currentval = get_head();
1537 my ($status,$message, $ffq_prev,$gdrlast) = ffq_check $currentval;
1538 return ($status,$message) if defined $status;
1542 push @deferred_updates, "update $ffq_prev $currentval $git_null_obj";
1543 push @deferred_updates, "delete $gdrlast";
1544 push @deferred_update_messages, "Recorded previous head for preservation";
1545 return ('deferred', undef);
1548 sub record_ffq_auto () {
1549 my ($status, $message) = record_ffq_prev_deferred();
1550 if ($status eq 'deferred' || $status eq 'exists') {
1552 snag $status, "could not record ffq-prev: $message";
1557 sub ffq_prev_info () {
1559 # => ($ffq_prev, $gdrlast, $ffq_prev_commitish)
1560 my ($status, $message, $current, $ffq_prev, $gdrlast)
1561 = ffq_prev_branchinfo();
1562 if ($status ne 'branch') {
1563 snag $status, "could not check ffq-prev: $message";
1566 my $ffq_prev_commitish = $ffq_prev && git_get_ref $ffq_prev;
1567 return ($ffq_prev, $gdrlast, $ffq_prev_commitish);
1570 sub stitch ($$$$$) {
1571 my ($old_head, $ffq_prev, $gdrlast, $ffq_prev_commitish, $prose) = @_;
1573 push @deferred_updates, "delete $ffq_prev $ffq_prev_commitish";
1575 if (is_fast_fwd $old_head, $ffq_prev_commitish) {
1576 my $differs = get_differs $old_head, $ffq_prev_commitish;
1577 unless ($differs & ~D_PAT_ADD) {
1578 # ffq-prev is ahead of us, and the only tree changes it has
1579 # are possibly addition of things in debian/patches/.
1580 # Just wind forwards rather than making a pointless pseudomerge.
1581 push @deferred_updates,
1582 "update $gdrlast $ffq_prev_commitish $git_null_obj";
1583 update_head_checkout $old_head, $ffq_prev_commitish,
1584 "stitch (fast forward)";
1589 # We make pseudomerges with L as the contributing parent.
1590 # This makes git rev-list --first-parent work properly.
1591 my $new_head = make_commit [ $old_head, $ffq_prev ], [
1592 'Declare fast forward / record previous work',
1593 "[git-debrebase pseudomerge: $prose]",
1595 push @deferred_updates, "update $gdrlast $new_head $git_null_obj";
1596 update_head $old_head, $new_head, "stitch: $prose";
1599 sub do_stitch ($;$) {
1600 my ($prose, $unclean) = @_;
1602 my ($ffq_prev, $gdrlast, $ffq_prev_commitish) = ffq_prev_info();
1603 if (!$ffq_prev_commitish) {
1604 fail "No ffq-prev to stitch." unless $opt_noop_ok;
1607 my $dangling_head = get_head();
1609 keycommits $dangling_head, $unclean,$unclean,$unclean;
1612 stitch($dangling_head, $ffq_prev, $gdrlast, $ffq_prev_commitish, $prose);
1615 sub upstream_commitish_search ($$) {
1616 my ($upstream_version, $tried) = @_;
1617 # todo: at some point maybe use git-deborig to do this
1618 foreach my $tagpfx ('', 'v', 'upstream/') {
1619 my $tag = $tagpfx.(dep14_version_mangle $upstream_version);
1620 my $new_upstream = git_get_ref "refs/tags/$tag";
1622 return $new_upstream if length $new_upstream;
1626 sub resolve_upstream_version ($$) {
1627 my ($new_upstream, $upstream_version) = @_;
1629 if (!defined $new_upstream) {
1631 $new_upstream = upstream_commitish_search $upstream_version, \@tried;
1632 if (!length $new_upstream) {
1633 fail "Could not determine appropriate upstream commitish.\n".
1634 " (Tried these tags: @tried)\n".
1635 " Check version, and specify upstream commitish explicitly.";
1638 $new_upstream = git_rev_parse $new_upstream;
1640 return $new_upstream;
1643 sub cmd_new_upstream () {
1644 # automatically and unconditionally launders before rebasing
1645 # if rebase --abort is used, laundering has still been done
1649 badusage "need NEW-VERSION [UPS-COMMITTISH]" unless @ARGV >= 1;
1651 # parse args - low commitment
1652 my $spec_version = shift @ARGV;
1653 my $new_version = (new Dpkg::Version $spec_version, check => 1);
1654 fail "bad version number \`$spec_version'" unless defined $new_version;
1655 if ($new_version->is_native()) {
1656 $new_version = (new Dpkg::Version "$spec_version-1", check => 1);
1659 my $new_upstream = shift @ARGV;
1660 my $new_upstream_version = upstreamversion $new_version;
1662 resolve_upstream_version $new_upstream, $new_upstream_version;
1667 my ($n, @x) = @_; # may be ''
1668 my $pc = $pieces{$n} //= {
1670 Desc => ($n ? "upstream piece \`$n'" : "upstream (main piece"),
1672 while (my $k = shift @x) { $pc->{$k} = shift @x; }
1677 my $newpiece = sub {
1678 my ($n, @x) = @_; # may be ''
1679 my $pc = $piece->($n, @x, NewIx => (scalar @newpieces));
1680 push @newpieces, $pc;
1685 New => $new_upstream,
1687 while (@ARGV && $ARGV[0] !~ m{^-}) {
1688 my $n = shift @ARGV;
1690 badusage "for each EXTRA-UPS-NAME need EXTRA-UPS-COMMITISH"
1691 unless @ARGV && $ARGV[0] !~ m{^-};
1693 my $c = git_rev_parse shift @ARGV;
1694 die unless $n =~ m/^$extra_orig_namepart_re$/;
1695 $newpiece->($n, New => $c);
1698 # now we need to investigate the branch this generates the
1699 # laundered version but we don't switch to it yet
1700 my $old_head = get_head();
1701 my ($old_laundered_tip,$old_bw,$old_anchor) = walk $old_head;
1703 my $old_bw_cl = classify $old_bw;
1704 my $old_anchor_cl = classify $old_anchor;
1706 if (!$old_anchor_cl->{OrigParents}) {
1707 snag 'anchor-treated',
1708 'old anchor is recognised due to --anchor, cannot check upstream';
1710 $old_upstream = parsecommit
1711 $old_anchor_cl->{OrigParents}[0]{CommitId};
1712 $piece->('', Old => $old_upstream->{CommitId});
1715 if ($old_upstream && $old_upstream->{Msg} =~ m{^\[git-debrebase }m) {
1716 if ($old_upstream->{Msg} =~
1717 m{^\[git-debrebase upstream-combine (\.(?: $extra_orig_namepart_re)+)\:.*\]$}m
1719 my @oldpieces = (split / /, $1);
1720 my $old_n_parents = scalar @{ $old_upstream->{Parents} };
1721 if ($old_n_parents != @oldpieces &&
1722 $old_n_parents != @oldpieces + 1) {
1723 snag 'upstream-confusing', sprintf
1724 "previous upstream combine %s".
1725 " mentions %d pieces (each implying one parent)".
1726 " but has %d parents".
1727 " (one per piece plus maybe a previous combine)",
1728 $old_upstream->{CommitId},
1729 (scalar @oldpieces),
1731 } elsif ($oldpieces[0] ne '.') {
1732 snag 'upstream-confusing', sprintf
1733 "previous upstream combine %s".
1734 " first piece is not \`.'",
1738 foreach my $i (0..$#oldpieces) {
1739 my $n = $oldpieces[$i];
1740 my $hat = 1 + $i + ($old_n_parents - @oldpieces);
1741 $piece->($n, Old => $old_upstream->{CommitId}.'^'.$hat);
1745 snag 'upstream-confusing',
1746 "previous upstream $old_upstream->{CommitId} is from".
1747 " git-debrebase but not an \`upstream-combine' commit";
1751 foreach my $pc (values %pieces) {
1752 if (!$old_upstream) {
1753 # we have complained already
1754 } elsif (!$pc->{Old}) {
1755 snag 'upstream-new-piece',
1756 "introducing upstream piece \`$pc->{Name}'";
1757 } elsif (!$pc->{New}) {
1758 snag 'upstream-rm-piece',
1759 "dropping upstream piece \`$pc->{Name}'";
1760 } elsif (!is_fast_fwd $pc->{Old}, $pc->{New}) {
1761 snag 'upstream-not-ff',
1762 "not fast forward: $pc->{Name} $pc->{Old}..$pc->{New}";
1766 printdebug "%pieces = ", (dd \%pieces), "\n";
1767 printdebug "\@newpieces = ", (dd \@newpieces), "\n";
1775 my @upstream_merge_parents;
1778 push @upstream_merge_parents, $old_upstream->{CommitId};
1781 foreach my $pc (@newpieces) { # always has '' first
1783 read_tree_subdir $pc->{Name}, $pc->{New};
1785 runcmd @git, qw(read-tree), $pc->{New};
1787 push @upstream_merge_parents, $pc->{New};
1790 # index now contains the new upstream
1792 if (@newpieces > 1) {
1793 # need to make the upstream subtree merge commit
1794 $new_upstream = make_commit \@upstream_merge_parents,
1795 [ "Combine upstreams for $new_upstream_version",
1796 ("[git-debrebase upstream-combine . ".
1797 (join " ", map { $_->{Name} } @newpieces[1..$#newpieces]).
1802 # $new_upstream is either the single upstream commit, or the
1803 # combined commit we just made. Either way it will be the
1804 # "upstream" parent of the anchor merge.
1806 read_tree_subdir 'debian', "$old_bw:debian";
1808 # index now contains the anchor merge contents
1809 $new_bw = make_commit [ $old_bw, $new_upstream ],
1810 [ "Update to upstream $new_upstream_version",
1811 "[git-debrebase anchor: new upstream $new_upstream_version, merge]",
1814 my $clogsignoff = cmdoutput qw(git show),
1815 '--pretty=format:%an <%ae> %aD',
1818 # Now we have to add a changelog stanza so the Debian version
1820 die if unlink "debian";
1821 die $! unless $!==ENOENT or $!==ENOTEMPTY;
1822 unlink "debian/changelog" or $!==ENOENT or die $!;
1823 mkdir "debian" or die $!;
1824 open CN, ">", "debian/changelog" or die $!;
1825 my $oldclog = git_cat_file ":debian/changelog";
1826 $oldclog =~ m/^($package_re) \(\S+\) / or
1827 fail "cannot parse old changelog to get package name";
1829 print CN <<END, $oldclog or die $!;
1830 $p ($new_version) UNRELEASED; urgency=medium
1832 * Update to new upstream version $new_upstream_version.
1838 runcmd @git, qw(update-index --add --replace), 'debian/changelog';
1840 # Now we have the final new breakwater branch in the index
1841 $new_bw = make_commit [ $new_bw ],
1842 [ "Update changelog for new upstream $new_upstream_version",
1843 "[git-debrebase: new upstream $new_upstream_version, changelog]",
1847 # we have constructed the new breakwater. we now need to commit to
1848 # the laundering output, because git-rebase can't easily be made
1849 # to make a replay list which is based on some other branch
1851 update_head_postlaunder $old_head, $old_laundered_tip,
1852 'launder for new upstream';
1854 my @cmd = (@git, qw(rebase --onto), $new_bw, $old_bw, @ARGV);
1855 local $ENV{GIT_REFLOG_ACTION} = git_reflog_action_msg
1856 "debrebase new-upstream $new_version: rebase";
1858 # now it's for the user to sort out
1861 sub cmd_record_ffq_prev () {
1862 badusage "no arguments allowed" if @ARGV;
1863 my ($status, $msg) = record_ffq_prev_deferred();
1864 if ($status eq 'exists' && $opt_noop_ok) {
1865 print "Previous head already recorded\n" or die $!;
1866 } elsif ($status eq 'deferred') {
1867 run_deferred_updates 'record-ffq-prev';
1869 fail "Could not preserve: $msg";
1874 badusage "no arguments allowed" if @ARGV;
1875 my ($anchor, $bw) = keycommits +(git_rev_parse 'HEAD'), 0,0;
1876 print "$bw\n" or die $!;
1879 sub cmd_breakwater () {
1880 badusage "no arguments allowed" if @ARGV;
1881 my ($anchor, $bw) = keycommits +(git_rev_parse 'HEAD'), 0,0;
1882 print "$bw\n" or die $!;
1886 badusage "no arguments allowed" if @ARGV;
1888 # todo: gdr status should print divergence info
1889 # todo: gdr status should print upstream component(s) info
1890 # todo: gdr should leave/maintain some refs with this kind of info ?
1892 my $oldest = { Badness => 0 };
1895 my ($badness, $ourmsg, $snagname, $dummy, $cl, $kcmsg) = @_;
1896 if ($oldest->{Badness} < $badness) {
1897 $oldest = $newest = undef;
1900 Badness => $badness,
1901 CommitId => $cl->{CommitId},
1905 $newest //= $oldest;
1907 my ($anchor, $bw) = keycommits +(git_rev_parse 'HEAD'),
1908 sub { $note->(1, 'branch contains furniture (not laundered)', @_); },
1909 sub { $note->(2, 'branch is unlaundered', @_); },
1910 sub { $note->(3, 'branch needs laundering', @_); },
1911 sub { $note->(4, 'branch not in git-debrebase form', @_); };
1913 my $prcommitinfo = sub {
1915 flush STDOUT or die $!;
1916 runcmd @git, qw(--no-pager log -n1),
1917 '--pretty=format: %h %s%n',
1921 print "current branch contents, in git-debrebase terms:\n";
1922 if (!$oldest->{Badness}) {
1923 print " branch is laundered\n";
1925 print " $oldest->{OurMsg}\n";
1927 foreach my $info ($oldest, $newest) {
1928 my $cid = $info->{CommitId};
1929 next if $cid eq $printed;
1931 print " $info->{KcMsg}\n";
1932 $prcommitinfo->($cid);
1937 my ($cid, $what) = @_;
1938 if (!defined $cid) {
1939 print " $what is not well-defined\n";
1942 $prcommitinfo->($cid);
1945 print "key git-debrebase commits:\n";
1946 $prab->($anchor, 'anchor');
1947 $prab->($bw, 'breakwater');
1949 my ($ffqstatus, $ffq_msg, $current, $ffq_prev, $gdrlast) =
1950 ffq_prev_branchinfo();
1952 print "branch and ref status, in git-debrebase terms:\n";
1954 print " $ffq_msg\n";
1956 $ffq_prev = git_get_ref $ffq_prev;
1957 $gdrlast = git_get_ref $gdrlast;
1959 print " unstitched; previous tip was:\n";
1960 $prcommitinfo->($ffq_prev);
1961 } elsif (!$gdrlast) {
1962 print " stitched? (no record of git-debrebase work)\n";
1963 } elsif (is_fast_fwd $gdrlast, 'HEAD') {
1964 print " stitched\n";
1966 print " not git-debrebase (diverged since last stitch)\n"
1969 print "you are currently rebasing\n" if currently_rebasing();
1973 my $prose = 'stitch';
1974 getoptions("stitch",
1975 'prose=s', \$prose);
1976 badusage "no arguments allowed" if @ARGV;
1977 do_stitch $prose, 0;
1979 sub cmd_prepush () { cmd_stitch(); }
1982 badusage "no arguments allowed" if @ARGV;
1983 do_launder_head 'launder for git-debrebase quick';
1987 sub cmd_conclude () {
1988 my ($ffq_prev, $gdrlast, $ffq_prev_commitish) = ffq_prev_info();
1989 if (!$ffq_prev_commitish) {
1990 fail "No ongoing git-debrebase session." unless $opt_noop_ok;
1993 my $dangling_head = get_head();
1995 badusage "no arguments allowed" if @ARGV;
1996 do_launder_head 'launder for git-debrebase quick';
2001 if (currently_rebasing()) {
2002 runcmd @git, qw(rebase --abort);
2004 my ($ffq_prev, $gdrlast, $ffq_prev_commitish) = ffq_prev_info();
2005 if (!$ffq_prev_commitish) {
2006 fail "No ongoing git-debrebase session." unless $opt_noop_ok;
2009 my $scrapping_head = get_head();
2010 badusage "no arguments allowed" if @ARGV;
2011 push @deferred_updates,
2012 "update $gdrlast $ffq_prev_commitish $git_null_obj",
2013 "update $ffq_prev $git_null_obj $ffq_prev_commitish";
2015 update_head_checkout $scrapping_head, $ffq_prev_commitish, "scrap";
2018 sub make_patches_staged ($) {
2020 # Produces the patches that would result from $head if it were
2022 my ($secret_head, $secret_bw, $last_anchor) = walk $head;
2025 gbp_pq_export 'bw', $secret_bw, $secret_head;
2029 sub make_patches ($) {
2031 keycommits $head, 0, \&snag;
2032 make_patches_staged $head;
2035 my $ptree = cmdoutput @git, qw(write-tree --prefix=debian/patches/);
2036 runcmd @git, qw(read-tree), $head;
2037 read_tree_subdir 'debian/patches', $ptree;
2038 $out = make_commit [$head], [
2039 'Commit patch queue (exported by git-debrebase)',
2040 '[git-debrebase: export and commit patches]',
2046 sub cmd_make_patches () {
2047 my $opt_quiet_would_amend;
2048 getoptions("make-patches",
2049 'quiet-would-amend!', \$opt_quiet_would_amend);
2050 badusage "no arguments allowed" if @ARGV;
2052 my $old_head = get_head();
2053 my $new = make_patches $old_head;
2054 my $d = get_differs $old_head, $new;
2056 fail "No (more) patches to export." unless $opt_noop_ok;
2058 } elsif ($d == D_PAT_ADD) {
2060 update_head_checkout $old_head, $new, 'make-patches';
2062 print STDERR failmsg
2063 "Patch export produced patch amendments".
2064 " (abandoned output commit $new).".
2065 " Try laundering first."
2066 unless $opt_quiet_would_amend;
2071 sub cmd_convert_from_gbp () {
2072 badusage "want only 1 optional argument, the upstream git commitish"
2075 my $clogp = parsechangelog();
2076 my $version = $clogp->{'Version'}
2077 // die "missing Version from changelog";
2079 my ($upstream_spec) = @ARGV;
2081 my $upstream_version = upstreamversion $version;
2083 resolve_upstream_version($upstream_spec, $upstream_version);
2085 my $old_head = get_head();
2087 my $upsdiff = get_differs $upstream, $old_head;
2088 if ($upsdiff & D_UPS) {
2089 runcmd @git, qw(--no-pager diff --stat),
2090 $upstream, $old_head,
2091 qw( -- :!/debian :/);
2093 upstream ($upstream_spec) and HEAD are not
2094 identical in upstream files. See diffstat above, or run
2095 git diff $upstream_spec HEAD -- :!/debian :/
2099 if (!is_fast_fwd $upstream, $old_head) {
2100 snag 'upstream-not-ancestor',
2101 "upstream ($upstream) is not an ancestor of HEAD";
2103 my $wrong = cmdoutput
2104 (@git, qw(rev-list --ancestry-path), "$upstream..HEAD",
2105 qw(-- :/ :!/debian));
2106 if (length $wrong) {
2107 snag 'unexpected-upstream-changes',
2108 "history between upstream ($upstream) and HEAD contains direct changes to upstream files - are you sure this is a gbp (patches-unapplied) branch?";
2109 print STDERR "list expected changes with: git log --stat --ancestry-path $upstream_spec..HEAD -- :/ ':!/debian'\n";
2113 if ((git_cat_file "$upstream:debian")[0] ne 'missing') {
2114 snag 'upstream-has-debian',
2115 "upstream ($upstream) contains debian/ directory";
2118 my $previous_dgit_view = eval {
2119 my @clogcmd = qw(dpkg-parsechangelog --format rfc822 -n2);
2121 parsechangelog_loop \@clogcmd, 'debian/changelog', sub {
2122 my ($stz, $desc) = @_;
2123 no warnings qw(exiting);
2124 printdebug 'CHANGELOG ', Dumper($desc, $stz);
2125 next unless $stz->{Date};
2126 next unless $stz->{Distribution} ne 'UNRELEASED';
2127 $lvsn = $stz->{Version};
2128 $suite = $stz->{Distribution};
2131 die "neither of the first two changelog entries are released\n"
2132 unless defined $lvsn;
2133 print "last finished-looking changelog entry: ($lvsn) $suite\n";
2134 my $mtag_pat = debiantag_maintview $lvsn, '*';
2135 my $mtag = cmdoutput @git, qw(describe --always --abbrev=0 --match),
2137 die "could not find suitable maintainer view tag $mtag_pat\n"
2138 unless $mtag_pat =~ m{/};
2139 is_fast_fwd $mtag, 'HEAD' or
2140 die "HEAD is not FF from maintainer tag $mtag!";
2141 my $dtag = "archive/$mtag";
2142 is_fast_fwd $mtag, $dtag or
2143 die "dgit view tag $dtag is not FF from maintainer tag $mtag";
2144 print "will stitch in dgit view, $dtag\n";
2145 git_rev_parse $dtag;
2147 if (!$previous_dgit_view) {
2150 print STDERR "cannot stitch in dgit view: $@\n";
2153 snags_maybe_bail_early();
2159 runcmd @git, qw(checkout -q -b gdr-internal), $old_head;
2160 # make a branch out of the patch queue - we'll want this in a mo
2161 runcmd qw(gbp pq import);
2162 # strip the patches out
2163 runcmd @git, qw(checkout -q gdr-internal~0);
2164 rm_subdir_cached 'debian/patches';
2165 $work = make_commit ['HEAD'], [
2166 'git-debrebase convert-from-gbp: drop patches from tree',
2167 'Delete debian/patches, as part of converting to git-debrebase format.',
2168 '[git-debrebase convert-from-gbp: drop patches from tree]'
2170 # make the anchor merge
2171 # the tree is already exactly right
2172 $work = make_commit [$work, $upstream], [
2173 'git-debrebase import: declare upstream',
2174 'First breakwater merge.',
2175 '[git-debrebase anchor: declare upstream]'
2178 # rebase the patch queue onto the new breakwater
2179 runcmd @git, qw(reset --quiet --hard patch-queue/gdr-internal);
2180 runcmd @git, qw(rebase --quiet --onto), $work, qw(gdr-internal);
2181 $work = git_rev_parse 'HEAD';
2183 if ($previous_dgit_view) {
2184 $work = make_commit [$work, $previous_dgit_view], [
2185 'git-debrebase import: declare ff from dgit archive view',
2186 '[git-debrebase pseudomerge: import-from-gbp]',
2193 update_head_checkout $old_head, $work, 'convert-from-gbp';
2196 sub cmd_convert_to_gbp () {
2197 badusage "no arguments allowed" if @ARGV;
2198 my $head = get_head();
2199 my (undef, undef, undef, $ffq, $gdrlast) = ffq_prev_branchinfo();
2200 keycommits $head, 0;
2202 make_patches_staged $head;
2204 $out = make_commit ['HEAD'], [
2205 'Commit patch queue (converted from git-debrebase format)',
2206 '[git-debrebase convert-to-gbp: commit patches]',
2210 push @deferred_updates, "delete $ffq";
2211 push @deferred_updates, "delete $gdrlast";
2214 update_head_checkout $head, $out, "convert to gbp (v0)";
2215 print <<END or die $!;
2216 git-debrebase: converted to git-buildpackage branch format
2217 git-debrebase: WARNING: do not now run "git-debrebase" any more
2218 git-debrebase: WARNING: doing so would drop all upstream patches!
2222 sub cmd_convert_from_dgit_view () {
2223 my $clogp = parsechangelog();
2225 my $bpd = (cfg 'dgit.default.build-products-dir',1) // '..';
2231 getoptions("convert-from-dgit-view",
2232 'diagnose!', \$diagnose,
2233 'build-products-dir:s', \$bpd,
2234 'origs!', \$do_origs,
2236 'always-convert-anyway!', \$always);
2237 fail "takes 1 optional argument, the upstream commitish" if @ARGV>1;
2242 my $spec = shift @ARGV;
2243 my $commit = git_rev_parse "$spec^{commit}";
2244 push @upstreams, { Commit => $commit,
2245 Source => "$ARGV[0], from command line",
2250 my $head = get_head();
2254 my $trouble = sub { $troubles++; };
2255 keycommits $head, sub{}, sub{}, $trouble, $trouble;
2256 printdebug "troubles=$troubles\n";
2259 $us: Branch already seems to be in git-debrebase format!
2260 $us: --always-convert-anyway would do the conversion operation anyway
2261 $us: but is probably a bad idea. Probably, you wanted to do nothing.
2263 fail "Branch already in git-debrebase format." unless $opt_noop_ok;
2268 snags_maybe_bail_early();
2270 my $version = upstreamversion $clogp->{Version};
2271 print STDERR "Considering possible commits corresponding to upstream:\n";
2276 my $ups_tag = upstream_commitish_search $version, \@tried;
2278 my $this = "git tag $tried[-1]";
2279 push @upstreams, { Commit => $ups_tag,
2284 " git tag: no suitable tag found (tried %s)\n",
2289 my $p = $clogp->{'Source'};
2290 # we do a quick check to see if there are plausible origs
2292 if (!opendir BPD, $bpd) {
2293 die "$bpd: opendir: $!" unless $!==ENOENT;
2295 while ($!=0, my $f = readdir BPD) {
2296 next unless is_orig_file_of_p_v $f, $p, $version;
2298 " orig: found what looks like a .orig, %s\n",
2303 die "read $bpd: $!" if $!;
2307 my $tree = cmdoutput
2308 @dgit, qw(--build-products-dir), $bpd,
2309 qw(print-unapplied-treeish);
2312 runcmd @git, qw(reset --quiet), $tree, qw(-- .);
2313 rm_subdir_cached 'debian';
2314 $tree = cmdoutput @git, qw(write-tree);
2315 my $ups_synth = make_commit [], [ <<END, <<END,
2316 Import effective orig tree for upstream version $version
2318 This includes the contents of the .orig(s), minus any debian/ directory.
2320 [git-debrebase import-from-dgit-view upstream-import-convert: $version]
2323 push @upstreams, { Commit => $ups_synth,
2324 Source => "orig(s) imported via dgit",
2329 " orig: no suitable origs found (looked for %s in %s)\n",
2330 "${p}_".(stripeoch $version)."...", $bpd;
2335 my $some_patches = stat_exists 'debian/patches/series';
2337 print STDERR "Evaluating possible commits corresponding to upstream:\n";
2340 foreach my $u (@upstreams) {
2344 runcmd @git, qw(reset --quiet), $u->{Commit}, qw(-- .);
2345 runcmd @git, qw(checkout), $u->{Commit}, qw(-- .);
2346 runcmd @git, qw(clean -xdff);
2347 runcmd @git, qw(checkout), $head, qw(-- debian);
2348 if ($some_patches) {
2349 rm_subdir_cached 'debian/patches';
2350 $work = make_commit [ $work ], [
2351 'git-debrebase convert-from-dgit-view: drop upstream changes from breakwater',
2352 "Drop upstream changes, and delete debian/patches, as part of converting\n".
2353 "to git-debrebase format. Upstream changes will appear as commits.",
2354 '[git-debrebase convert-from-dgit-view: drop patches from tree]'
2357 $work = make_commit [ $work, $u->{Commit} ], [
2358 'git-debrebase convert-from-dgit-view: declare upstream',
2359 '(Re)constructed breakwater merge.',
2360 '[git-debrebase anchor: declare upstream]'
2362 runcmd @git, qw(checkout --quiet -b mk), $work;
2363 if ($some_patches) {
2364 runcmd @git, qw(checkout), $head, qw(-- debian/patches);
2365 runcmd @git, qw(reset --quiet);
2366 my @gbp_cmd = (qw(gbp pq import));
2368 my $gbp_err = "../gbp-pq-err";
2369 @gbp_cmd = shell_cmd "exec >$gbp_err 2>&1", @gbp_cmd;
2371 my $r = system @gbp_cmd;
2374 " %s: couldn't apply patches: gbp pq %s",
2375 $u->{Source}, waitstatusmsg();
2379 my $work = git_rev_parse qw(HEAD);
2380 my $diffout = cmdoutput @git, qw(diff-tree --stat HEAD), $work;
2381 if (length $diffout) {
2383 " $u->{Source}: applying patches gives different tree\n";
2384 print STDERR $diffout if $diagnose;
2388 $u->{Result} = $work;
2396 Could not find or construct a suitable upstream commit.
2397 Rerun adding --diagnose after convert-from-dgit-view, or pass a
2398 upstream commmit explicitly or provide suitable origs.
2402 printf STDERR "Yes, will base new branch on %s\n", $result->{Source};
2404 ffq_check $result->{Result};
2406 update_head_checkout $head, $result->{Result},
2407 'convert-from-dgit-view';
2410 sub cmd_downstream_rebase_launder_v0 () {
2411 badusage "needs 1 argument, the baseline" unless @ARGV==1;
2413 $base = git_rev_parse $base;
2414 my $old_head = get_head();
2415 my $current = $old_head;
2418 if ($current eq $base) {
2419 $topmost_keep //= $current;
2420 print " $current BASE stop\n";
2423 my $cl = classify $current;
2424 print " $current $cl->{Type}";
2426 my $p0 = $cl->{Parents}[0]{CommitId};
2428 if ($cl->{Type} eq 'Pseudomerge') {
2429 print " ^".($cl->{Contributor}{Ix}+1);
2430 $next = $cl->{Contributor}{CommitId};
2431 } elsif ($cl->{Type} eq 'AddPatches' or
2432 $cl->{Type} eq 'Changelog') {
2442 $topmost_keep //= $current;
2444 die "to-be stripped changes not on top of the branch\n"
2449 if ($topmost_keep eq $old_head) {
2450 print "unchanged\n";
2452 print "updating to $topmost_keep\n";
2453 update_head_checkout
2454 $old_head, $topmost_keep,
2455 'downstream-rebase-launder-v0';
2461 "D+" => \$debuglevel,
2462 'noop-ok', => \$opt_noop_ok,
2463 'f=s' => \@snag_force_opts,
2464 'anchor=s' => \@opt_anchors,
2465 '--dgit=s' => \($dgit[0]),
2468 my ($opt,$val) = @_;
2469 badusage "git-debrebase: no cuddling to -i for git-rebase"
2471 die if $opt_defaultcmd_interactive; # should not happen
2472 $opt_defaultcmd_interactive = [ qw(-i) ];
2473 # This access to @ARGV is excessive familiarity with
2474 # Getopt::Long, but there isn't another sensible
2475 # approach. '-i=s{0,}' does not work with bundling.
2476 push @$opt_defaultcmd_interactive, @ARGV;
2479 'help' => sub { print $usage_message or die $!; finish 0; },
2482 initdebug('git-debrebase ');
2483 enabledebug if $debuglevel;
2485 my $toplevel = cmdoutput @git, qw(rev-parse --show-toplevel);
2486 chdir $toplevel or die "chdir $toplevel: $!";
2488 $rd = fresh_playground "$playprefix/misc";
2490 @opt_anchors = map { git_rev_parse $_ } @opt_anchors;
2492 if (!@ARGV || $opt_defaultcmd_interactive || $ARGV[0] =~ m{^-}) {
2493 defaultcmd_rebase();
2495 my $cmd = shift @ARGV;
2498 $cmdfn = ${*::}{"cmd_$cmdfn"};
2500 $cmdfn or badusage "unknown git-debrebase sub-operation $cmd";