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, $tree_with_debian) = @_;
268 # if $tree_with_debian is supplied, will use that for debian/
269 # otherwise will save and restore it.
271 $tree_with_debian ? "$tree_with_debian:debian"
272 : cmdoutput @git, qw(write-tree --prefix=debian/);
273 runcmd @git, qw(read-tree), $treeish;
274 read_tree_subdir 'debian', $debian;
275 rm_subdir_cached 'debian/patches' unless $keep_patches;
278 sub make_commit ($$) {
279 my ($parents, $message_paras) = @_;
280 my $tree = cmdoutput @git, qw(write-tree);
281 my @cmd = (@git, qw(commit-tree), $tree);
282 push @cmd, qw(-p), $_ foreach @$parents;
283 push @cmd, qw(-m), $_ foreach @$message_paras;
284 return cmdoutput @cmd;
287 our @snag_force_opts;
289 my ($tag,$msg) = @_; # ignores extra args, for benefit of keycommits
290 if (grep { $_ eq $tag } @snag_force_opts) {
292 print STDERR "git-debrebase: snag ignored (-f$tag): $msg\n";
295 print STDERR "git-debrebase: snag detected (-f$tag): $msg\n";
299 # Important: all mainline code must call snags_maybe_bail after
300 # any point where snag might be called, but before making changes
301 # (eg before any call to run_deferred_updates). snags_maybe_bail
302 # may be called more than once if necessary (but this is not ideal
303 # because then the messages about number of snags may be confusing).
304 sub snags_maybe_bail () {
305 return if all_snags_summarised();
308 "%s: snags: %d overriden by individual -f options\n",
311 if ($snags_tripped) {
314 "%s: snags: %d overriden by global --force\n",
318 "%s: snags: %d blocker(s) (you could -f<tag>, or --force)",
322 $snags_summarised = $snags_forced + $snags_tripped;
324 sub snags_maybe_bail_early () {
325 # useful to bail out early without doing a lot of work;
326 # not a substitute for snags_maybe_bail.
327 snags_maybe_bail() if $snags_tripped && !$opt_force;
330 return $snags_forced || $snags_tripped;
333 sub gbp_pq_export ($$$) {
334 my ($bname, $base, $tip) = @_;
335 # must be run in a workarea. $bname and patch-queue/$bname
336 # ought not to exist. Leaves you on patch-queue/$bname with
337 # the patches staged but not committed.
338 printdebug "gbp_pq_export $bname $base $tip\n";
339 runcmd @git, qw(checkout -q -b), $bname, $base;
340 runcmd @git, qw(checkout -q -b), "patch-queue/$bname", $tip;
341 my @gbp_cmd = (qw(gbp pq export));
342 my $r = system shell_cmd 'exec >../gbp-pq-err 2>&1', @gbp_cmd;
344 { local ($!,$?); copy('../gbp-pq-err', \*STDERR); }
347 runcmd @git, qw(add -f debian/patches);
351 # xxx allow merge resolution separately from laundering, before git merge
353 # xxx general gdr docs highlight forbidden things
354 # xxx general gdr docs list allowable things ?
355 # xxx general gdr docs explicitly forbid some rebase
357 # xxx provide a way for the user to help
358 # xxx (eg, provide wreckage provide way to continue)
361 # use git-format-patch?
362 # our own patch identification algorithm?
363 # this is an alternative strategy
365 sub merge_series ($$;@) {
366 my ($newbase, $base_q, @input_qs) = @_;
367 # $base_q{SeriesBase} $input_qs[]{SeriesBase}
368 # $base_q{SeriesTip} $input_qs[]{SeriesTip}
369 # ^ specifies several patch series (currently we only support exactly 2)
370 # return value is a commit which is the result of
371 # merging the two versions of the same topic branch
372 # $input_q[0] and $input_q[1]
373 # with respect to the old version
377 # Creates, in *_q, a key MR for its private use
379 printdebug "merge_series newbase=$newbase\n";
381 $input_qs[$_]{MR}{S} = $_ foreach (0..$#input_qs);
382 $base_q->{MR}{S} = 'base';
385 # $prereq{<patch filename>}{<possible prereq}{<S>} = 1 or absent
386 # $prereq{<patch filename>}{<possible prereq} exists or not (later)
387 # $prereq{<patch filename>} exists or not (even later)
391 local $workarea = fresh_playground "$playprefix/merge";
392 my $seriesfile = "debian/patches/series";
395 foreach my $q ($base_q, reverse @input_qs) {
397 gbp_pq_export "p-$s", $q->{SeriesBase}, $q->{SeriesTip};
399 if (open S, $seriesfile) {
400 while (my $patch = <S>) {
401 chomp $patch or die $!;
402 $prereq{$patch} //= {};
403 foreach my $earlier (@earlier) {
404 $prereq{$patch}{$earlier}{$s}++ and die;
406 push @earlier, $patch;
407 stat "debian/patches/$patch" or die "$patch ?";
409 S->error and die "$seriesfile $!";
412 die "$seriesfile $!" unless $!==ENOENT;
414 read_tree_upstream $newbase, 1;
415 my $pec = make_commit [ grep { defined } $base_q->{MR}{PEC} ], [
416 "Convert $s to patch queue for merging",
417 "[git-debrebase merge-innards patch-queue import:".
420 printdebug "merge_series pec $pec ";
421 runcmd @git, qw(rm -q --cached), $seriesfile;
422 $pec = make_commit [ $pec ], [
423 "Drop series file from $s to avoid merge trouble",
424 "[git-debrebase merge-innards patch-queue prep:".
428 read_tree_debian $newbase;
430 read_tree_subdir 'debian/patches', "$pec:debian/patches";
432 rm_subdir_cached 'debian/patches';
434 $pec = make_commit [ $pec ], [
435 "Update debian/ (excluding patches) to final to avoid re-merging",
436 "debian/ was already merged and we need to just take that.",
437 "[git-debrebase merge-innards patch-queue packaging:".
441 printdebug "pec' $pec\n";
442 runcmd @git, qw(reset -q --hard), $pec;
443 $q->{MR}{PEC} = $pec;
445 # now, because of reverse, we are on $input_q->{MR}{OQC}
446 runcmd @git, qw(checkout -q -b merge);
447 printdebug "merge_series merging...\n";
448 my @mergecmd = (@git, qw(merge --quiet --no-edit), "p-1");
449 debugcmd '+', @mergecmd;
451 if (system @mergecmd) {
455 printdebug "merge_series merge ok, series...\n";
456 # We need to construct a new series file
457 # Firstly, resolve prereq
458 foreach my $f (sort keys %prereq) {
459 printdebug "merge_series patch\t$f\t";
460 if (!stat_exists "debian/patches/$f") {
461 print DEBUG " drop\n" if $debuglevel;
462 # git merge deleted it; that's how we tell it's not wanted
466 print DEBUG " keep\n" if $debuglevel;
467 foreach my $g (sort keys %{ $prereq{$f} }) {
468 my $gfp = $prereq{$f}{$g};
469 printdebug "merge_series prereq\t$f\t-> $g\t";
470 if (!!$gfp->{0} == !!$gfp->{1}
473 print DEBUG "\tkeep\n" if $debuglevel;
475 print DEBUG "\tdrop\n" if $debuglevel;
476 delete $prereq{$f}{$g};
483 return scalar keys %{ $prereq{$f} };
486 my $nodate = time + 1;
488 # $authordate{<patch filename>};
489 my $authordate = sub {
491 $authordate{$f} //= do {
492 open PF, "<", "debian/patches/$f" or die "$f $!";
494 return $nodate if m/^$/;
495 last if s{^Date: }{};
498 return cmdoutput qw(date +%s -d), $_;
502 open NS, '>', $seriesfile or die $!;
504 while (keys %prereq) {
506 foreach my $try (sort keys %prereq) {
509 $unsat->($try) <=> $unsat->($best) or
510 $authordate->($try) <=> $authordate->($best) or
516 printdebug "merge_series series next $best\n";
517 print NS "$best\n" or die $!;
518 delete $prereq{$best};
519 foreach my $gp (values %prereq) {
524 runcmd @git, qw(add), $seriesfile;
525 runcmd @git, qw(commit --quiet -m), 'Merged series';
527 printdebug "merge_series series gbp pq import\n";
528 runcmd qw(gbp pq import);
530 # OK now we are on patch-queue/merge, and we need to rebase
531 # onto the intended parent and drop the patches from each one
533 printdebug "merge_series series ok, building...\n";
534 my $build = $newbase;
535 my @lcmd = (@git, qw(rev-list --reverse merge..patch-queue/merge));
536 foreach my $c (grep /./, split /\n/, cmdoutput @lcmd) {
537 my $commit = git_cat_file $c, 'commit';
538 printdebug "merge_series series ok, building $c\n";
539 read_tree_upstream $c, 0, $newbase;
540 my $tree = cmdoutput @git, qw(write-tree);
541 $commit =~ s{^parent (\S+)$}{parent $build}m or confess;
542 $commit =~ s{^tree (\S+)$}{tree $tree}m or confess;
543 open C, ">", "../mcommit" or die $!;
544 print C $commit or die $!;
546 $build = cmdoutput @git, qw(hash-object -w -t commit ../mcommit);
549 runcmd @git, qw(update-ref refs/heads/result), $result;
551 runcmd @git, qw(checkout -q -b debug);
552 runcmd @git, qw(commit --allow-empty -q -m M-INDEX);
553 runcmd @git, qw(add .);
554 runcmd @git, qw(commit --allow-empty -q -m M-WORKTREE);
555 printdebug sprintf "merge_series done debug=%s\n",
556 git_rev_parse 'HEAD';
558 printdebug "merge_series returns $result\n";
562 # classify returns an info hash like this
564 # Hdr => # commit headers, including 1 final newline
565 # Msg => # commit message (so one newline is dropped)
567 # Type => (see below)
569 # Ix => $index # ie 0, 1, 2, ...
571 # Differs => return value from get_differs
573 # IsDggitImport => 'orig' 'tarball' 'unpatched' 'package' (as from dgit)
575 # NewMsg => # commit message, but with any [dgit import ...] edited
576 # # to say "[was: ...]"
586 # has additional entres in classification result
587 # Overwritten = [ subset of Parents ]
588 # Contributor = $the_remaining_Parent
590 # DgitImportUnpatched
591 # has additional entry in classification result
592 # OrigParents = [ subset of Parents ]
595 # has additional entry in classification result
596 # OrigParents = [ subset of Parents ] # singleton list
603 # has additional entry in classification result
606 sub parsecommit ($;$) {
607 my ($objid, $p_ref) = @_;
608 # => hash with CommitId Hdr Msg Tree Parents
609 # Parents entries have only Ix CommitId
610 # $p_ref, if provided, must be [] and is used as a base for Parents
615 my ($h,$m) = get_commit $objid;
617 my ($t) = $h =~ m/^tree (\w+)$/m or die $objid;
618 my (@ph) = $h =~ m/^parent (\w+)$/mg;
628 foreach my $ph (@ph) {
630 Ix => scalar @$p_ref,
642 my $r = parsecommit($objid, \@p);
646 $p->{Differs} = (get_differs $p->{CommitId}, $t),
649 printdebug "classify $objid \$t=$t \@p",
650 (map { sprintf " %s/%#x", $_->{CommitId}, $_->{Differs} } @p),
654 my ($type, @rest) = @_;
655 $r = { %$r, Type => $type, @rest };
657 printdebug " = $type ".(dd $r)."\n";
663 $r = { %$r, Type => qw(Unknown), Why => $why };
664 printdebug " ** Unknown\n";
668 if (grep { $_ eq $objid } @opt_anchors) {
669 return $classify->('TreatAsAnchor');
672 my @identical = grep { !$_->{Differs} } @p;
673 my ($stype, $series) = git_cat_file "$t:debian/patches/series";
674 my $haspatches = $stype ne 'missing' && $series =~ m/^\s*[^#\n\t ]/m;
676 if ($r->{Msg} =~ m{^\[git-debrebase anchor.*\]$}m) {
677 # multi-orig upstreams are represented with an anchor merge
678 # from a single upstream commit which combines the orig tarballs
680 # Every anchor tagged this way must be a merge.
681 # We are relying on the
682 # [git-debrebase anchor: ...]
683 # commit message annotation in "declare" anchor merges (which
684 # do not have any upstream changes), to distinguish those
685 # anchor merges from ordinary pseudomerges (which we might
686 # just try to strip).
688 # However, the user is going to be doing git-rebase a lot. We
689 # really don't want them to rewrite an anchor commit.
690 # git-rebase trips up on merges, so that is a useful safety
693 # BreakwaterStart commits are also anchors in the terminology
694 # of git-debrebase(5), but they are untagged (and always
695 # manually generated).
697 # We cannot not tolerate any tagged linear commit (ie,
698 # BreakwaterStart commits tagged `[anchor:') because such a
699 # thing could result from an erroneous linearising raw git
700 # rebase of a merge anchor. That would represent a corruption
701 # of the branch. and we want to detect and reject the results
702 # of such corruption before it makes it out anywhere. If we
703 # reject it here then we avoid making the pseudomerge which
704 # would be needed to push it.
706 my $badanchor = sub { $unknown->("git-debrebase \`anchor' but @_"); };
707 @p == 2 or return $badanchor->("has other than two parents");
708 $haspatches and return $badanchor->("contains debian/patches");
710 # How to decide about l/r ordering of anchors ? git
711 # --topo-order prefers to expand 2nd parent first. There's
712 # already an easy rune to look for debian/ history anyway (git log
713 # debian/) so debian breakwater branch should be 1st parent; that
714 # way also there's also an easy rune to look for the upstream
715 # patches (--topo-order).
717 # Also this makes --first-parent be slightly more likely to
718 # be useful - it makes it provide a linearised breakwater history.
720 # Of course one can say somthing like
721 # gitk -- ':/' ':!/debian'
722 # to get _just_ the commits touching upstream files, and by
723 # the TREESAME logic in git-rev-list this will leave the
724 # breakwater into upstream at the first anchor. But that
725 # doesn't report debian/ changes at all.
727 # Other observations about gitk: by default, gitk seems to
728 # produce output in a different order to git-rev-list. I
729 # can't seem to find this documented anywhere. gitk
730 # --date-order DTRT. But, gitk always seems to put the
731 # parents from left to right, in order, so it's easy to see
732 # which way round a pseudomerge is.
734 $p[0]{IsOrigin} and $badanchor->("is an origin commit");
735 $p[1]{Differs} & ~DS_DEB and
736 $badanchor->("upstream files differ from left parent");
737 $p[0]{Differs} & ~D_UPS and
738 $badanchor->("debian/ differs from right parent");
740 return $classify->(qw(Anchor),
741 OrigParents => [ $p[1] ]);
745 my $d = $r->{Parents}[0]{Differs};
746 if ($d == D_PAT_ADD) {
747 return $classify->(qw(AddPatches));
748 } elsif ($d & (D_PAT_ADD|D_PAT_OTH)) {
749 return $unknown->("edits debian/patches");
750 } elsif ($d & DS_DEB and !($d & ~DS_DEB)) {
751 my ($ty,$dummy) = git_cat_file "$p[0]{CommitId}:debian";
753 if ($d == D_DEB_CLOG) {
754 return $classify->(qw(Changelog));
756 return $classify->(qw(Packaging));
758 } elsif ($ty eq 'missing') {
759 return $classify->(qw(BreakwaterStart));
761 return $unknown->("parent's debian is not a directory");
763 } elsif ($d == D_UPS) {
764 return $classify->(qw(Upstream));
765 } elsif ($d & DS_DEB and $d & D_UPS and !($d & ~(DS_DEB|D_UPS))) {
766 return $classify->(qw(Mixed));
768 return $unknown->("no changes");
770 confess "internal error $objid ?";
774 return $unknown->("origin commit");
777 if (@p == 2 && @identical == 1) {
778 my @overwritten = grep { $_->{Differs} } @p;
779 confess "internal error $objid ?" unless @overwritten==1;
780 return $classify->(qw(Pseudomerge),
781 Overwritten => [ $overwritten[0] ],
782 Contributor => $identical[0]);
784 if (@p == 2 && @identical == 2) {
786 my ($ph,$pm) = get_commit $_[0]{CommitId};
787 $ph =~ m/^committer .* (\d+) [-+]\d+$/m or die "$_->{CommitId} ?";
791 my $order = $get_t->($bytime[0]) <=> $get_t->($bytime[1]);
792 if ($order > 0) { # newer first
793 } elsif ($order < 0) {
794 @bytime = reverse @bytime;
796 # same age, default to order made by -s ours
797 # that is, commit was made by someone who preferred L
799 return $classify->(qw(Pseudomerge),
800 SubType => qw(Ambiguous),
801 Contributor => $bytime[0],
802 Overwritten => [ $bytime[1] ]);
805 my ($p_h, $p_m) = get_commit $p->{CommitId};
806 $p->{IsOrigin} = $p_h !~ m/^parent \w+$/m;
807 ($p->{IsDgitImport},) = $p_m =~ m/^\[dgit import ([0-9a-z]+) .*\]$/m;
809 my @orig_ps = grep { ($_->{IsDgitImport}//'X') eq 'orig' } @p;
811 if (!(grep { !$_->{IsOrigin} } @p) and
812 (@orig_ps >= @p - 1) and
813 $m2 =~ s{^\[(dgit import unpatched .*)\]$}{[was: $1]}m) {
815 return $classify->(qw(DgitImportUnpatched),
816 OrigParents => \@orig_ps);
820 $r->{Msg} =~ m{^\[git-debrebase merged-breakwater.*\]$}m) {
821 # xxx ^ metadata tag needs adding to (5)
822 return $classify->("MergedBreakwaters");
824 if ($r->{Msg} =~ m{^\[(git-debrebase|dgit)[: ].*\]$}m) {
825 return $unknown->("unknown kind of merge from $1");
828 return $unknown->("octopus merge");
831 if (!$ENV{GIT_DEBREBASE_EXPERIMENTAL_MERGE}) {
832 return $unknown->("general two-parent merge");
835 return $classify->("VanillaMerge");
838 sub keycommits ($;$$$$$);
840 sub mergedbreakwaters_anchor ($) {
843 foreach my $p (@{ $cl->{Parents} }) {
844 my ($panchor, $pbw) = keycommits $p->{CommitId},
845 undef,undef,undef,undef, 1;
846 $best_anchor = $panchor
847 if !defined $best_anchor
848 or is_fast_fwd $best_anchor, $panchor;
849 fail "inconsistent anchors in merged-breakwaters $p->{CommitId}"
850 unless is_fast_fwd $panchor, $best_anchor;
855 sub keycommits ($;$$$$$) {
856 my ($head, $furniture, $unclean, $trouble, $fatal, $claimed_bw) = @_;
857 # => ($anchor, $breakwater)
859 # $unclean->("unclean-$tagsfx", $msg, $cl)
860 # $furniture->("unclean-$tagsfx", $msg, $cl)
861 # $dgitimport->("unclean-$tagsfx", $msg, $cl))
862 # is callled for each situation or commit that
863 # wouldn't be found in a laundered branch
864 # $furniture is for furniture commits such as might be found on an
865 # interchange branch (pseudomerge, d/patches, changelog)
866 # $trouble is for things whnich prevent the return of
867 # anchor and breakwater information; if that is ignored,
868 # then keycommits returns (undef, undef) instead.
869 # $fatal is for unprocessable commits, and should normally cause
870 # a failure. If ignored, agaion, (undef, undef) is returned.
872 # If $claimed_bw, this is supposed to be a breakwater commit.
874 # If a callback is undef, fail is called instead.
875 # If a callback is defined but false, the situation is ignored.
877 # no warnings qw(exiting); last;
878 # if the answer is no longer wanted.
880 my ($anchor, $breakwater);
881 $breakwater = $head if $claimed_bw;
885 $fatal //= sub { fail $_[1]; };
887 my ($cb, $tagsfx, $mainwhy, $xwhy) = @_;
888 my $why = $mainwhy.$xwhy;
889 my $m = "branch needs laundering (run git-debrebase): $why";
890 fail $m unless defined $cb;
892 $cb->("unclean-$tagsfx", $why, $cl, $mainwhy);
894 my $found_anchor = sub {
896 $breakwater //= $clogonly;
897 $breakwater //= $head;
898 no warnings qw(exiting);
902 $cl = classify $head;
903 my $ty = $cl->{Type};
904 if ($ty eq 'Packaging') {
905 $breakwater //= $clogonly;
906 $breakwater //= $head;
907 } elsif ($ty eq 'Changelog') {
908 # this is going to count as the tip of the breakwater
909 # only if it has no upstream stuff before it
911 } elsif ($ty eq 'Anchor' or
912 $ty eq 'TreatAsAnchor' or
913 $ty eq 'BreakwaterStart') {
914 $found_anchor->($head);
915 } elsif ($ty eq 'Upstream') {
916 $x->($unclean, 'ordering',
917 "packaging change ($breakwater) follows upstream change"," (eg $head)")
918 if defined $breakwater;
921 } elsif ($ty eq 'Mixed') {
922 $x->($unclean, 'mixed',
923 "found mixed upstream/packaging commit"," ($head)");
926 } elsif ($ty eq 'Pseudomerge' or
927 $ty eq 'AddPatches') {
929 $x->($furniture, (lc $ty),
930 "found interchange bureaucracy commit ($ty)"," ($head)");
931 } elsif ($ty eq 'DgitImportUnpatched') {
933 $x->($trouble, 'dgitimport',
934 "found dgit dsc import"," ($head)");
935 return (undef,undef);
937 $x->($fatal, 'unprocessable',
938 "found bare dgit dsc import with no prior history",
940 return (undef,undef);
942 } elsif ($ty eq 'VanillaMerge') {
943 $x->($trouble, 'vanillamerge',
944 "found vanilla merge"," ($head)");
945 return (undef,undef);
946 } elsif ($ty eq 'MergedBreakwaters') {
947 $found_anchor->(mergedbreakwaters_anchor $cl);
949 $x->($fatal, 'unprocessable',
950 "found unprocessable commit, cannot cope: $cl->{Why}",
952 return (undef,undef);
954 $head = $cl->{Parents}[0]{CommitId};
956 return ($anchor, $breakwater);
962 $nogenerate,$report, $report_lprefix) = @_;
963 # => ($tip, $breakwater_tip, $last_anchor)
964 # (or nothing, if $nogenerate)
966 printdebug "*** WALK $input ".($nogenerate//0)." ".($report//'-')."\n";
967 $report_lprefix //= '';
969 # go through commits backwards
970 # we generate two lists of commits to apply:
971 # breakwater branch and upstream patches
972 my (@brw_cl, @upp_cl, @processed);
979 my ($prose, $info) = @_;
983 $ms .= "\n\n[git-debrebase$info: $prose]\n";
986 my $rewrite_from_here = sub {
988 my $sp_cl = { SpecialMethod => 'StartRewrite' };
990 push @processed, $sp_cl;
995 my $prprdelim = sub { print $report $prdelim if $report; $prdelim=""; };
998 return unless $report;
999 print $report $prdelim, $report_lprefix, @_;
1003 my $bomb = sub { # usage: return $bomb->();
1004 print $report " Unprocessable" if $report;
1005 print $report " ($cl->{Why})" if $report && defined $cl->{Why};
1008 return (undef,undef);
1010 fail "found unprocessable commit, cannot cope".
1011 (defined $cl->{Why} ? "; $cl->{Why}:": ':').
1012 " (commit $cur) (d.".
1013 (join ' ', map { sprintf "%#x", $_->{Differs} }
1014 @{ $cl->{Parents} }).
1021 my $build_start = sub {
1022 my ($msg, $parent) = @_;
1025 no warnings qw(exiting); last;
1029 fail "something useful about failed merge attempt @_ xxx".Dumper($cl);
1035 $cl = classify $cur;
1036 my $ty = $cl->{Type};
1037 my $st = $cl->{SubType};
1038 $prline->("$cl->{CommitId} $cl->{Type}");
1039 $found{$ty. ( defined($st) ? "-$st" : '' )}++;
1040 push @processed, $cl;
1041 my $p0 = @{ $cl->{Parents} }==1 ? $cl->{Parents}[0]{CommitId} : undef;
1042 if ($ty eq 'AddPatches') {
1044 $rewrite_from_here->(\@upp_cl);
1046 } elsif ($ty eq 'Packaging' or $ty eq 'Changelog') {
1050 } elsif ($ty eq 'BreakwaterStart') {
1051 $last_anchor = $cur;
1052 $build_start->('FirstPackaging', $cur);
1053 } elsif ($ty eq 'Upstream') {
1057 } elsif ($ty eq 'Mixed') {
1060 my $cls = { %$cl, $xmsg->("split mixed commit: $wh part") };
1063 $queue->(\@brw_cl, "debian");
1064 $queue->(\@upp_cl, "upstream");
1065 $rewrite_from_here->(\@brw_cl);
1068 } elsif ($ty eq 'Pseudomerge') {
1069 my $contrib = $cl->{Contributor}{CommitId};
1070 print $report " Contributor=$contrib" if $report;
1071 push @pseudomerges, $cl;
1072 $rewrite_from_here->(\@upp_cl);
1075 } elsif ($ty eq 'Anchor' or $ty eq 'TreatAsAnchor') {
1076 $last_anchor = $cur;
1077 $build_start->("Anchor", $cur);
1078 } elsif ($ty eq 'DgitImportUnpatched') {
1079 my $pm = $pseudomerges[-1];
1081 # To an extent, this is heuristic. Imports don't have
1082 # a useful history of the debian/ branch. We assume
1083 # that the first pseudomerge after an import has a
1084 # useful history of debian/, and ignore the histories
1085 # from later pseudomerges. Often the first pseudomerge
1086 # will be the dgit import of the upload to the actual
1087 # suite intended by the non-dgit NMUer, and later
1088 # pseudomerges may represent in-archive copies.
1089 my $ovwrs = $pm->{Overwritten};
1090 printf $report " PM=%s \@Overwr:%d",
1091 $pm->{CommitId}, (scalar @$ovwrs)
1094 printdebug "*** WALK BOMB DgitImportUnpatched\n";
1097 my $ovwr = $ovwrs->[0]{CommitId};
1098 printf $report " Overwr=%s", $ovwr if $report;
1099 # This import has a tree which is just like a
1100 # breakwater tree, but it has the wrong history. It
1101 # ought to have the previous breakwater (which the
1102 # pseudomerge overwrote) as an ancestor. That will
1103 # make the history of the debian/ files correct. As
1104 # for the upstream version: either it's the same as
1105 # was ovewritten (ie, same as the previous
1106 # breakwater), in which case that history is precisely
1107 # right; or, otherwise, it was a non-gitish upload of a
1108 # new upstream version. We can tell these apart by
1109 # looking at the tree of the supposed upstream.
1112 SpecialMethod => 'DgitImportDebianUpdate',
1113 $xmsg->("convert dgit import: debian changes")
1116 SpecialMethod => 'DgitImportUpstreamUpdate',
1117 $xmsg->("convert dgit import: upstream update",
1120 $prline->(" Import");
1121 $rewrite_from_here->(\@brw_cl);
1122 $upp_limit //= $#upp_cl; # further, deeper, patches discarded
1126 # Everything is from this import. This kind of import
1127 # is already nearly in valid breakwater format, with the
1128 # patches as commits. Unfortunately it contains
1130 printdebug "*** WALK BOMB bare dgit import\n";
1131 $cl->{Why} = "bare dgit dsc import";
1135 } elsif ($ty eq 'MergedBreakwaters') {
1136 $last_anchor = mergedbreakwaters_anchor $cl;
1137 $build_start->(' MergedBreakwaters', $cur);
1139 } elsif ($ty eq 'VanillaMerge') {
1140 # User may have merged unstitched branch(es). We will
1141 # have now lost what ffq-prev was then (since the later
1142 # pseudomerge may introduce further changes). The effect
1143 # of resolving such a merge is that we may have to go back
1144 # further in history to find a merge base, since the one
1145 # which was reachable via ffq-prev is no longer findable.
1146 # This is suboptimal, but if it all works we'll have done
1148 # xxx we should warn the user in the docs about this
1152 # We expect to find a dominating anchor amongst the
1153 # inputs' anchors. That will be the new anchor.
1155 # More complicated is finding a merge base for the
1156 # breakwaters. We need a merge base that is a breakwater
1157 # commit. The ancestors of breakwater commits are more
1158 # breakwater commits and possibly upstream commits and the
1159 # ancestors of those upstream. Upstreams might have
1160 # arbitrary ancestors. But any upstream commit U is
1161 # either included in both anchors, in which case the
1162 # earlier anchor is a better merge base than any of U's
1163 # ancestors; or U is not included in the older anchor, in
1164 # which case U is not an ancestor of the vanilla merge at
1165 # all. So no upstream commit, nor any ancestor thereof,
1166 # is a best merge base. As for non-breakwater Debian
1167 # commits: these are never ancestors of any breakwater.
1169 # So any best merge base as found by git-merge-base
1170 # is a suitable breakwater anchor. Usually there will
1173 printdebug "*** MERGE\n";
1175 my @bwbcmd = (@git, qw(merge-base));
1176 my @ibcmd = (@git, qw(merge-base --all));
1177 my $might_be_in_bw = 1;
1179 my $ps = $cl->{Parents};
1181 foreach my $p (@$ps) {
1182 $prline->(" VanillaMerge ".$p->{Ix});
1184 my ($ptip, $pbw, $panchor) =
1185 walk $p->{CommitId}, 0, $report,
1186 $report_lprefix.' ';
1187 $p->{Laundered} = $p->{SeriesTip} = $ptip;
1188 $p->{Breakwater} = $p->{SeriesBase} = $pbw;
1189 $p->{Anchor} = $panchor;
1191 $best_anchor = $panchor if
1192 !defined $best_anchor or
1193 is_fast_fwd $best_anchor, $panchor;
1195 printdebug " MERGE BA best=".($best_anchor//'-').
1199 foreach my $p (@$ps) {
1200 $prline->(" VanillaMerge ".$p->{Ix});
1201 if (!is_fast_fwd $p->{Anchor}, $best_anchor) {
1202 $nomerge->('DivergentAnchor');
1203 } elsif ($p->{Anchor} eq $best_anchor) {
1204 print $report " SameAnchor" if $report;
1206 print $report " SupersededAnchor" if $report;
1208 if ($p->{Breakwater} eq $p->{CommitId}) {
1209 # this parent commit was its own breakwater,
1210 # ie it is part of the breakwater
1211 print $report " Breakwater" if $report;
1213 $might_be_in_bw = 0;
1215 push @bwbcmd, $p->{Breakwater};
1216 push @ibcmd, $p->{CommitId};
1219 if ($ok && $might_be_in_bw) {
1220 $prline->(" VanillaMerge MergedBreakwaters");
1221 $last_anchor = $best_anchor;
1222 $build_start->('MergedBreakwaters', $cur);
1225 $nomerge->("alleged merged-breakwater is not a breakwater")
1226 unless $ty eq 'VanillaMerge';
1228 my $bwb = cmdoutput @bwbcmd;
1230 # OK, now we have a breakwater base, but we need the merge
1231 # base for the interchange branch because we need the delta
1234 # This a the best merge base of our inputs which has the
1235 # breakwater merge base as an ancestor.
1238 grep { is_fast_fwd $bwb, $_ }
1243 or $nomerge->("no suitable interchange merge base");
1245 $prline->(" VanillaMerge Base");
1247 my ($btip, $bbw, $banchor) =
1248 walk $ib, 0, $report, $report_lprefix.' ';
1250 my $ibinfo = { SeriesTip => $btip,
1252 Anchor => $banchor };
1254 or $nomerge->("interchange merge-base ($ib)'s".
1255 " breakwater ($bbw)".
1256 " != breakwaters' merge-base ($bwb)");
1257 grep { $_->{Anchor} eq $ibinfo->{Anchor} } @$ps
1258 or $nomerge->("interchange merge-base ($ib)'s".
1259 " anchor ($ibinfo->{SeriesBase})".
1260 " != any merge input's anchor (".
1261 (join ' ', map { $_->{Anchor} } @$ps).
1265 $cl->{MergeInterchangeBaseInfo} = $ibinfo;
1266 $cl->{MergeBestAnchor} = $best_anchor;
1269 SpecialMethod => 'MergeCreateMergedBreakwaters',
1270 $xmsg->('constructed from vanilla merge',
1271 ' merged-breakwater'),
1275 SpecialMethod => 'MergeMergeSeries',
1277 $build_start->('MergeBreakwaters', $cur);
1279 printdebug "*** WALK BOMB unrecognised\n";
1285 printdebug "*** WALK prep done cur=$cur".
1286 " brw $#brw_cl upp $#upp_cl proc $#processed pm $#pseudomerges\n";
1288 return if $nogenerate;
1290 # Now we build it back up again
1296 my $read_tree_upstream = sub {
1298 read_tree_upstream $treeish, 0, $build;
1301 $#upp_cl = $upp_limit if defined $upp_limit;
1303 my $committer_authline = calculate_committer_authline();
1305 printdebug "WALK REBUILD $build ".(scalar @processed)."\n";
1307 confess "internal error" unless $build eq (pop @processed)->{CommitId};
1310 mkdir $rd or $!==EEXIST or die $!;
1312 runcmd @git, qw(read-tree), $build;
1313 foreach my $cl (qw(Debian), (reverse @brw_cl),
1314 { SpecialMethod => 'RecordBreakwaterTip' },
1315 qw(Upstream), (reverse @upp_cl)) {
1317 $current_method = $cl;
1320 my $method = $cl->{SpecialMethod} // $current_method;
1321 my @parents = ($build);
1322 my $cltree = $cl->{CommitId};
1323 printdebug "WALK BUILD ".($cltree//'undef').
1324 " $method (rewriting=$rewriting)\n";
1325 if ($method eq 'Debian') {
1326 read_tree_debian($cltree);
1327 } elsif ($method eq 'Upstream') {
1328 $read_tree_upstream->($cltree);
1329 } elsif ($method eq 'StartRewrite') {
1332 } elsif ($method eq 'RecordBreakwaterTip') {
1333 $breakwater = $build;
1335 } elsif ($method eq 'DgitImportDebianUpdate') {
1336 read_tree_debian($cltree);
1337 } elsif ($method eq 'DgitImportUpstreamUpdate') {
1338 confess unless $rewriting;
1339 my $differs = (get_differs $build, $cltree);
1340 next unless $differs & D_UPS;
1341 $read_tree_upstream->($cltree);
1342 push @parents, map { $_->{CommitId} } @{ $cl->{OrigParents} };
1343 } elsif ($method eq 'MergeCreateMergedBreakwaters') {
1344 print "Found a general merge, will try to tidy it up.\n";
1346 $read_tree_upstream->($cl->{MergeBestAnchor});
1347 $read_tree_upstream->($cl->{MergeBestAnchor});
1348 read_tree_debian($cltree);
1349 @parents = map { $_->{Breakwater} } @{ $cl->{Parents} };
1350 } elsif ($method eq 'MergeMergeSeries') {
1351 print "Running merge resolution for $cl->{CommitId}...\n";
1352 $build = merge_series
1354 $cl->{MergeInterchangeBaseInfo},
1355 @{ $cl->{Parents} };
1356 $last_anchor = $cl->{MergeBestAnchor};
1358 # Check for mismerges:
1360 my ($against, $allow, $what) = @_;
1361 my $differs = get_differs $build, $against;
1363 "merge misresolved: %s are not the same (%s %s d.%#x)",
1364 $what, $against, $build, $differs)
1365 if $differs & ~($allow | D_PAT_ADD);
1368 # Breakwater changes which were in each side of the
1369 # merge will have been incorporated into the
1370 # MergeCreateMergedBreakwaters output. Because the
1371 # upstream series was rebased onto the new breakwater,
1372 # so should all of the packaging changes which were in
1374 $check->($input, D_UPS, 'debian files');
1376 # Upstream files are merge_series, which ought to
1377 # have been identical to the original merge.
1378 $check->($cl->{CommitId}, DS_DEB, 'upstream files');
1380 print "Merge resolution successful.\n";
1383 confess "$method ?";
1386 my $procd = (pop @processed) // 'UNDEF';
1387 if ($cl ne $procd) {
1389 printdebug "WALK REWRITING NOW cl=$cl procd=$procd\n";
1392 my $newtree = cmdoutput @git, qw(write-tree);
1393 my $ch = $cl->{Hdr};
1394 $ch =~ s{^tree .*}{tree $newtree}m or confess "$ch ?";
1395 $ch =~ s{^parent .*\n}{}mg;
1396 $ch =~ s{(?=^author)}{
1397 join '', map { "parent $_\n" } @parents
1398 }me or confess "$ch ?";
1400 $ch =~ s{^committer .*$}{$committer_authline}m
1403 my $cf = "$rd/m$rewriting";
1404 open CD, ">", $cf or die $!;
1405 print CD $ch, "\n", $cl->{Msg} or die $!;
1407 my @cmd = (@git, qw(hash-object));
1408 push @cmd, qw(-w) if $rewriting;
1409 push @cmd, qw(-t commit), $cf;
1410 my $newcommit = cmdoutput @cmd;
1411 confess "$ch ?" unless $rewriting or $newcommit eq $cl->{CommitId};
1412 $build = $newcommit;
1413 if (grep { $method eq $_ } qw(DgitImportUpstreamUpdate)) {
1414 $last_anchor = $cur;
1419 my $final_check = get_differs $build, $input;
1420 die sprintf "internal error %#x %s %s", $final_check, $input, $build
1421 if $final_check & ~D_PAT_ADD;
1423 my @r = ($build, $breakwater, $last_anchor);
1424 printdebug "*** WALK RETURN @r\n";
1429 git_check_unmodified();
1430 return git_rev_parse qw(HEAD);
1433 sub update_head ($$$) {
1434 my ($old, $new, $mrest) = @_;
1435 push @deferred_updates, "update HEAD $new $old";
1436 run_deferred_updates $mrest;
1439 sub update_head_checkout ($$$) {
1440 my ($old, $new, $mrest) = @_;
1441 update_head $old, $new, $mrest;
1442 runcmd @git, qw(reset --hard);
1445 sub update_head_postlaunder ($$$) {
1446 my ($old, $tip, $reflogmsg) = @_;
1447 return if $tip eq $old;
1448 print "git-debrebase: laundered (head was $old)\n";
1449 update_head $old, $tip, $reflogmsg;
1450 # no tree changes except debian/patches
1451 runcmd @git, qw(rm --quiet --ignore-unmatch -rf debian/patches);
1454 sub currently_rebasing() {
1455 foreach (qw(rebase-merge rebase-apply)) {
1456 return 1 if stat_exists "$maindir_gitdir/$_";
1461 sub bail_if_rebasing() {
1462 fail "you are in the middle of a git-rebase already"
1463 if currently_rebasing();
1466 sub do_launder_head ($) {
1467 my ($reflogmsg) = @_;
1468 my $old = get_head();
1470 my ($tip,$breakwater) = walk $old;
1472 update_head_postlaunder $old, $tip, $reflogmsg;
1473 return ($tip,$breakwater);
1476 sub cmd_launder_v0 () {
1477 badusage "no arguments to launder-v0 allowed" if @ARGV;
1478 my $old = get_head();
1479 my ($tip,$breakwater,$last_anchor) = walk $old;
1480 update_head_postlaunder $old, $tip, 'launder';
1481 printf "# breakwater tip\n%s\n", $breakwater;
1482 printf "# working tip\n%s\n", $tip;
1483 printf "# last anchor\n%s\n", $last_anchor;
1486 sub defaultcmd_rebase () {
1487 push @ARGV, @{ $opt_defaultcmd_interactive // [] };
1488 my ($tip,$breakwater) = do_launder_head 'launder for rebase';
1489 runcmd @git, qw(rebase), @ARGV, $breakwater if @ARGV;
1492 sub cmd_analyse () {
1493 badusage "analyse does not support any options"
1494 if @ARGV and $ARGV[0] =~ m/^-/;
1495 badusage "too many arguments to analyse" if @ARGV>1;
1498 $old = git_rev_parse $old;
1500 $old = git_rev_parse 'HEAD';
1502 my ($dummy,$breakwater) = walk $old, 1,*STDOUT;
1503 STDOUT->error and die $!;
1506 sub ffq_prev_branchinfo () {
1507 my $current = git_get_symref();
1508 return gdr_ffq_prev_branchinfo($current);
1511 sub ffq_check ($;$$) {
1512 # calls $ff and/or $notff zero or more times
1513 # then returns either (status,message) where status is
1518 # or (undef,undef, $ffq_prev,$gdrlast)
1519 # $ff and $notff are called like this:
1520 # $ff->("message for stdout\n");
1521 # $notff->('snag-name', $message);
1522 # normally $currentval should be HEAD
1523 my ($currentval, $ff, $notff) =@_;
1525 $ff //= sub { print $_[0] or die $!; };
1528 my ($status, $message, $current, $ffq_prev, $gdrlast)
1529 = ffq_prev_branchinfo();
1530 return ($status, $message) unless $status eq 'branch';
1532 my $exists = git_get_ref $ffq_prev;
1533 return ('exists',"$ffq_prev already exists") if $exists;
1535 return ('not-branch', 'HEAD symref is not to refs/heads/')
1536 unless $current =~ m{^refs/heads/};
1539 my @check_specs = split /\;/, (cfg "branch.$branch.ffq-ffrefs",1) // '*';
1542 printdebug "ffq check_specs @check_specs\n";
1545 my ($lrref, $desc) = @_;
1546 printdebug "ffq might check $lrref ($desc)\n";
1548 for my $chk (@check_specs) {
1550 $invert = $glob =~ s{^[!^]}{};
1551 last if fnmatch $glob, $lrref;
1554 my $lrval = git_get_ref $lrref;
1555 return unless length $lrval;
1557 if (is_fast_fwd $lrval, $currentval) {
1558 $ff->("OK, you are ahead of $lrref\n");
1559 $checked{$lrref} = 1;
1560 } elsif (is_fast_fwd $currentval, $lrval) {
1561 $checked{$lrref} = -1;
1562 $notff->('behind', "you are behind $lrref, divergence risk");
1564 $checked{$lrref} = -1;
1565 $notff->('diverged', "you have diverged from $lrref");
1569 my $merge = cfg "branch.$branch.merge",1;
1570 if (defined $merge and $merge =~ m{^refs/heads/}) {
1572 printdebug "ffq merge $rhs\n";
1573 my $check_remote = sub {
1574 my ($remote, $desc) = @_;
1575 printdebug "ffq check_remote ".($remote//'undef')." $desc\n";
1576 return unless defined $remote;
1577 $check->("refs/remotes/$remote/$rhs", $desc);
1579 $check_remote->((scalar cfg "branch.$branch.remote",1),
1580 'remote fetch/merge branch');
1581 $check_remote->((scalar cfg "branch.$branch.pushRemote",1) //
1582 (scalar cfg "branch.$branch.pushDefault",1),
1583 'remote push branch');
1585 if ($branch =~ m{^dgit/}) {
1586 $check->("refs/remotes/dgit/$branch", 'remote dgit branch');
1587 } elsif ($branch =~ m{^master$}) {
1588 $check->("refs/remotes/dgit/dgit/sid", 'remote dgit branch for sid');
1590 return (undef, undef, $ffq_prev, $gdrlast);
1593 sub record_ffq_prev_deferred () {
1594 # => ('status', "message")
1596 # deferred message is undef
1601 # if not ff from some branch we should be ff from, is an snag
1602 # if "deferred", will have added something about that to
1603 # @deferred_update_messages, and also maybe printed (already)
1604 # some messages about ff checks
1606 my $currentval = get_head();
1608 my ($status,$message, $ffq_prev,$gdrlast) = ffq_check $currentval;
1609 return ($status,$message) if defined $status;
1613 push @deferred_updates, "update $ffq_prev $currentval $git_null_obj";
1614 push @deferred_updates, "delete $gdrlast";
1615 push @deferred_update_messages, "Recorded previous head for preservation";
1616 return ('deferred', undef);
1619 sub record_ffq_auto () {
1620 my ($status, $message) = record_ffq_prev_deferred();
1621 if ($status eq 'deferred' || $status eq 'exists') {
1623 snag $status, "could not record ffq-prev: $message";
1628 sub ffq_prev_info () {
1630 # => ($ffq_prev, $gdrlast, $ffq_prev_commitish)
1631 my ($status, $message, $current, $ffq_prev, $gdrlast)
1632 = ffq_prev_branchinfo();
1633 if ($status ne 'branch') {
1634 snag $status, "could not check ffq-prev: $message";
1637 my $ffq_prev_commitish = $ffq_prev && git_get_ref $ffq_prev;
1638 return ($ffq_prev, $gdrlast, $ffq_prev_commitish);
1641 sub stitch ($$$$$) {
1642 my ($old_head, $ffq_prev, $gdrlast, $ffq_prev_commitish, $prose) = @_;
1644 push @deferred_updates, "delete $ffq_prev $ffq_prev_commitish";
1646 if (is_fast_fwd $old_head, $ffq_prev_commitish) {
1647 my $differs = get_differs $old_head, $ffq_prev_commitish;
1648 unless ($differs & ~D_PAT_ADD) {
1649 # ffq-prev is ahead of us, and the only tree changes it has
1650 # are possibly addition of things in debian/patches/.
1651 # Just wind forwards rather than making a pointless pseudomerge.
1652 push @deferred_updates,
1653 "update $gdrlast $ffq_prev_commitish $git_null_obj";
1654 update_head_checkout $old_head, $ffq_prev_commitish,
1655 "stitch (fast forward)";
1660 # We make pseudomerges with L as the contributing parent.
1661 # This makes git rev-list --first-parent work properly.
1662 my $new_head = make_commit [ $old_head, $ffq_prev ], [
1663 'Declare fast forward / record previous work',
1664 "[git-debrebase pseudomerge: $prose]",
1666 push @deferred_updates, "update $gdrlast $new_head $git_null_obj";
1667 update_head $old_head, $new_head, "stitch: $prose";
1670 sub do_stitch ($;$) {
1671 my ($prose, $unclean) = @_;
1673 my ($ffq_prev, $gdrlast, $ffq_prev_commitish) = ffq_prev_info();
1674 if (!$ffq_prev_commitish) {
1675 fail "No ffq-prev to stitch." unless $opt_noop_ok;
1678 my $dangling_head = get_head();
1680 keycommits $dangling_head, $unclean,$unclean,$unclean;
1683 stitch($dangling_head, $ffq_prev, $gdrlast, $ffq_prev_commitish, $prose);
1686 sub upstream_commitish_search ($$) {
1687 my ($upstream_version, $tried) = @_;
1688 # todo: at some point maybe use git-deborig to do this
1689 foreach my $tagpfx ('', 'v', 'upstream/') {
1690 my $tag = $tagpfx.(dep14_version_mangle $upstream_version);
1691 my $new_upstream = git_get_ref "refs/tags/$tag";
1693 return $new_upstream if length $new_upstream;
1697 sub resolve_upstream_version ($$) {
1698 my ($new_upstream, $upstream_version) = @_;
1700 if (!defined $new_upstream) {
1702 $new_upstream = upstream_commitish_search $upstream_version, \@tried;
1703 if (!length $new_upstream) {
1704 fail "Could not determine appropriate upstream commitish.\n".
1705 " (Tried these tags: @tried)\n".
1706 " Check version, and specify upstream commitish explicitly.";
1709 $new_upstream = git_rev_parse $new_upstream;
1711 return $new_upstream;
1714 sub cmd_new_upstream () {
1715 # automatically and unconditionally launders before rebasing
1716 # if rebase --abort is used, laundering has still been done
1720 badusage "need NEW-VERSION [UPS-COMMITTISH]" unless @ARGV >= 1;
1722 # parse args - low commitment
1723 my $spec_version = shift @ARGV;
1724 my $new_version = (new Dpkg::Version $spec_version, check => 1);
1725 fail "bad version number \`$spec_version'" unless defined $new_version;
1726 if ($new_version->is_native()) {
1727 $new_version = (new Dpkg::Version "$spec_version-1", check => 1);
1730 my $new_upstream = shift @ARGV;
1731 my $new_upstream_version = upstreamversion $new_version;
1733 resolve_upstream_version $new_upstream, $new_upstream_version;
1738 my ($n, @x) = @_; # may be ''
1739 my $pc = $pieces{$n} //= {
1741 Desc => ($n ? "upstream piece \`$n'" : "upstream (main piece"),
1743 while (my $k = shift @x) { $pc->{$k} = shift @x; }
1748 my $newpiece = sub {
1749 my ($n, @x) = @_; # may be ''
1750 my $pc = $piece->($n, @x, NewIx => (scalar @newpieces));
1751 push @newpieces, $pc;
1756 New => $new_upstream,
1758 while (@ARGV && $ARGV[0] !~ m{^-}) {
1759 my $n = shift @ARGV;
1761 badusage "for each EXTRA-UPS-NAME need EXTRA-UPS-COMMITISH"
1762 unless @ARGV && $ARGV[0] !~ m{^-};
1764 my $c = git_rev_parse shift @ARGV;
1765 die unless $n =~ m/^$extra_orig_namepart_re$/;
1766 $newpiece->($n, New => $c);
1769 # now we need to investigate the branch this generates the
1770 # laundered version but we don't switch to it yet
1771 my $old_head = get_head();
1772 my ($old_laundered_tip,$old_bw,$old_anchor) = walk $old_head;
1774 my $old_bw_cl = classify $old_bw;
1775 my $old_anchor_cl = classify $old_anchor;
1777 if (!$old_anchor_cl->{OrigParents}) {
1778 snag 'anchor-treated',
1779 'old anchor is recognised due to --anchor, cannot check upstream';
1781 $old_upstream = parsecommit
1782 $old_anchor_cl->{OrigParents}[0]{CommitId};
1783 $piece->('', Old => $old_upstream->{CommitId});
1786 if ($old_upstream && $old_upstream->{Msg} =~ m{^\[git-debrebase }m) {
1787 if ($old_upstream->{Msg} =~
1788 m{^\[git-debrebase upstream-combine (\.(?: $extra_orig_namepart_re)+)\:.*\]$}m
1790 my @oldpieces = (split / /, $1);
1791 my $old_n_parents = scalar @{ $old_upstream->{Parents} };
1792 if ($old_n_parents != @oldpieces &&
1793 $old_n_parents != @oldpieces + 1) {
1794 snag 'upstream-confusing', sprintf
1795 "previous upstream combine %s".
1796 " mentions %d pieces (each implying one parent)".
1797 " but has %d parents".
1798 " (one per piece plus maybe a previous combine)",
1799 $old_upstream->{CommitId},
1800 (scalar @oldpieces),
1802 } elsif ($oldpieces[0] ne '.') {
1803 snag 'upstream-confusing', sprintf
1804 "previous upstream combine %s".
1805 " first piece is not \`.'",
1809 foreach my $i (0..$#oldpieces) {
1810 my $n = $oldpieces[$i];
1811 my $hat = 1 + $i + ($old_n_parents - @oldpieces);
1812 $piece->($n, Old => $old_upstream->{CommitId}.'^'.$hat);
1816 snag 'upstream-confusing',
1817 "previous upstream $old_upstream->{CommitId} is from".
1818 " git-debrebase but not an \`upstream-combine' commit";
1822 foreach my $pc (values %pieces) {
1823 if (!$old_upstream) {
1824 # we have complained already
1825 } elsif (!$pc->{Old}) {
1826 snag 'upstream-new-piece',
1827 "introducing upstream piece \`$pc->{Name}'";
1828 } elsif (!$pc->{New}) {
1829 snag 'upstream-rm-piece',
1830 "dropping upstream piece \`$pc->{Name}'";
1831 } elsif (!is_fast_fwd $pc->{Old}, $pc->{New}) {
1832 snag 'upstream-not-ff',
1833 "not fast forward: $pc->{Name} $pc->{Old}..$pc->{New}";
1837 printdebug "%pieces = ", (dd \%pieces), "\n";
1838 printdebug "\@newpieces = ", (dd \@newpieces), "\n";
1846 my @upstream_merge_parents;
1849 push @upstream_merge_parents, $old_upstream->{CommitId};
1852 foreach my $pc (@newpieces) { # always has '' first
1854 read_tree_subdir $pc->{Name}, $pc->{New};
1856 runcmd @git, qw(read-tree), $pc->{New};
1858 push @upstream_merge_parents, $pc->{New};
1861 # index now contains the new upstream
1863 if (@newpieces > 1) {
1864 # need to make the upstream subtree merge commit
1865 $new_upstream = make_commit \@upstream_merge_parents,
1866 [ "Combine upstreams for $new_upstream_version",
1867 ("[git-debrebase upstream-combine . ".
1868 (join " ", map { $_->{Name} } @newpieces[1..$#newpieces]).
1873 # $new_upstream is either the single upstream commit, or the
1874 # combined commit we just made. Either way it will be the
1875 # "upstream" parent of the anchor merge.
1877 read_tree_subdir 'debian', "$old_bw:debian";
1879 # index now contains the anchor merge contents
1880 $new_bw = make_commit [ $old_bw, $new_upstream ],
1881 [ "Update to upstream $new_upstream_version",
1882 "[git-debrebase anchor: new upstream $new_upstream_version, merge]",
1885 my $clogsignoff = cmdoutput qw(git show),
1886 '--pretty=format:%an <%ae> %aD',
1889 # Now we have to add a changelog stanza so the Debian version
1891 die if unlink "debian";
1892 die $! unless $!==ENOENT or $!==ENOTEMPTY;
1893 unlink "debian/changelog" or $!==ENOENT or die $!;
1894 mkdir "debian" or die $!;
1895 open CN, ">", "debian/changelog" or die $!;
1896 my $oldclog = git_cat_file ":debian/changelog";
1897 $oldclog =~ m/^($package_re) \(\S+\) / or
1898 fail "cannot parse old changelog to get package name";
1900 print CN <<END, $oldclog or die $!;
1901 $p ($new_version) UNRELEASED; urgency=medium
1903 * Update to new upstream version $new_upstream_version.
1909 runcmd @git, qw(update-index --add --replace), 'debian/changelog';
1911 # Now we have the final new breakwater branch in the index
1912 $new_bw = make_commit [ $new_bw ],
1913 [ "Update changelog for new upstream $new_upstream_version",
1914 "[git-debrebase: new upstream $new_upstream_version, changelog]",
1918 # we have constructed the new breakwater. we now need to commit to
1919 # the laundering output, because git-rebase can't easily be made
1920 # to make a replay list which is based on some other branch
1922 update_head_postlaunder $old_head, $old_laundered_tip,
1923 'launder for new upstream';
1925 my @cmd = (@git, qw(rebase --onto), $new_bw, $old_bw, @ARGV);
1926 local $ENV{GIT_REFLOG_ACTION} = git_reflog_action_msg
1927 "debrebase new-upstream $new_version: rebase";
1929 # now it's for the user to sort out
1932 sub cmd_record_ffq_prev () {
1933 badusage "no arguments allowed" if @ARGV;
1934 my ($status, $msg) = record_ffq_prev_deferred();
1935 if ($status eq 'exists' && $opt_noop_ok) {
1936 print "Previous head already recorded\n" or die $!;
1937 } elsif ($status eq 'deferred') {
1938 run_deferred_updates 'record-ffq-prev';
1940 fail "Could not preserve: $msg";
1945 badusage "no arguments allowed" if @ARGV;
1946 my ($anchor, $bw) = keycommits +(git_rev_parse 'HEAD'), 0,0;
1947 print "$bw\n" or die $!;
1950 sub cmd_breakwater () {
1951 badusage "no arguments allowed" if @ARGV;
1952 my ($anchor, $bw) = keycommits +(git_rev_parse 'HEAD'), 0,0;
1953 print "$bw\n" or die $!;
1957 badusage "no arguments allowed" if @ARGV;
1959 # todo: gdr status should print divergence info
1960 # todo: gdr status should print upstream component(s) info
1961 # todo: gdr should leave/maintain some refs with this kind of info ?
1963 my $oldest = { Badness => 0 };
1966 my ($badness, $ourmsg, $snagname, $dummy, $cl, $kcmsg) = @_;
1967 if ($oldest->{Badness} < $badness) {
1968 $oldest = $newest = undef;
1971 Badness => $badness,
1972 CommitId => $cl->{CommitId},
1976 $newest //= $oldest;
1978 my ($anchor, $bw) = keycommits +(git_rev_parse 'HEAD'),
1979 sub { $note->(1, 'branch contains furniture (not laundered)', @_); },
1980 sub { $note->(2, 'branch is unlaundered', @_); },
1981 sub { $note->(3, 'branch needs laundering', @_); },
1982 sub { $note->(4, 'branch not in git-debrebase form', @_); };
1984 my $prcommitinfo = sub {
1986 flush STDOUT or die $!;
1987 runcmd @git, qw(--no-pager log -n1),
1988 '--pretty=format: %h %s%n',
1992 print "current branch contents, in git-debrebase terms:\n";
1993 if (!$oldest->{Badness}) {
1994 print " branch is laundered\n";
1996 print " $oldest->{OurMsg}\n";
1998 foreach my $info ($oldest, $newest) {
1999 my $cid = $info->{CommitId};
2000 next if $cid eq $printed;
2002 print " $info->{KcMsg}\n";
2003 $prcommitinfo->($cid);
2008 my ($cid, $what) = @_;
2009 if (!defined $cid) {
2010 print " $what is not well-defined\n";
2013 $prcommitinfo->($cid);
2016 print "key git-debrebase commits:\n";
2017 $prab->($anchor, 'anchor');
2018 $prab->($bw, 'breakwater');
2020 my ($ffqstatus, $ffq_msg, $current, $ffq_prev, $gdrlast) =
2021 ffq_prev_branchinfo();
2023 print "branch and ref status, in git-debrebase terms:\n";
2025 print " $ffq_msg\n";
2027 $ffq_prev = git_get_ref $ffq_prev;
2028 $gdrlast = git_get_ref $gdrlast;
2030 print " unstitched; previous tip was:\n";
2031 $prcommitinfo->($ffq_prev);
2032 } elsif (!$gdrlast) {
2033 print " stitched? (no record of git-debrebase work)\n";
2034 } elsif (is_fast_fwd $gdrlast, 'HEAD') {
2035 print " stitched\n";
2037 print " not git-debrebase (diverged since last stitch)\n"
2040 print "you are currently rebasing\n" if currently_rebasing();
2044 my $prose = 'stitch';
2045 getoptions("stitch",
2046 'prose=s', \$prose);
2047 badusage "no arguments allowed" if @ARGV;
2048 do_stitch $prose, 0;
2050 sub cmd_prepush () { cmd_stitch(); }
2053 badusage "no arguments allowed" if @ARGV;
2054 do_launder_head 'launder for git-debrebase quick';
2058 sub cmd_conclude () {
2059 my ($ffq_prev, $gdrlast, $ffq_prev_commitish) = ffq_prev_info();
2060 if (!$ffq_prev_commitish) {
2061 fail "No ongoing git-debrebase session." unless $opt_noop_ok;
2064 my $dangling_head = get_head();
2066 badusage "no arguments allowed" if @ARGV;
2067 do_launder_head 'launder for git-debrebase quick';
2072 if (currently_rebasing()) {
2073 runcmd @git, qw(rebase --abort);
2075 my ($ffq_prev, $gdrlast, $ffq_prev_commitish) = ffq_prev_info();
2076 if (!$ffq_prev_commitish) {
2077 fail "No ongoing git-debrebase session." unless $opt_noop_ok;
2080 my $scrapping_head = get_head();
2081 badusage "no arguments allowed" if @ARGV;
2082 push @deferred_updates,
2083 "update $gdrlast $ffq_prev_commitish $git_null_obj",
2084 "update $ffq_prev $git_null_obj $ffq_prev_commitish";
2086 update_head_checkout $scrapping_head, $ffq_prev_commitish, "scrap";
2089 sub make_patches_staged ($) {
2091 # Produces the patches that would result from $head if it were
2093 my ($secret_head, $secret_bw, $last_anchor) = walk $head;
2096 gbp_pq_export 'bw', $secret_bw, $secret_head;
2100 sub make_patches ($) {
2102 keycommits $head, 0, \&snag;
2103 make_patches_staged $head;
2106 my $ptree = cmdoutput @git, qw(write-tree --prefix=debian/patches/);
2107 runcmd @git, qw(read-tree), $head;
2108 read_tree_subdir 'debian/patches', $ptree;
2109 $out = make_commit [$head], [
2110 'Commit patch queue (exported by git-debrebase)',
2111 '[git-debrebase: export and commit patches]',
2117 sub cmd_make_patches () {
2118 my $opt_quiet_would_amend;
2119 getoptions("make-patches",
2120 'quiet-would-amend!', \$opt_quiet_would_amend);
2121 badusage "no arguments allowed" if @ARGV;
2123 my $old_head = get_head();
2124 my $new = make_patches $old_head;
2125 my $d = get_differs $old_head, $new;
2127 fail "No (more) patches to export." unless $opt_noop_ok;
2129 } elsif ($d == D_PAT_ADD) {
2131 update_head_checkout $old_head, $new, 'make-patches';
2133 print STDERR failmsg
2134 "Patch export produced patch amendments".
2135 " (abandoned output commit $new).".
2136 " Try laundering first."
2137 unless $opt_quiet_would_amend;
2142 sub cmd_convert_from_gbp () {
2143 badusage "want only 1 optional argument, the upstream git commitish"
2146 my $clogp = parsechangelog();
2147 my $version = $clogp->{'Version'}
2148 // die "missing Version from changelog";
2150 my ($upstream_spec) = @ARGV;
2152 my $upstream_version = upstreamversion $version;
2154 resolve_upstream_version($upstream_spec, $upstream_version);
2156 my $old_head = get_head();
2158 my $upsdiff = get_differs $upstream, $old_head;
2159 if ($upsdiff & D_UPS) {
2160 runcmd @git, qw(--no-pager diff --stat),
2161 $upstream, $old_head,
2162 qw( -- :!/debian :/);
2164 upstream ($upstream_spec) and HEAD are not
2165 identical in upstream files. See diffstat above, or run
2166 git diff $upstream_spec HEAD -- :!/debian :/
2170 if (!is_fast_fwd $upstream, $old_head) {
2171 snag 'upstream-not-ancestor',
2172 "upstream ($upstream) is not an ancestor of HEAD";
2174 my $wrong = cmdoutput
2175 (@git, qw(rev-list --ancestry-path), "$upstream..HEAD",
2176 qw(-- :/ :!/debian));
2177 if (length $wrong) {
2178 snag 'unexpected-upstream-changes',
2179 "history between upstream ($upstream) and HEAD contains direct changes to upstream files - are you sure this is a gbp (patches-unapplied) branch?";
2180 print STDERR "list expected changes with: git log --stat --ancestry-path $upstream_spec..HEAD -- :/ ':!/debian'\n";
2184 if ((git_cat_file "$upstream:debian")[0] ne 'missing') {
2185 snag 'upstream-has-debian',
2186 "upstream ($upstream) contains debian/ directory";
2189 my $previous_dgit_view = eval {
2190 my @clogcmd = qw(dpkg-parsechangelog --format rfc822 -n2);
2192 parsechangelog_loop \@clogcmd, 'debian/changelog', sub {
2193 my ($stz, $desc) = @_;
2194 no warnings qw(exiting);
2195 printdebug 'CHANGELOG ', Dumper($desc, $stz);
2196 next unless $stz->{Date};
2197 next unless $stz->{Distribution} ne 'UNRELEASED';
2198 $lvsn = $stz->{Version};
2199 $suite = $stz->{Distribution};
2202 die "neither of the first two changelog entries are released\n"
2203 unless defined $lvsn;
2204 print "last finished-looking changelog entry: ($lvsn) $suite\n";
2205 my $mtag_pat = debiantag_maintview $lvsn, '*';
2206 my $mtag = cmdoutput @git, qw(describe --always --abbrev=0 --match),
2208 die "could not find suitable maintainer view tag $mtag_pat\n"
2209 unless $mtag_pat =~ m{/};
2210 is_fast_fwd $mtag, 'HEAD' or
2211 die "HEAD is not FF from maintainer tag $mtag!";
2212 my $dtag = "archive/$mtag";
2213 is_fast_fwd $mtag, $dtag or
2214 die "dgit view tag $dtag is not FF from maintainer tag $mtag";
2215 print "will stitch in dgit view, $dtag\n";
2216 git_rev_parse $dtag;
2218 if (!$previous_dgit_view) {
2221 print STDERR "cannot stitch in dgit view: $@\n";
2224 snags_maybe_bail_early();
2230 runcmd @git, qw(checkout -q -b gdr-internal), $old_head;
2231 # make a branch out of the patch queue - we'll want this in a mo
2232 runcmd qw(gbp pq import);
2233 # strip the patches out
2234 runcmd @git, qw(checkout -q gdr-internal~0);
2235 rm_subdir_cached 'debian/patches';
2236 $work = make_commit ['HEAD'], [
2237 'git-debrebase convert-from-gbp: drop patches from tree',
2238 'Delete debian/patches, as part of converting to git-debrebase format.',
2239 '[git-debrebase convert-from-gbp: drop patches from tree]'
2241 # make the anchor merge
2242 # the tree is already exactly right
2243 $work = make_commit [$work, $upstream], [
2244 'git-debrebase import: declare upstream',
2245 'First breakwater merge.',
2246 '[git-debrebase anchor: declare upstream]'
2249 # rebase the patch queue onto the new breakwater
2250 runcmd @git, qw(reset --quiet --hard patch-queue/gdr-internal);
2251 runcmd @git, qw(rebase --quiet --onto), $work, qw(gdr-internal);
2252 $work = git_rev_parse 'HEAD';
2254 if ($previous_dgit_view) {
2255 $work = make_commit [$work, $previous_dgit_view], [
2256 'git-debrebase import: declare ff from dgit archive view',
2257 '[git-debrebase pseudomerge: import-from-gbp]',
2264 update_head_checkout $old_head, $work, 'convert-from-gbp';
2267 sub cmd_convert_to_gbp () {
2268 badusage "no arguments allowed" if @ARGV;
2269 my $head = get_head();
2270 my (undef, undef, undef, $ffq, $gdrlast) = ffq_prev_branchinfo();
2271 keycommits $head, 0;
2273 make_patches_staged $head;
2275 $out = make_commit ['HEAD'], [
2276 'Commit patch queue (converted from git-debrebase format)',
2277 '[git-debrebase convert-to-gbp: commit patches]',
2281 push @deferred_updates, "delete $ffq";
2282 push @deferred_updates, "delete $gdrlast";
2285 update_head_checkout $head, $out, "convert to gbp (v0)";
2286 print <<END or die $!;
2287 git-debrebase: converted to git-buildpackage branch format
2288 git-debrebase: WARNING: do not now run "git-debrebase" any more
2289 git-debrebase: WARNING: doing so would drop all upstream patches!
2293 sub cmd_convert_from_dgit_view () {
2294 my $clogp = parsechangelog();
2296 my $bpd = (cfg 'dgit.default.build-products-dir',1) // '..';
2302 getoptions("convert-from-dgit-view",
2303 'diagnose!', \$diagnose,
2304 'build-products-dir:s', \$bpd,
2305 'origs!', \$do_origs,
2307 'always-convert-anyway!', \$always);
2308 fail "takes 1 optional argument, the upstream commitish" if @ARGV>1;
2313 my $spec = shift @ARGV;
2314 my $commit = git_rev_parse "$spec^{commit}";
2315 push @upstreams, { Commit => $commit,
2316 Source => "$ARGV[0], from command line",
2321 my $head = get_head();
2325 my $trouble = sub { $troubles++; };
2326 keycommits $head, sub{}, sub{}, $trouble, $trouble;
2327 printdebug "troubles=$troubles\n";
2330 $us: Branch already seems to be in git-debrebase format!
2331 $us: --always-convert-anyway would do the conversion operation anyway
2332 $us: but is probably a bad idea. Probably, you wanted to do nothing.
2334 fail "Branch already in git-debrebase format." unless $opt_noop_ok;
2339 snags_maybe_bail_early();
2341 my $version = upstreamversion $clogp->{Version};
2342 print STDERR "Considering possible commits corresponding to upstream:\n";
2347 my $ups_tag = upstream_commitish_search $version, \@tried;
2349 my $this = "git tag $tried[-1]";
2350 push @upstreams, { Commit => $ups_tag,
2355 " git tag: no suitable tag found (tried %s)\n",
2360 my $p = $clogp->{'Source'};
2361 # we do a quick check to see if there are plausible origs
2363 if (!opendir BPD, $bpd) {
2364 die "$bpd: opendir: $!" unless $!==ENOENT;
2366 while ($!=0, my $f = readdir BPD) {
2367 next unless is_orig_file_of_p_v $f, $p, $version;
2369 " orig: found what looks like a .orig, %s\n",
2374 die "read $bpd: $!" if $!;
2378 my $tree = cmdoutput
2379 @dgit, qw(--build-products-dir), $bpd,
2380 qw(print-unapplied-treeish);
2383 runcmd @git, qw(reset --quiet), $tree, qw(-- .);
2384 rm_subdir_cached 'debian';
2385 $tree = cmdoutput @git, qw(write-tree);
2386 my $ups_synth = make_commit [], [ <<END, <<END,
2387 Import effective orig tree for upstream version $version
2389 This includes the contents of the .orig(s), minus any debian/ directory.
2391 [git-debrebase import-from-dgit-view upstream-import-convert: $version]
2394 push @upstreams, { Commit => $ups_synth,
2395 Source => "orig(s) imported via dgit",
2400 " orig: no suitable origs found (looked for %s in %s)\n",
2401 "${p}_".(stripeoch $version)."...", $bpd;
2406 my $some_patches = stat_exists 'debian/patches/series';
2408 print STDERR "Evaluating possible commits corresponding to upstream:\n";
2411 foreach my $u (@upstreams) {
2415 runcmd @git, qw(reset --quiet), $u->{Commit}, qw(-- .);
2416 runcmd @git, qw(checkout), $u->{Commit}, qw(-- .);
2417 runcmd @git, qw(clean -xdff);
2418 runcmd @git, qw(checkout), $head, qw(-- debian);
2419 if ($some_patches) {
2420 rm_subdir_cached 'debian/patches';
2421 $work = make_commit [ $work ], [
2422 'git-debrebase convert-from-dgit-view: drop upstream changes from breakwater',
2423 "Drop upstream changes, and delete debian/patches, as part of converting\n".
2424 "to git-debrebase format. Upstream changes will appear as commits.",
2425 '[git-debrebase convert-from-dgit-view: drop patches from tree]'
2428 $work = make_commit [ $work, $u->{Commit} ], [
2429 'git-debrebase convert-from-dgit-view: declare upstream',
2430 '(Re)constructed breakwater merge.',
2431 '[git-debrebase anchor: declare upstream]'
2433 runcmd @git, qw(checkout --quiet -b mk), $work;
2434 if ($some_patches) {
2435 runcmd @git, qw(checkout), $head, qw(-- debian/patches);
2436 runcmd @git, qw(reset --quiet);
2437 my @gbp_cmd = (qw(gbp pq import));
2439 my $gbp_err = "../gbp-pq-err";
2440 @gbp_cmd = shell_cmd "exec >$gbp_err 2>&1", @gbp_cmd;
2442 my $r = system @gbp_cmd;
2445 " %s: couldn't apply patches: gbp pq %s",
2446 $u->{Source}, waitstatusmsg();
2450 my $work = git_rev_parse qw(HEAD);
2451 my $diffout = cmdoutput @git, qw(diff-tree --stat HEAD), $work;
2452 if (length $diffout) {
2454 " $u->{Source}: applying patches gives different tree\n";
2455 print STDERR $diffout if $diagnose;
2459 $u->{Result} = $work;
2467 Could not find or construct a suitable upstream commit.
2468 Rerun adding --diagnose after convert-from-dgit-view, or pass a
2469 upstream commmit explicitly or provide suitable origs.
2473 printf STDERR "Yes, will base new branch on %s\n", $result->{Source};
2475 ffq_check $result->{Result};
2477 update_head_checkout $head, $result->{Result},
2478 'convert-from-dgit-view';
2481 sub cmd_downstream_rebase_launder_v0 () {
2482 badusage "needs 1 argument, the baseline" unless @ARGV==1;
2484 $base = git_rev_parse $base;
2485 my $old_head = get_head();
2486 my $current = $old_head;
2489 if ($current eq $base) {
2490 $topmost_keep //= $current;
2491 print " $current BASE stop\n";
2494 my $cl = classify $current;
2495 print " $current $cl->{Type}";
2497 my $p0 = $cl->{Parents}[0]{CommitId};
2499 if ($cl->{Type} eq 'Pseudomerge') {
2500 print " ^".($cl->{Contributor}{Ix}+1);
2501 $next = $cl->{Contributor}{CommitId};
2502 } elsif ($cl->{Type} eq 'AddPatches' or
2503 $cl->{Type} eq 'Changelog') {
2513 $topmost_keep //= $current;
2515 die "to-be stripped changes not on top of the branch\n"
2520 if ($topmost_keep eq $old_head) {
2521 print "unchanged\n";
2523 print "updating to $topmost_keep\n";
2524 update_head_checkout
2525 $old_head, $topmost_keep,
2526 'downstream-rebase-launder-v0';
2532 "D+" => \$debuglevel,
2533 'noop-ok', => \$opt_noop_ok,
2534 'f=s' => \@snag_force_opts,
2535 'anchor=s' => \@opt_anchors,
2536 '--dgit=s' => \($dgit[0]),
2539 my ($opt,$val) = @_;
2540 badusage "git-debrebase: no cuddling to -i for git-rebase"
2542 die if $opt_defaultcmd_interactive; # should not happen
2543 $opt_defaultcmd_interactive = [ qw(-i) ];
2544 # This access to @ARGV is excessive familiarity with
2545 # Getopt::Long, but there isn't another sensible
2546 # approach. '-i=s{0,}' does not work with bundling.
2547 push @$opt_defaultcmd_interactive, @ARGV;
2550 'help' => sub { print $usage_message or die $!; finish 0; },
2553 initdebug('git-debrebase ');
2554 enabledebug if $debuglevel;
2556 my $toplevel = cmdoutput @git, qw(rev-parse --show-toplevel);
2557 chdir $toplevel or die "chdir $toplevel: $!";
2559 $rd = fresh_playground "$playprefix/misc";
2561 @opt_anchors = map { git_rev_parse $_ } @opt_anchors;
2563 if (!@ARGV || $opt_defaultcmd_interactive || $ARGV[0] =~ m{^-}) {
2564 defaultcmd_rebase();
2566 my $cmd = shift @ARGV;
2569 $cmdfn = ${*::}{"cmd_$cmdfn"};
2571 $cmdfn or badusage "unknown git-debrebase sub-operation $cmd";