X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=dgit.git;a=blobdiff_plain;f=git-debrebase;h=e5cafd1c4850a7192fe21e06851931963eb12b26;hp=19beef8c3ffc422eba8e7468e43ac2ccb29ecb6b;hb=ca261d36408442d8f3beeac12434af95810b1e32;hpb=0943c19e7dcccf0ac05fb266b232a9c36781264e diff --git a/git-debrebase b/git-debrebase index 19beef8c..e5cafd1c 100755 --- a/git-debrebase +++ b/git-debrebase @@ -18,63 +18,8 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . - -# usages: -# -# git-debrebase [] new-upstream-v0 \ -# \ -# [ ...] \ -# [...] -# -# git-debrebase [ --] [] -# git-debrebase [] analyse -# git-debrebase [] launder # prints breakwater tip etc. -# git-debrebase [] downstream-rebase-launder-v0 # experimental -# -# git-debrebase [] gbp2debrebase-v0 \ -# - -# problems / outstanding questions: -# -# * dgit push with a `3.0 (quilt)' package means doing quilt -# fixup. Usually this involves recommitting the whole patch -# series, one at a time, with dpkg-source --commit. This is -# terribly terribly slow. (Maybe this should be fixed in dgit.) -# -# * dgit push usually needs to (re)make a pseudomerge. The "first" -# git-debrebase stripped out the previous pseudomerge and could -# have remembeed the HEAD. But it's not quite clear what history -# ought to be preserved and what should be discarded. For now -# the user will have to tell dgit --overwrite. -# -# To fix this, do we need a new push hook for dgit ? -# -# * Workflow is currently clumsy. Lots of spurious runes to type. -# There's not even a guide. -# -# * There are no tests. -# -# * new-upstream-v0 has a terrible UI. You end up with giant -# runic command lines. -# -# One consequence of the lack of richness it can need --force in -# fairly sensible situations and there is no way to tell it what -# you are really trying to do, other than just --force. There -# should be an interface with some default branch names. -# -# * There should be a standard convention for the version number, -# and unfinalised or not changelog, after new-upstream. -# -# * Handing of multi-orig dgit new-upstream .dsc imports is known to -# be broken. They may be not recognised, improperly converted, or -# their conversion may be unrecognised. -# -# * Docs need writing and updating. Even README.git-debrebase -# describes a design but may not reflect the implementation. -# -# * We need to develop a plausible model that works for derivatives, -# who probably want to maintain their stack on top of Debian's. -# downstream-rebase-launder-v0 may be a starting point? +END { $? = $Debian::Dgit::ExitStatus::desired // -1; }; +use Debian::Dgit::ExitStatus; use strict; @@ -89,13 +34,15 @@ use Getopt::Long qw(:config posix_default gnu_compat bundling); use Dpkg::Version; use File::FnMatch qw(:fnmatch); -our ($opt_force, $opt_noop_ok); +our ($opt_force, $opt_noop_ok, @opt_anchors); +our ($opt_defaultcmd_interactive); our $us = qw(git-debrebase); sub badusage ($) { my ($m) = @_; - die "bad usage: $m\n"; + print STDERR "bad usage: $m\n"; + finish 8; } sub cfg ($;$) { @@ -109,7 +56,8 @@ sub cfg ($;$) { fail "missing required git config $k" unless $optional; return (); } - return split /\0/, $out; + my @l = split /\0/, $out; + return wantarray ? @l : $l[0]; } memoize('cfg'); @@ -154,6 +102,36 @@ sub fresh_workarea () { in_workarea sub { playtree_setup }; } +our $snags_forced = 0; +our $snags_tripped = 0; +our $snags_summarised = 0; +our @deferred_updates; +our @deferred_update_messages; + +sub all_snags_summarised () { + $snags_forced + $snags_tripped == $snags_summarised; +} +sub run_deferred_updates ($) { + my ($mrest) = @_; + + confess 'dangerous internal error' unless all_snags_summarised(); + + my @upd_cmd = (@git, qw(update-ref --stdin -m), "debrebase: $mrest"); + debugcmd '>|', @upd_cmd; + open U, "|-", @upd_cmd or die $!; + foreach (@deferred_updates) { + printdebug ">= ", $_, "\n"; + print U $_, "\n" or die $!; + } + printdebug ">\$\n"; + close U or failedcmd @upd_cmd; + + print $_, "\n" foreach @deferred_update_messages; + + @deferred_updates = (); + @deferred_update_messages = (); +} + sub get_differs ($$) { my ($x,$y) = @_; # This resembles quiltify_trees_differ, in dgit, a bit. @@ -259,40 +237,45 @@ sub make_commit ($$) { return cmdoutput @cmd; } -our @fproblem_force_opts; -our $fproblems_forced; -our $fproblems_tripped; -sub fproblem ($$) { - my ($tag,$msg) = @_; - if (grep { $_ eq $tag } @fproblem_force_opts) { - $fproblems_forced++; - print STDERR "git-debrebase: safety catch overridden (-f$tag): $msg\n"; +our @snag_force_opts; +sub snag ($$;@) { + my ($tag,$msg) = @_; # ignores extra args, for benefit of keycommits + if (grep { $_ eq $tag } @snag_force_opts) { + $snags_forced++; + print STDERR "git-debrebase: snag ignored (-f$tag): $msg\n"; } else { - $fproblems_tripped++; - print STDERR "git-debrebase: safety catch tripped (-f$tag): $msg\n"; + $snags_tripped++; + print STDERR "git-debrebase: snag detected (-f$tag): $msg\n"; } } -sub fproblems_maybe_bail () { - if ($fproblems_forced) { +# Important: all mainline code must call snags_maybe_bail after +# any point where snag might be called, but before making changes +# (eg before any call to run_deferred_updates). snags_maybe_bail +# may be called more than once if necessary (but this is not ideal +# because then the messages about number of snags may be confusing). +sub snags_maybe_bail () { + return if all_snags_summarised(); + if ($snags_forced) { printf STDERR - "%s: safety catch trips: %d overriden by individual -f options\n", - $us, $fproblems_forced; + "%s: snags: %d overriden by individual -f options\n", + $us, $snags_forced; } - if ($fproblems_tripped) { + if ($snags_tripped) { if ($opt_force) { printf STDERR - "%s: safety catch trips: %d overriden by global --force\n", - $us, $fproblems_tripped; + "%s: snags: %d overriden by global --force\n", + $us, $snags_tripped; } else { fail sprintf - "%s: safety catch trips: %d blockers (you could -f, or --force)", - $us, $fproblems_tripped; + "%s: snags: %d blockers (you could -f, or --force)", + $us, $snags_tripped; } } + $snags_summarised = $snags_forced + $snags_tripped; } -sub any_fproblems () { - return $fproblems_forced || $fproblems_tripped; +sub any_snags () { + return $snags_forced || $snags_tripped; } # classify returns an info hash like this @@ -317,7 +300,6 @@ sub any_fproblems () { # Upstream # AddPatches # Mixed -# Unknown # # Pseudomerge # has additional entres in classification result @@ -328,9 +310,17 @@ sub any_fproblems () { # has additional entry in classification result # OrigParents = [ subset of Parents ] # -# BreakwaterUpstreamMerge +# Anchor # has additional entry in classification result # OrigParents = [ subset of Parents ] # singleton list +# +# TreatAsAnchor +# +# BreakwaterStart +# +# Unknown +# has additional entry in classification result +# Why => "prose" sub parsecommit ($;$) { my ($objid, $p_ref) = @_; @@ -389,18 +379,88 @@ sub classify ($) { }; my $unknown = sub { my ($why) = @_; - $r = { %$r, Type => qw(Unknown) }; + $r = { %$r, Type => qw(Unknown), Why => $why }; printdebug " ** Unknown\n"; return $r; }; - my $claims_to_be_breakwater = - $r->{Msg} =~ m{^\[git-debrebase breakwater.*\]$}m; + if (grep { $_ eq $objid } @opt_anchors) { + return $classify->('TreatAsAnchor'); + } + + my @identical = grep { !$_->{Differs} } @p; + my ($stype, $series) = git_cat_file "$t:debian/patches/series"; + my $haspatches = $stype ne 'missing' && $series =~ m/^\s*[^#\n\t ]/m; + + if ($r->{Msg} =~ m{^\[git-debrebase anchor.*\]$}m) { + # multi-orig upstreams are represented with an anchor merge + # from a single upstream commit which combines the orig tarballs + + # Every anchor tagged this way must be a merge. + # We are relying on the + # [git-debrebase anchor: ...] + # commit message annotation in "declare" anchor merges (which + # do not have any upstream changes), to distinguish those + # anchor merges from ordinary pseudomerges (which we might + # just try to strip). + # + # However, the user is going to be doing git-rebase a lot. We + # really don't want them to rewrite an anchor commit. + # git-rebase trips up on merges, so that is a useful safety + # catch. + # + # BreakwaterStart commits are also anchors in the terminology + # of git-debrebase(5), but they are untagged (and always + # manually generated). + # + # We cannot not tolerate any tagged linear commit (ie, + # BreakwaterStart commits tagged `[anchor:') because such a + # thing could result from an erroneous linearising raw git + # rebase of a merge anchor. That would represent a corruption + # of the branch. and we want to detect and reject the results + # of such corruption before it makes it out anywhere. If we + # reject it here then we avoid making the pseudomerge which + # would be needed to push it. + + my $badanchor = sub { $unknown->("git-debrebase \`anchor' but @_"); }; + @p == 2 or return $badanchor->("has other than two parents"); + $haspatches and return $badanchor->("contains debian/patches"); + + # How to decide about l/r ordering of anchors ? git + # --topo-order prefers to expand 2nd parent first. There's + # already an easy rune to look for debian/ history anyway (git log + # debian/) so debian breakwater branch should be 1st parent; that + # way also there's also an easy rune to look for the upstream + # patches (--topo-order). + + # Also this makes --first-parent be slightly more likely to + # be useful - it makes it provide a linearised breakwater history. + + # Of course one can say somthing like + # gitk -- ':/' ':!/debian' + # to get _just_ the commits touching upstream files, and by + # the TREESAME logic in git-rev-list this will leave the + # breakwater into upstream at the first anchor. But that + # doesn't report debian/ changes at all. + + # Other observations about gitk: by default, gitk seems to + # produce output in a different order to git-rev-list. I + # can't seem to find this documented anywhere. gitk + # --date-order DTRT. But, gitk always seems to put the + # parents from left to right, in order, so it's easy to see + # which way round a pseudomerge is. + + $p[0]{IsOrigin} and $badanchor->("is an origin commit"); + $p[1]{Differs} & ~DS_DEB and + $badanchor->("upstream files differ from left parent"); + $p[0]{Differs} & ~D_UPS and + $badanchor->("debian/ differs from right parent"); + + return $classify->(qw(Anchor), + OrigParents => [ $p[1] ]); + } if (@p == 1) { - if ($claims_to_be_breakwater) { - return $unknown->("single-parent git-debrebase breakwater \`merge'"); - } my $d = $r->{Parents}[0]{Differs}; if ($d == D_PAT_ADD) { return $classify->(qw(AddPatches)); @@ -433,27 +493,32 @@ sub classify ($) { return $unknown->("origin commit"); } - my @identical = grep { !$_->{Differs} } @p; - if (@p == 2 && @identical == 1 && !$claims_to_be_breakwater - # breakwater merges can look like pseudomerges, if they are - # "declare" commits (ie, there are no upstream changes) - ) { + if (@p == 2 && @identical == 1) { my @overwritten = grep { $_->{Differs} } @p; confess "internal error $objid ?" unless @overwritten==1; return $classify->(qw(Pseudomerge), - Overwritten => $overwritten[0], + Overwritten => [ $overwritten[0] ], Contributor => $identical[0]); } if (@p == 2 && @identical == 2) { - my @bytime = nsort_by { - my ($ph,$pm) = get_commit $_->{CommitId}; + my $get_t = sub { + my ($ph,$pm) = get_commit $_[0]{CommitId}; $ph =~ m/^committer .* (\d+) [-+]\d+$/m or die "$_->{CommitId} ?"; $1; - } @p; + }; + my @bytime = @p; + my $order = $get_t->($bytime[0]) <=> $get_t->($bytime[1]); + if ($order > 0) { # newer first + } elsif ($order < 0) { + @bytime = reverse @bytime; + } else { + # same age, default to order made by -s ours + # that is, commit was made by someone who preferred L + } return $classify->(qw(Pseudomerge), SubType => qw(Ambiguous), - Overwritten => $bytime[0], - Contributor => $bytime[1]); + Contributor => $bytime[0], + Overwritten => [ $bytime[1] ]); } foreach my $p (@p) { my ($p_h, $p_m) = get_commit $p->{CommitId}; @@ -470,46 +535,95 @@ sub classify ($) { OrigParents => \@orig_ps); } - my ($stype, $series) = git_cat_file "$t:debian/patches/series"; - my $haspatches = $stype ne 'missing' && $series =~ m/^\s*[^#\n\t ]/m; + return $unknown->("complex merge"); +} - # How to decide about l/r ordering of breakwater merges ? git - # --topo-order prefers to expand 2nd parent first. There's - # already an easy rune to look for debian/ history anyway (git log - # debian/) so debian breakwater branch should be 1st parent; that - # way also there's also an easy rune to look for the upstream - # patches (--topo-order). - - # The above tells us which way *we* will generate them. But we - # might encounter ad-hoc breakwater merges generated manually, - # which might be the other way around. In principle, in some odd - # situations, a breakwater merge might have two identical parents. - # In that case we guess which way round it is (ie, which parent - # has the upstream history). The order of the 2-iteration loop - # controls which guess we make. - - foreach my $prevbrw (qw(0 1)) { - if (@p == 2 && - !$haspatches && - !$p[$prevbrw]{IsOrigin} && # breakwater never starts with an origin - !($p[!$prevbrw]{Differs} & ~DS_DEB) && # no non-debian changess - !($p[$prevbrw]{Differs} & ~D_UPS)) { # no non-upstream changes - return $classify->(qw(BreakwaterUpstreamMerge), - OrigParents => [ $p[!$prevbrw] ]); +sub keycommits ($;$$$$) { + my ($head, $furniture, $unclean, $trouble, $fatal) = @_; + # => ($anchor, $breakwater) + + # $unclean->("unclean-$tagsfx", $msg, $cl) + # $furniture->("unclean-$tagsfx", $msg, $cl) + # $dgitimport->("unclean-$tagsfx", $msg, $cl)) + # is callled for each situation or commit that + # wouldn't be found in a laundered branch + # $furniture is for furniture commits such as might be found on an + # interchange branch (pseudomerge, d/patches, changelog) + # $trouble is for things whnich prevent the return of + # anchor and breakwater information; if that is ignored, + # then keycommits returns (undef, undef) instead. + # $fatal is for unprocessable commits, and should normally cause + # a failure. If ignored, agaion, (undef, undef) is returned. + # + # If a callback is undef, fail is called instead. + # If a callback is defined but false, the situation is ignored. + # Callbacks may say: + # no warnings qw(exiting); last; + # if the answer is no longer wanted. + + my ($anchor, $breakwater); + my $clogonly; + my $cl; + $fatal //= sub { fail $_[2]; }; + my $x = sub { + my ($cb, $tagsfx, $why) = @_; + my $m = "branch needs laundering (run git-debrebase): $why"; + fail $m unless defined $cb; + return unless $cb; + $cb->("unclean-$tagsfx", $why, $cl); + }; + for (;;) { + $cl = classify $head; + my $ty = $cl->{Type}; + if ($ty eq 'Packaging') { + $breakwater //= $clogonly; + $breakwater //= $head; + } elsif ($ty eq 'Changelog') { + # this is going to count as the tip of the breakwater + # only if it has no upstream stuff before it + $clogonly //= $head; + } elsif ($ty eq 'Anchor' or + $ty eq 'TreatAsAnchor' or + $ty eq 'BreakwaterStart') { + $anchor = $head; + $breakwater //= $clogonly; + $breakwater //= $head; + last; + } elsif ($ty eq 'Upstream') { + $x->($unclean, 'ordering', + "packaging change ($breakwater) follows upstream change (eg $head)") + if defined $breakwater; + $clogonly = undef; + $breakwater = undef; + } elsif ($ty eq 'Mixed') { + $x->($unclean, 'mixed', + "found mixed upstream/packaging commit ($head)"); + $clogonly = undef; + $breakwater = undef; + } elsif ($ty eq 'Pseudomerge' or + $ty eq 'AddPatches') { + $x->($furniture, (lc $ty), + "found interchange bureaucracy commit ($ty, $head)"); + } elsif ($ty eq 'DgitImportUnpatched') { + $x->($trouble, 'dgitimport', + "found dgit dsc import ($head)"); + return (undef,undef); + } else { + $x->($fatal, 'unprocessable', + "found unprocessable commit, cannot cope: $head; $cl->{Why}" + ); + return (undef,undef); } + $head = $cl->{Parents}[0]{CommitId}; } - - # multi-orig upstreams are represented with a breakwater merge - # from a single upstream commit which combines the orig tarballs - - return $unknown->("complex merge"); + return ($anchor, $breakwater); } sub walk ($;$$); sub walk ($;$$) { my ($input, $nogenerate,$report) = @_; - # => ($tip, $breakwater_tip, $last_upstream_merge_in_breakwater) + # => ($tip, $breakwater_tip, $last_anchor) # (or nothing, if $nogenerate) printdebug "*** WALK $input ".($nogenerate//0)." ".($report//'-')."\n"; @@ -532,8 +646,9 @@ sub walk ($;$$) { return (Msg => $ms); }; my $rewrite_from_here = sub { + my ($cl) = @_; my $sp_cl = { SpecialMethod => 'StartRewrite' }; - push @brw_cl, $sp_cl; + push @$cl, $sp_cl; push @processed, $sp_cl; }; my $cur = $input; @@ -549,13 +664,16 @@ sub walk ($;$$) { my $bomb = sub { # usage: return $bomb->(); print $report " Unprocessable" if $report; + print $report " ($cl->{Why})" if $report && defined $cl->{Why}; $prprdelim->(); if ($nogenerate) { return (undef,undef); } die "commit $cur: Cannot cope with this commit (d.". (join ' ', map { sprintf "%#x", $_->{Differs} } - @{ $cl->{Parents} }). ")"; + @{ $cl->{Parents} }). + (defined $cl->{Why} ? "; $cl->{Why}": ''). + ")"; }; my $build; @@ -568,7 +686,7 @@ sub walk ($;$$) { no warnings qw(exiting); last; }; - my $last_upstream_update; + my $last_anchor; for (;;) { $cl = classify $cur; @@ -580,14 +698,14 @@ sub walk ($;$$) { my $p0 = @{ $cl->{Parents} }==1 ? $cl->{Parents}[0]{CommitId} : undef; if ($ty eq 'AddPatches') { $cur = $p0; - $rewrite_from_here->(); + $rewrite_from_here->(\@upp_cl); next; } elsif ($ty eq 'Packaging' or $ty eq 'Changelog') { push @brw_cl, $cl; $cur = $p0; next; } elsif ($ty eq 'BreakwaterStart') { - $last_upstream_update = $cur; + $last_anchor = $cur; $build_start->('FirstPackaging', $cur); } elsif ($ty eq 'Upstream') { push @upp_cl, $cl; @@ -601,19 +719,19 @@ sub walk ($;$$) { }; $queue->(\@brw_cl, "debian"); $queue->(\@upp_cl, "upstream"); - $rewrite_from_here->(); + $rewrite_from_here->(\@brw_cl); $cur = $p0; next; } elsif ($ty eq 'Pseudomerge') { my $contrib = $cl->{Contributor}{CommitId}; print $report " Contributor=$contrib" if $report; push @pseudomerges, $cl; - $rewrite_from_here->(); + $rewrite_from_here->(\@upp_cl); $cur = $contrib; next; - } elsif ($ty eq 'BreakwaterUpstreamMerge') { - $last_upstream_update = $cur; - $build_start->("PreviousBreakwater", $cur); + } elsif ($ty eq 'Anchor' or $ty eq 'TreatAsAnchor') { + $last_anchor = $cur; + $build_start->("Anchor", $cur); } elsif ($ty eq 'DgitImportUnpatched') { my $pm = $pseudomerges[-1]; if (defined $pm) { @@ -626,7 +744,8 @@ sub walk ($;$$) { # suite intended by the non-dgit NMUer, and later # pseudomerges may represent in-archive copies. my $ovwrs = $pm->{Overwritten}; - printf $report " PM=%s \@Overwr:%d", $pm, (scalar @$ovwrs) + printf $report " PM=%s \@Overwr:%d", + $pm->{CommitId}, (scalar @$ovwrs) if $report; if (@$ovwrs != 1) { printdebug "*** WALK BOMB DgitImportUnpatched\n"; @@ -649,26 +768,15 @@ sub walk ($;$$) { %$cl, SpecialMethod => 'DgitImportDebianUpdate', $xmsg->("convert dgit import: debian changes") + }, { + %$cl, + SpecialMethod => 'DgitImportUpstreamUpdate', + $xmsg->("convert dgit import: upstream update", + " anchor") }; - my $differs = (get_differs $ovwr, $cl->{Tree}); - printf $report " Differs=%#x", $differs if $report; - if ($differs & D_UPS) { - printf $report " D_UPS" if $report; - # This will also trigger if a non-dgit git-based NMU - # deleted .gitignore (which is a thing that some of - # the existing git tools do if the user doesn't - # somehow tell them not to). Ah well. - push @brw_cl, { - %$cl, - SpecialMethod => 'DgitImportUpstreamUpdate', - $xmsg->("convert dgit import: upstream changes", - " breakwater") - }; - } $prline->(" Import"); - $rewrite_from_here->(); + $rewrite_from_here->(\@brw_cl); $upp_limit //= $#upp_cl; # further, deeper, patches discarded - die 'BUG $upp_limit is not used anywhere?'; $cur = $ovwr; next; } else { @@ -710,6 +818,8 @@ sub walk ($;$$) { runcmd @git, qw(read-tree), $treeish; $read_tree_debian->($build); }; + + $#upp_cl = $upp_limit if defined $upp_limit; my $committer_authline = calculate_committer_authline(); @@ -745,8 +855,10 @@ sub walk ($;$$) { next; } elsif ($method eq 'DgitImportDebianUpdate') { $read_tree_debian->($cltree); - rm_subdir_cached qw(debian/patches); } elsif ($method eq 'DgitImportUpstreamUpdate') { + confess unless $rewriting; + my $differs = (get_differs $build, $cltree); + next unless $differs & D_UPS; $read_tree_upstream->($cltree); push @parents, map { $_->{CommitId} } @{ $cl->{OrigParents} }; } else { @@ -762,7 +874,7 @@ sub walk ($;$$) { my $newtree = cmdoutput @git, qw(write-tree); my $ch = $cl->{Hdr}; $ch =~ s{^tree .*}{tree $newtree}m or confess "$ch ?"; - $ch =~ s{^parent .*\n}{}m; + $ch =~ s{^parent .*\n}{}mg; $ch =~ s{(?=^author)}{ join '', map { "parent $_\n" } @parents }me or confess "$ch ?"; @@ -781,7 +893,7 @@ sub walk ($;$$) { confess "$ch ?" unless $rewriting or $newcommit eq $cl->{CommitId}; $build = $newcommit; if (grep { $method eq $_ } qw(DgitImportUpstreamUpdate)) { - $last_upstream_update = $cur; + $last_anchor = $cur; } } }; @@ -790,7 +902,7 @@ sub walk ($;$$) { die sprintf "internal error %#x %s %s", $final_check, $build, $input if $final_check & ~D_PAT_ADD; - my @r = ($build, $breakwater, $last_upstream_update); + my @r = ($build, $breakwater, $last_anchor); printdebug "*** WALK RETURN @r\n"; return @r } @@ -802,7 +914,8 @@ sub get_head () { sub update_head ($$$) { my ($old, $new, $mrest) = @_; - runcmd @git, qw(update-ref -m), "debrebase: $mrest", 'HEAD', $new, $old; + push @deferred_updates, "update HEAD $new $old"; + run_deferred_updates $mrest; } sub update_head_checkout ($$$) { @@ -820,27 +933,30 @@ sub update_head_postlaunder ($$$) { runcmd @git, qw(rm --quiet --ignore-unmatch -rf debian/patches); } -sub cmd_launder () { - badusage "no arguments to launder allowed" if @ARGV; +sub do_launder_head ($) { + my ($reflogmsg) = @_; + my $old = get_head(); + record_ffq_auto(); + my ($tip,$breakwater) = walk $old; + snags_maybe_bail(); + update_head_postlaunder $old, $tip, $reflogmsg; + return ($tip,$breakwater); +} + +sub cmd_launder_v0 () { + badusage "no arguments to launder-v0 allowed" if @ARGV; my $old = get_head(); - my ($tip,$breakwater,$last_upstream_merge) = walk $old; + my ($tip,$breakwater,$last_anchor) = walk $old; update_head_postlaunder $old, $tip, 'launder'; printf "# breakwater tip\n%s\n", $breakwater; printf "# working tip\n%s\n", $tip; - printf "# last upstream merge\n%s\n", $last_upstream_merge; + printf "# last anchor\n%s\n", $last_anchor; } sub defaultcmd_rebase () { - my $old = get_head(); - my ($status, $message) = record_ffq_prev(); - if ($status eq 'written' || $status eq 'exists') { - } else { - fproblem $status, "could not record ffq-prev: $message"; - fproblems_maybe_bail(); - } - my ($tip,$breakwater) = walk $old; - update_head_postlaunder $old, $tip, 'launder for rebase'; - runcmd @git, qw(rebase), @ARGV, $breakwater; + push @ARGV, @{ $opt_defaultcmd_interactive // [] }; + my ($tip,$breakwater) = do_launder_head 'launder for rebase'; + runcmd @git, qw(rebase), @ARGV, $breakwater if @ARGV; } sub cmd_analyse () { @@ -857,7 +973,7 @@ sub cmd_analyse () { } sub ffq_prev_branchinfo () { - # => ('status', "message", [$current, $ffq_prev]) + # => ('status', "message", [$current, $ffq_prev, $gdrlast]) # 'status' may be # branch message is undef # weird-symref } no $current, @@ -867,21 +983,25 @@ sub ffq_prev_branchinfo () { return ('weird-symref', 'HEAD symref is not to refs/') unless $current =~ m{^refs/}; my $ffq_prev = "refs/$ffq_refprefix/$'"; - return ('branch', undef, $current, $ffq_prev); + my $gdrlast = "refs/$gdrlast_refprefix/$'"; + printdebug "ffq_prev_branchinfo branch current $current\n"; + return ('branch', undef, $current, $ffq_prev, $gdrlast); } -sub record_ffq_prev () { +sub record_ffq_prev_deferred () { # => ('status', "message") # 'status' may be - # written message is undef + # deferred message is undef # exists # detached # weird-symref # notbranch - # if not ff from some branch we should be ff from, is an fproblem - # if "written", will have printed something about that to stdout, - # and also some messages about ff checks - my ($status, $message, $current, $ffq_prev) = ffq_prev_branchinfo(); + # if not ff from some branch we should be ff from, is an snag + # if "deferred", will have added something about that to + # @deferred_update_messages, and also maybe printed (already) + # some messages about ff checks + my ($status, $message, $current, $ffq_prev, $gdrlast) + = ffq_prev_branchinfo(); return ($status, $message) unless $status eq 'branch'; my $currentval = get_head(); @@ -896,12 +1016,15 @@ sub record_ffq_prev () { my @check_specs = split /\;/, (cfg "branch.$branch.ffq-ffrefs",1) // '*'; my %checked; + printdebug "ffq check_specs @check_specs\n"; + my $check = sub { my ($lrref, $desc) = @_; + printdebug "ffq might check $lrref ($desc)\n"; my $invert; for my $chk (@check_specs) { my $glob = $chk; - $invert = $glob =~ s{^[^!]}{}; + $invert = $glob =~ s{^[!^]}{}; last if fnmatch $glob, $lrref; } return if $invert; @@ -911,40 +1034,109 @@ sub record_ffq_prev () { if (is_fast_fwd $lrval, $currentval) { print "OK, you are ahead of $lrref\n" or die $!; $checked{$lrref} = 1; - } if (is_fast_fwd $currentval, $lrval) { + } elsif (is_fast_fwd $currentval, $lrval) { $checked{$lrref} = -1; - fproblem 'behind', "you are behind $lrref, divergence risk"; + snag 'behind', "you are behind $lrref, divergence risk"; } else { $checked{$lrref} = -1; - fproblem 'diverged', "you have diverged from $lrref"; + snag 'diverged', "you have diverged from $lrref"; } }; my $merge = cfg "branch.$branch.merge",1; - if (defined $merge && $merge =~ m{^refs/heads/}) { + if (defined $merge and $merge =~ m{^refs/heads/}) { my $rhs = $'; + printdebug "ffq merge $rhs\n"; my $check_remote = sub { - my ($remote, $desc) = (@_); + my ($remote, $desc) = @_; + printdebug "ffq check_remote ".($remote//'undef')." $desc\n"; return unless defined $remote; $check->("refs/remotes/$remote/$rhs", $desc); }; - $check_remote->((cfg "branch.$branch.remote",1), + $check_remote->((scalar cfg "branch.$branch.remote",1), 'remote fetch/merge branch'); - $check_remote->((cfg "branch.$branch.pushRemote",1) // - (cfg "branch.$branch.pushDefault",1), + $check_remote->((scalar cfg "branch.$branch.pushRemote",1) // + (scalar cfg "branch.$branch.pushDefault",1), 'remote push branch'); } if ($branch =~ m{^dgit/}) { - $check->("remotes/dgit/$branch", 'remote dgit branch'); + $check->("refs/remotes/dgit/$branch", 'remote dgit branch'); } elsif ($branch =~ m{^master$}) { - $check->("remotes/dgit/dgit/sid", 'remote dgit branch for sid'); + $check->("refs/remotes/dgit/dgit/sid", 'remote dgit branch for sid'); + } + + snags_maybe_bail(); + + push @deferred_updates, "update $ffq_prev $currentval $git_null_obj"; + push @deferred_updates, "delete $gdrlast"; + push @deferred_update_messages, "Recorded current head for preservation"; + return ('deferred', undef); +} + +sub record_ffq_auto () { + my ($status, $message) = record_ffq_prev_deferred(); + if ($status eq 'deferred' || $status eq 'exists') { + } else { + snag $status, "could not record ffq-prev: $message"; + snags_maybe_bail(); + } +} + +sub ffq_prev_info () { + # => ($ffq_prev, $gdrlast, $ffq_prev_commitish) + my ($status, $message, $current, $ffq_prev, $gdrlast) + = ffq_prev_branchinfo(); + if ($status ne 'branch') { + snag $status, "could not check ffq-prev: $message"; + snags_maybe_bail(); + } + my $ffq_prev_commitish = $ffq_prev && git_get_ref $ffq_prev; + return ($ffq_prev, $gdrlast, $ffq_prev_commitish); +} + +sub stitch ($$$$$) { + my ($old_head, $ffq_prev, $gdrlast, $ffq_prev_commitish, $prose) = @_; + + push @deferred_updates, "delete $ffq_prev $ffq_prev_commitish"; + + if (is_fast_fwd $old_head, $ffq_prev_commitish) { + my $differs = get_differs $old_head, $ffq_prev_commitish; + unless ($differs & ~D_PAT_ADD) { + # ffq-prev is ahead of us, and the only tree changes it has + # are possibly addition of things in debian/patches/. + # Just wind forwards rather than making a pointless pseudomerge. + push @deferred_updates, + "update $gdrlast $ffq_prev_commitish $git_null_obj"; + update_head_checkout $old_head, $ffq_prev_commitish, + "stitch (fast forward)"; + return; + } + } + fresh_workarea(); + # We make pseudomerges with L as the contributing parent. + # This makes git rev-list --first-parent work properly. + my $new_head = make_commit [ $old_head, $ffq_prev ], [ + 'Declare fast forward / record previous work', + "[git-debrebase pseudomerge: $prose]", + ]; + push @deferred_updates, "update $gdrlast $new_head $git_null_obj"; + update_head $old_head, $new_head, "stitch: $prose"; +} + +sub do_stitch ($;$) { + my ($prose, $unclean) = @_; + + my ($ffq_prev, $gdrlast, $ffq_prev_commitish) = ffq_prev_info(); + if (!$ffq_prev_commitish) { + fail "No ffq-prev to stitch." unless $opt_noop_ok; + return; } + my $dangling_head = get_head(); + + keycommits $dangling_head, $unclean,$unclean,$unclean; + snags_maybe_bail(); - fproblems_maybe_bail(); - runcmd @git, qw(update-ref -m), "record current head for preservation", - $ffq_prev, $currentval, $git_null_obj; - print "Recorded current head for preservation\n" or die $!; - return ('written', undef); + stitch($dangling_head, $ffq_prev, $gdrlast, $ffq_prev_commitish, $prose); } sub cmd_new_upstream_v0 () { @@ -953,13 +1145,15 @@ sub cmd_new_upstream_v0 () { my %pieces; - badusage "need NEW-VERSION UPS-COMMITTISH" unless @ARGV >= 2; + badusage "need NEW-VERSION [UPS-COMMITTISH]" unless @ARGV >= 1; # parse args - low commitment my $new_version = (new Dpkg::Version scalar(shift @ARGV), check => 1); my $new_upstream_version = $new_version->version(); - my $new_upstream = git_rev_parse shift @ARGV; + my $new_upstream = git_rev_parse (shift @ARGV // 'upstream'); + + record_ffq_auto(); my $piece = sub { my ($n, @x) = @_; # may be '' @@ -996,42 +1190,64 @@ sub cmd_new_upstream_v0 () { # now we need to investigate the branch this generates the # laundered version but we don't switch to it yet my $old_head = get_head(); - my ($old_laundered_tip,$old_bw,$old_upstream_update) = walk $old_head; + my ($old_laundered_tip,$old_bw,$old_anchor) = walk $old_head; my $old_bw_cl = classify $old_bw; - my $old_upstream_update_cl = classify $old_upstream_update; - confess unless $old_upstream_update_cl->{OrigParents}; - my $old_upstream = parsecommit - $old_upstream_update_cl->{OrigParents}[0]{CommitId}; - - $piece->('', Old => $old_upstream->{CommitId}); + my $old_anchor_cl = classify $old_anchor; + my $old_upstream; + if (!$old_anchor_cl->{OrigParents}) { + snag 'anchor-treated', + 'old anchor is recognised due to --anchor, cannot check upstream'; + } else { + $old_upstream = parsecommit + $old_anchor_cl->{OrigParents}[0]{CommitId}; + $piece->('', Old => $old_upstream->{CommitId}); + } - if ($old_upstream->{Msg} =~ m{^\[git-debrebase }m) { + if ($old_upstream && $old_upstream->{Msg} =~ m{^\[git-debrebase }m) { if ($old_upstream->{Msg} =~ - m{^\[git-debrebase upstream-combine \.((?: $extra_orig_namepart_re)+)\:.*\]$}m + m{^\[git-debrebase upstream-combine (\.(?: $extra_orig_namepart_re)+)\:.*\]$}m ) { - my @oldpieces = ('', split / /, $1); - my $parentix = -1 + scalar @{ $old_upstream->{Parents} }; - foreach my $i (0..$#oldpieces) { - my $n = $oldpieces[$i]; - $piece->($n, Old => $old_upstream->{CommitId}.'^'.$parentix); + my @oldpieces = (split / /, $1); + my $old_n_parents = scalar @{ $old_upstream->{Parents} }; + if (@oldpieces != $old_n_parents) { + snag 'upstream-confusing', sprintf + "previous upstream combine %s". + " mentions %d pieces (each implying one orig commit)". + " but has %d parents", + $old_upstream->{CommitId}, + (scalar @oldpieces), + $old_n_parents; + } elsif ($oldpieces[0] ne '.') { + snag 'upstream-confusing', sprintf + "previous upstream combine %s". + " first piece is not \`.'", + $oldpieces[0]; + } else { + $oldpieces[0] = ''; + foreach my $i (0..$#oldpieces) { + my $n = $oldpieces[$i]; + $piece->($n, Old => $old_upstream->{CommitId}.'^'.($i+1)); + } } } else { - fproblem 'upstream-confusing', + snag 'upstream-confusing', "previous upstream $old_upstream->{CommitId} is from". " git-debrebase but not an \`upstream-combine' commit"; } } foreach my $pc (values %pieces) { - if (!$pc->{Old}) { - fproblem 'upstream-new-piece', + if (!$old_upstream) { + # we have complained already + } elsif (!$pc->{Old}) { + snag 'upstream-new-piece', "introducing upstream piece \`$pc->{Name}'"; } elsif (!$pc->{New}) { - fproblem 'upstream-rm-piece', + snag 'upstream-rm-piece', "dropping upstream piece \`$pc->{Name}'"; } elsif (!is_fast_fwd $pc->{Old}, $pc->{New}) { - fproblem 'upstream-not-ff', + snag 'upstream-not-ff', "not fast forward: $pc->{Name} $pc->{Old}..$pc->{New}"; } } @@ -1039,7 +1255,7 @@ sub cmd_new_upstream_v0 () { printdebug "%pieces = ", (dd \%pieces), "\n"; printdebug "\@newpieces = ", (dd \@newpieces), "\n"; - fproblems_maybe_bail(); + snags_maybe_bail(); my $new_bw; @@ -1047,7 +1263,7 @@ sub cmd_new_upstream_v0 () { in_workarea sub { my @upstream_merge_parents; - if (!any_fproblems()) { + if (!any_snags()) { push @upstream_merge_parents, $old_upstream->{CommitId}; } @@ -1074,16 +1290,20 @@ sub cmd_new_upstream_v0 () { # $new_upstream is either the single upstream commit, or the # combined commit we just made. Either way it will be the - # "upstream" parent of the breakwater special merge. + # "upstream" parent of the anchor merge. read_tree_subdir 'debian', "$old_bw:debian"; - # index now contains the breakwater merge contents + # index now contains the anchor merge contents $new_bw = make_commit [ $old_bw, $new_upstream ], [ "Update to upstream $new_upstream_version", - "[git-debrebase breakwater: new upstream $new_upstream_version, merge]", + "[git-debrebase anchor: new upstream $new_upstream_version, merge]", ]; + my $clogsignoff = cmdoutput qw(git show), + '--pretty=format:%an <%ae> %aD', + $new_bw; + # Now we have to add a changelog stanza so the Debian version # is right. die if unlink "debian"; @@ -1100,7 +1320,7 @@ $p ($new_version) UNRELEASED; urgency=medium * Update to new upstream version $new_upstream_version. - -- + -- $clogsignoff END close CN or die $!; @@ -1127,17 +1347,190 @@ END sub cmd_record_ffq_prev () { badusage "no arguments allowed" if @ARGV; - my ($status, $msg) = record_ffq_prev(); + my ($status, $msg) = record_ffq_prev_deferred(); if ($status eq 'exists' && $opt_noop_ok) { print "Previous head already recorded\n" or die $!; - } elsif ($status eq 'written') { + } elsif ($status eq 'deferred') { + run_deferred_updates 'record-ffq-prev'; } else { fail "Could not preserve: $msg"; } } -sub cmd_gbp2debrebase () { - badusage "needs 1 optional argument, the upstream" unless @ARGV<=1; +sub cmd_anchor () { + badusage "no arguments allowed" if @ARGV; + my ($anchor, $bw) = keycommits +(git_rev_parse 'HEAD'), 0,0; + print "$bw\n" or die $!; +} + +sub cmd_breakwater () { + badusage "no arguments allowed" if @ARGV; + my ($anchor, $bw) = keycommits +(git_rev_parse 'HEAD'), 0,0; + print "$bw\n" or die $!; +} + +sub cmd_status () { + badusage "no arguments allowed" if @ARGV; + + my $oldest = [ 0 ]; + my $newest; + my $note = sub { + my ($badness, $ourmsg, $snagname, $kcmsg, $cl) = @_; + if ($oldest->[0] < $badness) { + $oldest = $newest = undef; + } + $oldest = \@_; # we're walking backwards + $newest //= \@_; + }; + my ($anchor, $bw) = keycommits +(git_rev_parse 'HEAD'), + sub { $note->(1, 'branch contains furniture (not laundered)', @_); }, + sub { $note->(2, 'branch is unlaundered', @_); }, + sub { $note->(3, 'branch needs laundering', @_); }, + sub { $note->(4, 'branch not in git-debrebase form', @_); }; + + my $prcommitinfo = sub { + my ($cid) = @_; + flush STDOUT or die $!; + runcmd @git, qw(--no-pager log -n1), + '--pretty=format: %h %s%n', + $cid; + }; + + print "current branch contents, in git-debrebase terms:\n"; + if (!$oldest->[0]) { + print " branch is laundered\n"; + } else { + print " $oldest->[1]\n"; + my $printed = ''; + foreach my $info ($oldest, $newest) { + my $cid = $info->[4]{CommitId}; + next if $cid eq $printed; + $printed = $cid; + print " $info->[3]\n"; + $prcommitinfo->($cid); + } + } + + my $prab = sub { + my ($cid, $what) = @_; + if (!defined $cid) { + print " $what is not well-defined\n"; + } else { + print " $what\n"; + $prcommitinfo->($cid); + } + }; + print "key git-debrebase commits:\n"; + $prab->($anchor, 'anchor'); + $prab->($bw, 'breakwater'); + + my ($ffqstatus, $ffq_msg, $current, $ffq_prev, $gdrlast) = + ffq_prev_branchinfo(); + + print "branch and ref status, in git-debrebase terms:\n"; + if ($ffq_msg) { + print " $ffq_msg\n"; + } else { + $ffq_prev = git_get_ref $ffq_prev; + $gdrlast = git_get_ref $gdrlast; + if ($ffq_prev) { + print " unstitched; previous tip was:\n"; + $prcommitinfo->($ffq_prev); + } elsif (!$gdrlast) { + print " stitched? (no record of git-debrebase work)\n"; + } elsif (is_fast_fwd $gdrlast, 'HEAD') { + print " stitched\n"; + } else { + print " not git-debrebase (diverged since last stitch)\n" + } + } +} + +sub cmd_stitch () { + my $prose = 'stitch'; + GetOptions('prose=s', \$prose) or die badusage("bad options to stitch"); + badusage "no arguments allowed" if @ARGV; + do_stitch $prose, 0; +} +sub cmd_prepush () { cmd_stitch(); } + +sub cmd_quick () { + badusage "no arguments allowed" if @ARGV; + do_launder_head 'launder for git-debrebase quick'; + do_stitch 'quick'; +} + +sub cmd_conclude () { + my ($ffq_prev, $gdrlast, $ffq_prev_commitish) = ffq_prev_info(); + if (!$ffq_prev_commitish) { + fail "No ongoing git-debrebase session." unless $opt_noop_ok; + return; + } + my $dangling_head = get_head(); + + badusage "no arguments allowed" if @ARGV; + do_launder_head 'launder for git-debrebase quick'; + do_stitch 'quick'; +} + +sub make_patches_staged ($) { + my ($head) = @_; + # Produces the patches that would result from $head if it were + # laundered. + my ($secret_head, $secret_bw, $last_anchor) = walk $head; + fresh_workarea(); + in_workarea sub { + runcmd @git, qw(checkout -q -b bw), $secret_bw; + runcmd @git, qw(checkout -q -b patch-queue/bw), $secret_head; + runcmd qw(gbp pq export); + runcmd @git, qw(add debian/patches); + }; +} + +sub make_patches ($) { + my ($head) = @_; + keycommits $head, 0, \&snag; + make_patches_staged $head; + my $out; + in_workarea sub { + my $ptree = cmdoutput @git, qw(write-tree --prefix=debian/patches/); + runcmd @git, qw(read-tree), $head; + read_tree_subdir 'debian/patches', $ptree; + $out = make_commit [$head], [ + 'Commit patch queue (exported by git-debrebase)', + '[git-debrebase: export and commit patches]', + ]; + }; + return $out; +} + +sub cmd_make_patches () { + my $opt_quiet_would_amend; + GetOptions('quiet-would-amend!', \$opt_quiet_would_amend) + or die badusage("bad options to make-patches"); + badusage "no arguments allowed" if @ARGV; + my $old_head = get_head(); + my $new = make_patches $old_head; + my $d = get_differs $old_head, $new; + if ($d == 0) { + fail "No (more) patches to export." unless $opt_noop_ok; + return; + } elsif ($d == D_PAT_ADD) { + snags_maybe_bail(); + update_head_checkout $old_head, $new, 'make-patches'; + } else { + print STDERR failmsg + "Patch export produced patch amendments". + " (abandoned output commit $new).". + " Try laundering first." + unless $opt_quiet_would_amend; + finish 7; + } +} + +sub cmd_convert_from_gbp () { + badusage "needs 1 optional argument, the upstream git rev" + unless @ARGV<=1; my ($upstream_spec) = @ARGV; $upstream_spec //= 'refs/heads/upstream'; my $upstream = git_rev_parse $upstream_spec; @@ -1152,25 +1545,25 @@ sub cmd_gbp2debrebase () { } if (!is_fast_fwd $upstream, $old_head) { - fproblem 'upstream-not-ancestor', + snag 'upstream-not-ancestor', "upstream ($upstream) is not an ancestor of HEAD"; } else { my $wrong = cmdoutput (@git, qw(rev-list --ancestry-path), "$upstream..HEAD", qw(-- :/ :!/debian)); if (length $wrong) { - fproblem 'unexpected-upstream-changes', + snag 'unexpected-upstream-changes', "history between upstream ($upstream) and HEAD contains direct changes to upstream files - are you sure this is a gbp (patches-unapplied) branch?"; print STDERR "list expected changes with: git log --stat --ancestry-path $upstream_spec..HEAD -- :/ ':!/debian'\n"; } } if ((git_cat_file "$upstream:debian")[0] ne 'missing') { - fproblem 'upstream-has-debian', + snag 'upstream-has-debian', "upstream ($upstream) contains debian/ directory"; } - fproblems_maybe_bail(); + snags_maybe_bail(); my $work; @@ -1183,16 +1576,16 @@ sub cmd_gbp2debrebase () { runcmd @git, qw(checkout -q gdr-internal~0); rm_subdir_cached 'debian/patches'; $work = make_commit ['HEAD'], [ - 'git-debrebase import: drop patch queue', + 'git-debrebase convert-from-gbp: drop patches from tree', 'Delete debian/patches, as part of converting to git-debrebase format.', - '[git-debrebase: gbp2debrebase, drop patches]' + '[git-debrebase convert-from-gbp: drop patches from tree]' ]; - # make the breakwater pseudomerge + # make the anchor merge # the tree is already exactly right $work = make_commit [$work, $upstream], [ 'git-debrebase import: declare upstream', 'First breakwater merge.', - '[git-debrebase breakwater: declare upstream]' + '[git-debrebase anchor: declare upstream]' ]; # rebase the patch queue onto the new breakwater @@ -1201,7 +1594,33 @@ sub cmd_gbp2debrebase () { $work = git_rev_parse 'HEAD'; }; - update_head_checkout $old_head, $work, 'gbp2debrebase'; + update_head_checkout $old_head, $work, 'convert-from-gbp'; +} + +sub cmd_convert_to_gbp () { + badusage "no arguments allowed" if @ARGV; + my $head = get_head(); + my (undef, undef, undef, $ffq, $gdrlast) = ffq_prev_branchinfo(); + keycommits $head, 0; + my $out; + make_patches_staged $head; + in_workarea sub { + $out = make_commit ['HEAD'], [ + 'Commit patch queue (converted from git-debrebase format)', + '[git-debrebase convert-to-gbp: commit patches]', + ]; + }; + if (defined $ffq) { + push @deferred_updates, "delete $ffq"; + push @deferred_updates, "delete $gdrlast"; + } + snags_maybe_bail(); + update_head_checkout $head, $out, "convert to gbp (v0)"; + print < \$debuglevel, 'noop-ok', => \$opt_noop_ok, - 'f=s' => \@fproblem_force_opts, - 'force!') or die badusage "bad options\n"; + 'f=s' => \@snag_force_opts, + 'anchor=s' => \@opt_anchors, + 'force!', + '-i:s' => sub { + my ($opt,$val) = @_; + badusage "git-debrebase: no cuddling to -i for git-rebase" + if length $val; + die if $opt_defaultcmd_interactive; # should not happen + $opt_defaultcmd_interactive = [ qw(-i) ]; + # This access to @ARGV is excessive familiarity with + # Getopt::Long, but there isn't another sensible + # approach. '-i=s{0,}' does not work with bundling. + push @$opt_defaultcmd_interactive, @ARGV; + @ARGV=(); + }) or die badusage "bad options\n"; initdebug('git-debrebase '); enabledebug if $debuglevel; @@ -1265,7 +1697,9 @@ chdir $toplevel or die "chdir $toplevel: $!"; $rd = fresh_playground "$playprefix/misc"; -if (!@ARGV || $ARGV[0] =~ m{^-}) { +@opt_anchors = map { git_rev_parse $_ } @opt_anchors; + +if (!@ARGV || $opt_defaultcmd_interactive || $ARGV[0] =~ m{^-}) { defaultcmd_rebase(); } else { my $cmd = shift @ARGV; @@ -1276,3 +1710,5 @@ if (!@ARGV || $ARGV[0] =~ m{^-}) { $cmdfn or badusage "unknown git-debrebase sub-operation $cmd"; $cmdfn->(); } + +finish 0;