X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=dgit.git;a=blobdiff_plain;f=git-debrebase;h=98e645a43a9255b81a7821a671b406239c922f90;hp=2520d52c5555f501eabd241b73393874c7d68294;hb=485a61ef66da7ad675e0495355b1f9f1df952bf5;hpb=75d0b8d7275c035f76db79e7cf7e802e061a9bee diff --git a/git-debrebase b/git-debrebase index 2520d52c..98e645a4 100755 --- a/git-debrebase +++ b/git-debrebase @@ -18,57 +18,9 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . - -# usages: -# -# git-debrebase [] analyse -# git-debrebase [] launder-v0 # prints breakwater tip etc. -# git-debrebase [] downstream-rebase-launder-v0 # experimental -# -# git-debrebase [] convert-from-gbp [] -# git-debrebase [] convert-to-gbp - -# 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::GDR; +use Debian::Dgit::ExitStatus; use strict; @@ -82,14 +34,41 @@ use Data::Dumper; use Getopt::Long qw(:config posix_default gnu_compat bundling); use Dpkg::Version; use File::FnMatch qw(:fnmatch); +use File::Copy; + +our ($usage_message) = <<'END'; +usages: + git-debrebase [] [--|-i ] + git-debrebase [] status + git-debrebase [] prepush [--prose=...] + git-debrebase [] quick|conclude + git-debrebase [] new-upstream [
] + git-debrebase [] convert-from-gbp [] + ... +See git-debrebase(1), git-debrebase(5), dgit-maint-debrebase(7) (in dgit). +END our ($opt_force, $opt_noop_ok, @opt_anchors); +our ($opt_defaultcmd_interactive); our $us = qw(git-debrebase); +$|=1; + sub badusage ($) { my ($m) = @_; - die "bad usage: $m\n"; + print STDERR "$us: bad usage: $m\n"; + finish 8; +} + +sub getoptions_main { + my $m = shift; + local $SIG{__WARN__}; # GetOptions calls `warn' to print messages + GetOptions @_ or badusage $m; +} +sub getoptions { + my $sc = shift; + getoptions_main "bad options follow \`git-debrebase $sc'", @_; } sub cfg ($;$) { @@ -135,6 +114,7 @@ our $rd; our $workarea; our @git = qw(git); +our @dgit = qw(dgit); sub in_workarea ($) { my ($sub) = @_; @@ -149,13 +129,21 @@ 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) = @_; - my @upd_cmd = (@git, qw(update-ref --stdin -m), "debrebase: $mrest"); + confess 'dangerous internal error' unless all_snags_summarised(); + + my @upd_cmd = (git_update_ref_cmd "debrebase: $mrest", qw(--stdin)); debugcmd '>|', @upd_cmd; open U, "|-", @upd_cmd or die $!; foreach (@deferred_updates) { @@ -276,40 +264,50 @@ 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 blocker(s) (you could -f, or --force)", + $us, $snags_tripped; } } + $snags_summarised = $snags_forced + $snags_tripped; +} +sub snags_maybe_bail_early () { + # useful to bail out early without doing a lot of work; + # not a substitute for snags_maybe_bail. + snags_maybe_bail() if $snags_tripped && !$opt_force; } -sub any_fproblems () { - return $fproblems_forced || $fproblems_tripped; +sub any_snags () { + return $snags_forced || $snags_tripped; } # classify returns an info hash like this @@ -446,6 +444,15 @@ sub classify ($) { # 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"); @@ -458,6 +465,23 @@ sub classify ($) { # 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"); @@ -546,41 +570,95 @@ sub classify ($) { return $unknown->("complex merge"); } -sub breakwater_of ($) { - my ($head) = @_; # must be laundered - my $breakwater; - my $unclean = sub { - my ($why) = @_; - fail "branch needs laundering (run git-debrebase): $why"; +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; + my $found_pm; + $fatal //= sub { fail $_[1]; }; + my $x = sub { + my ($cb, $tagsfx, $mainwhy, $xwhy) = @_; + my $why = $mainwhy.$xwhy; + my $m = "branch needs laundering (run git-debrebase): $why"; + fail $m unless defined $cb; + return unless $cb; + $cb->("unclean-$tagsfx", $why, $cl, $mainwhy); }; for (;;) { - my $cl = classify $head; + $cl = classify $head; my $ty = $cl->{Type}; - if ($ty eq 'Packaging' or - $ty eq 'Changelog') { + 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') { - $unclean->("packaging change ($breakwater)". - " follows upstream change (eg $head)") + $x->($unclean, 'ordering', + "packaging change ($breakwater) follows upstream change"," (eg $head)") if defined $breakwater; + $clogonly = undef; + $breakwater = undef; } elsif ($ty eq 'Mixed') { - $unclean->('found mixed upstream/packaging commit ($head)'); + $x->($unclean, 'mixed', + "found mixed upstream/packaging commit"," ($head)"); + $clogonly = undef; + $breakwater = undef; } elsif ($ty eq 'Pseudomerge' or $ty eq 'AddPatches') { - $unclean->("found interchange conversion commit ($ty, $head)"); + my $found_pm = 1; + $x->($furniture, (lc $ty), + "found interchange bureaucracy commit ($ty)"," ($head)"); } elsif ($ty eq 'DgitImportUnpatched') { - $unclean->("found dgit dsc import ($head)"); + if ($found_pm) { + $x->($trouble, 'dgitimport', + "found dgit dsc import"," ($head)"); + return (undef,undef); + } else { + $x->($fatal, 'unprocessable', + "found bare dgit dsc import with no prior history", + " ($head)"); + return (undef,undef); + } } else { - fail "found unprocessable commit, cannot cope: $head; $cl->{Why}"; + $x->($fatal, 'unprocessable', + "found unprocessable commit, cannot cope: $cl->{Why}", + " ($head)"); + return (undef,undef); } $head = $cl->{Parents}[0]{CommitId}; } - return $breakwater; + return ($anchor, $breakwater); } sub walk ($;$$); @@ -633,10 +711,11 @@ sub walk ($;$$) { if ($nogenerate) { return (undef,undef); } - die "commit $cur: Cannot cope with this commit (d.". + fail "found unprocessable commit, cannot cope". + (defined $cl->{Why} ? "; $cl->{Why}:": ':'). + " (commit $cur) (d.". (join ' ', map { sprintf "%#x", $_->{Differs} } @{ $cl->{Parents} }). - (defined $cl->{Why} ? "; $cl->{Why}": ''). ")"; }; @@ -745,13 +824,12 @@ sub walk ($;$$) { next; } else { # Everything is from this import. This kind of import - # is already in valid breakwater format, with the - # patches as commits. - printf $report " NoPM" if $report; - # last thing we processed will have been the first patch, - # if there is one; which is fine, so no need to rewrite - # on account of this import - $build_start->("ImportOrigin", $cur); + # is already nearly in valid breakwater format, with the + # patches as commits. Unfortunately it contains + # debian/patches/. + printdebug "*** WALK BOMB bare dgit import\n"; + $cl->{Why} = "bare dgit dsc import"; + return $bomb->(); } die "$ty ?"; } else { @@ -897,6 +975,16 @@ sub update_head_postlaunder ($$$) { runcmd @git, qw(rm --quiet --ignore-unmatch -rf debian/patches); } +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(); @@ -908,15 +996,14 @@ sub cmd_launder_v0 () { } sub defaultcmd_rebase () { - my $old = get_head(); - record_ffq_auto(); - 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 () { - die if ($ARGV[0]//'') =~ m/^-/; + badusage "analyse does not support any options" + if @ARGV and $ARGV[0] =~ m/^-/; badusage "too many arguments to analyse" if @ARGV>1; my ($old) = @ARGV; if (defined $old) { @@ -929,37 +1016,31 @@ sub cmd_analyse () { } sub ffq_prev_branchinfo () { - # => ('status', "message", [$current, $ffq_prev]) - # 'status' may be - # branch message is undef - # weird-symref } no $current, - # notbranch } no $ffq_prev my $current = git_get_symref(); - return ('detached', 'detached HEAD') unless defined $current; - return ('weird-symref', 'HEAD symref is not to refs/') - unless $current =~ m{^refs/}; - my $ffq_prev = "refs/$ffq_refprefix/$'"; - printdebug "ffq_prev_branchinfo branch current $current\n"; - return ('branch', undef, $current, $ffq_prev); + return gdr_ffq_prev_branchinfo($current); } -sub record_ffq_prev_deferred () { - # => ('status', "message") - # 'status' may be - # deferred message is undef +sub ffq_check ($;$$) { + # calls $ff and/or $notff zero or more times + # then returns either (status,message) where status is # exists # detached # weird-symref # notbranch - # if not ff from some branch we should be ff from, is an fproblem - # 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) = ffq_prev_branchinfo(); + # or (undef,undef, $ffq_prev,$gdrlast) + # $ff and $notff are called like this: + # $ff->("message for stdout\n"); + # $notff->('snag-name', $message); + # normally $currentval should be HEAD + my ($currentval, $ff, $notff) =@_; + + $ff //= sub { print $_[0] or die $!; }; + $notff //= \&snag; + + my ($status, $message, $current, $ffq_prev, $gdrlast) + = ffq_prev_branchinfo(); return ($status, $message) unless $status eq 'branch'; - my $currentval = get_head(); - my $exists = git_get_ref $ffq_prev; return ('exists',"$ffq_prev already exists") if $exists; @@ -983,17 +1064,17 @@ sub record_ffq_prev_deferred () { } return if $invert; my $lrval = git_get_ref $lrref; - return unless defined $lrval; + return unless length $lrval; if (is_fast_fwd $lrval, $currentval) { - print "OK, you are ahead of $lrref\n" or die $!; + $ff->("OK, you are ahead of $lrref\n"); $checked{$lrref} = 1; } elsif (is_fast_fwd $currentval, $lrval) { $checked{$lrref} = -1; - fproblem 'behind', "you are behind $lrref, divergence risk"; + $notff->('behind', "you are behind $lrref, divergence risk"); } else { $checked{$lrref} = -1; - fproblem 'diverged', "you have diverged from $lrref"; + $notff->('diverged', "you have diverged from $lrref"); } }; @@ -1018,10 +1099,30 @@ sub record_ffq_prev_deferred () { } elsif ($branch =~ m{^master$}) { $check->("refs/remotes/dgit/dgit/sid", 'remote dgit branch for sid'); } + return (undef, undef, $ffq_prev, $gdrlast); +} - fproblems_maybe_bail(); +sub record_ffq_prev_deferred () { + # => ('status', "message") + # 'status' may be + # deferred message is undef + # exists + # detached + # weird-symref + # notbranch + # 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 $currentval = get_head(); + + my ($status,$message, $ffq_prev,$gdrlast) = ffq_check $currentval; + return ($status,$message) if defined $status; + + 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); } @@ -1030,12 +1131,97 @@ sub record_ffq_auto () { my ($status, $message) = record_ffq_prev_deferred(); if ($status eq 'deferred' || $status eq 'exists') { } else { - fproblem $status, "could not record ffq-prev: $message"; - fproblems_maybe_bail(); + 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 cmd_new_upstream_v0 () { +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(); + + stitch($dangling_head, $ffq_prev, $gdrlast, $ffq_prev_commitish, $prose); +} + +sub upstream_commitish_search ($$) { + my ($upstream_version, $tried) = @_; + # todo: at some point maybe use git-deborig to do this + foreach my $tagpfx ('', 'v', 'upstream/') { + my $tag = $tagpfx.(dep14_version_mangle $upstream_version); + my $new_upstream = git_get_ref "refs/tags/$tag"; + push @$tried, $tag; + return $new_upstream if length $new_upstream; + } +} + +sub resolve_upstream_version ($$) { + my ($new_upstream, $upstream_version) = @_; + + if (!defined $new_upstream) { + my @tried; + $new_upstream = upstream_commitish_search $upstream_version, \@tried; + if (!length $new_upstream) { + fail "Could not determine appropriate upstream commitish.\n". + " (Tried these tags: @tried)\n". + " Check version, and specify upstream commitish explicitly."; + } + } + $new_upstream = git_rev_parse $new_upstream; + + return $new_upstream; +} + +sub cmd_new_upstream () { # automatically and unconditionally launders before rebasing # if rebase --abort is used, laundering has still been done @@ -1044,10 +1230,17 @@ sub cmd_new_upstream_v0 () { 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 $spec_version = shift @ARGV; + my $new_version = (new Dpkg::Version $spec_version, check => 1); + fail "bad version number \`$spec_version'" unless defined $new_version; + if ($new_version->is_native()) { + $new_version = (new Dpkg::Version "$spec_version-1", check => 1); + } - my $new_upstream = git_rev_parse (shift @ARGV // 'upstream'); + my $new_upstream = shift @ARGV; + my $new_upstream_version = upstreamversion $new_version; + $new_upstream = + resolve_upstream_version $new_upstream, $new_upstream_version; record_ffq_auto(); @@ -1092,7 +1285,7 @@ sub cmd_new_upstream_v0 () { my $old_anchor_cl = classify $old_anchor; my $old_upstream; if (!$old_anchor_cl->{OrigParents}) { - fproblem 'anchor-treated', + snag 'anchor-treated', 'old anchor is recognised due to --anchor, cannot check upstream'; } else { $old_upstream = parsecommit @@ -1102,16 +1295,35 @@ sub cmd_new_upstream_v0 () { 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 ($old_n_parents != @oldpieces && + $old_n_parents != @oldpieces + 1) { + snag 'upstream-confusing', sprintf + "previous upstream combine %s". + " mentions %d pieces (each implying one parent)". + " but has %d parents". + " (one per piece plus maybe a previous combine)", + $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]; + my $hat = 1 + $i + ($old_n_parents - @oldpieces); + $piece->($n, Old => $old_upstream->{CommitId}.'^'.$hat); + } } } else { - fproblem 'upstream-confusing', + snag 'upstream-confusing', "previous upstream $old_upstream->{CommitId} is from". " git-debrebase but not an \`upstream-combine' commit"; } @@ -1121,13 +1333,13 @@ sub cmd_new_upstream_v0 () { if (!$old_upstream) { # we have complained already } elsif (!$pc->{Old}) { - fproblem 'upstream-new-piece', + 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}"; } } @@ -1135,7 +1347,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; @@ -1143,7 +1355,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}; } @@ -1180,6 +1392,10 @@ sub cmd_new_upstream_v0 () { "[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"; @@ -1196,7 +1412,7 @@ $p ($new_version) UNRELEASED; urgency=medium * Update to new upstream version $new_upstream_version. - -- + -- $clogsignoff END close CN or die $!; @@ -1217,6 +1433,8 @@ END 'launder for new upstream'; my @cmd = (@git, qw(rebase --onto), $new_bw, $old_bw, @ARGV); + local $ENV{GIT_REFLOG_ACTION} = git_reflog_action_msg + "debrebase new-upstream $new_version: rebase"; runcmd @cmd; # now it's for the user to sort out } @@ -1233,82 +1451,275 @@ sub cmd_record_ffq_prev () { } } +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 $bw = breakwater_of git_rev_parse 'HEAD'; + my ($anchor, $bw) = keycommits +(git_rev_parse 'HEAD'), 0,0; print "$bw\n" or die $!; } -sub cmd_stitch () { - my $prose = ''; - GetOptions('prose=s', \$prose) or die badusage("bad options to stitch"); +sub cmd_status () { badusage "no arguments allowed" if @ARGV; - my ($status, $message, $current, $ffq_prev) = ffq_prev_branchinfo(); - if ($status ne 'branch') { - fproblem $status, "could not check ffq-prev: $message"; - fproblems_maybe_bail(); - } - my $prev = $ffq_prev && git_get_ref $ffq_prev; - if (!$prev) { - fail "No ffq-prev to stitch." unless $opt_noop_ok; + + # todo: gdr status should print divergence info + # todo: gdr status should print upstream component(s) info + # todo: gdr should leave/maintain some refs with this kind of info ? + + my $oldest = { Badness => 0 }; + my $newest; + my $note = sub { + my ($badness, $ourmsg, $snagname, $dummy, $cl, $kcmsg) = @_; + if ($oldest->{Badness} < $badness) { + $oldest = $newest = undef; + } + $oldest = { + Badness => $badness, + CommitId => $cl->{CommitId}, + OurMsg => $ourmsg, + KcMsg => $kcmsg, + }; + $newest //= $oldest; + }; + 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->{Badness}) { + print " branch is laundered\n"; + } else { + print " $oldest->{OurMsg}\n"; + my $printed = ''; + foreach my $info ($oldest, $newest) { + my $cid = $info->{CommitId}; + next if $cid eq $printed; + $printed = $cid; + print " $info->{KcMsg}\n"; + $prcommitinfo->($cid); + } } - push @deferred_updates, "delete $ffq_prev $prev"; - my $old_head = get_head(); - if (is_fast_fwd $old_head, $prev) { - my $differs = get_differs $old_head, $prev; - 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. - update_head_checkout $old_head, $prev, "stitch (fast forward)"; - return; + 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("stitch", + 'prose=s', \$prose); + 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(); - my $new_head = make_commit [ $old_head, $ffq_prev ], [ - 'Declare fast forward / record previous work', - "[git-debrebase pseudomerge: stitch$prose]", - ]; - update_head $old_head, $new_head, "stitch"; + in_workarea sub { + runcmd @git, qw(checkout -q -b bw), $secret_bw; + runcmd @git, qw(checkout -q -b patch-queue/bw), $secret_head; + my @gbp_cmd = (qw(gbp pq export)); + my $r = system shell_cmd 'exec >../gbp-pq-err 2>&1', @gbp_cmd; + if ($r) { + { local ($!,$?); copy('../gbp-pq-err', \*STDERR); } + failedcmd @gbp_cmd; + } + runcmd @git, qw(add -f 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("make-patches", + 'quiet-would-amend!', \$opt_quiet_would_amend); + 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" + badusage "want only 1 optional argument, the upstream git commitish" unless @ARGV<=1; + + my $clogp = parsechangelog(); + my $version = $clogp->{'Version'} + // die "missing Version from changelog"; + my ($upstream_spec) = @ARGV; - $upstream_spec //= 'refs/heads/upstream'; - my $upstream = git_rev_parse $upstream_spec; + + my $upstream_version = upstreamversion $version; + my $upstream = + resolve_upstream_version($upstream_spec, $upstream_version); + my $old_head = get_head(); my $upsdiff = get_differs $upstream, $old_head; if ($upsdiff & D_UPS) { - runcmd @git, qw(--no-pager diff), + runcmd @git, qw(--no-pager diff --stat), $upstream, $old_head, qw( -- :!/debian :/); - fail "upstream ($upstream_spec) and HEAD are not identical in upstream files"; + fail <{Date}; + next unless $stz->{Distribution} ne 'UNRELEASED'; + $lvsn = $stz->{Version}; + $suite = $stz->{Distribution}; + last; + }; + die "neither of the first two changelog entries are released\n" + unless defined $lvsn; + print "last finished-looking changelog entry: ($lvsn) $suite\n"; + my $mtag_pat = debiantag_maintview $lvsn, '*'; + my $mtag = cmdoutput @git, qw(describe --always --abbrev=0 --match), + $mtag_pat; + die "could not find suitable maintainer view tag $mtag_pat\n" + unless $mtag_pat =~ m{/}; + is_fast_fwd $mtag, 'HEAD' or + die "HEAD is not FF from maintainer tag $mtag!"; + my $dtag = "archive/$mtag"; + is_fast_fwd $mtag, $dtag or + die "dgit view tag $dtag is not FF from maintainer tag $mtag"; + print "will stitch in dgit view, $dtag\n"; + git_rev_parse $dtag; + }; + if (!$previous_dgit_view) { + $@ =~ s/^\n+//; + chomp $@; + print STDERR "cannot stitch in dgit view: $@\n"; + } + + snags_maybe_bail_early(); my $work; @@ -1337,23 +1748,28 @@ sub cmd_convert_from_gbp () { runcmd @git, qw(reset --quiet --hard patch-queue/gdr-internal); runcmd @git, qw(rebase --quiet --onto), $work, qw(gdr-internal); $work = git_rev_parse 'HEAD'; + + if ($previous_dgit_view) { + $work = make_commit [$work, $previous_dgit_view], [ + 'git-debrebase import: declare ff from dgit archive view', + '[git-debrebase pseudomerge: import-from-gbp]', + ]; + } }; + ffq_check $work; + snags_maybe_bail(); 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 $ffq = (ffq_prev_branchinfo())[3]; - my $bw = breakwater_of $head; - fresh_workarea(); + my (undef, undef, undef, $ffq, $gdrlast) = ffq_prev_branchinfo(); + keycommits $head, 0; my $out; + make_patches_staged $head; in_workarea sub { - runcmd @git, qw(checkout -q -b bw), $bw; - runcmd @git, qw(checkout -q -b patch-queue/bw), $head; - runcmd qw(gbp pq export); - runcmd @git, qw(add debian/patches); $out = make_commit ['HEAD'], [ 'Commit patch queue (converted from git-debrebase format)', '[git-debrebase convert-to-gbp: commit patches]', @@ -1361,7 +1777,9 @@ sub cmd_convert_to_gbp () { }; 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 <1; + + my @upstreams; + + if (@ARGV) { + my $spec = shift @ARGV; + my $commit = git_rev_parse "$spec^{commit}"; + push @upstreams, { Commit => $commit, + Source => "$ARGV[0], from command line", + Only => 1, + }; + } + + my $head = get_head(); + + if (!$always) { + my $troubles = 0; + my $trouble = sub { $troubles++; }; + keycommits $head, sub{}, sub{}, $trouble, $trouble; + printdebug "troubles=$troubles\n"; + if (!$troubles) { + print STDERR <{Version}; + print STDERR "Considering possible commits corresponding to upstream:\n"; + + if (!@upstreams) { + if ($do_tags) { + my @tried; + my $ups_tag = upstream_commitish_search $version, \@tried; + if ($ups_tag) { + my $this = "git tag $tried[-1]"; + push @upstreams, { Commit => $ups_tag, + Source => $this, + }; + } else { + printf STDERR + " git tag: no suitable tag found (tried %s)\n", + "@tried"; + } + } + if ($do_origs) { + my $p = $clogp->{'Source'}; + # we do a quick check to see if there are plausible origs + my $something=0; + if (!opendir BPD, $bpd) { + die "$bpd: opendir: $!" unless $!==ENOENT; + } else { + while ($!=0, my $f = readdir BPD) { + next unless is_orig_file_of_p_v $f, $p, $version; + printf STDERR + " orig: found what looks like a .orig, %s\n", + "$bpd/$f"; + $something=1; + last; + } + die "read $bpd: $!" if $!; + closedir BPD; + } + if ($something) { + my $tree = cmdoutput + @dgit, qw(--build-products-dir), $bpd, + qw(print-unapplied-treeish); + fresh_workarea(); + in_workarea sub { + runcmd @git, qw(reset --quiet), $tree, qw(-- .); + rm_subdir_cached 'debian'; + $tree = cmdoutput @git, qw(write-tree); + my $ups_synth = make_commit [], [ < $ups_synth, + Source => "orig(s) imported via dgit", + }; + } + } else { + printf STDERR + " orig: no suitable origs found (looked for %s in %s)\n", + "${p}_".(stripeoch $version)."...", $bpd; + } + } + } + + my $some_patches = stat_exists 'debian/patches/series'; + + print STDERR "Evaluating possible commits corresponding to upstream:\n"; + + my $result; + foreach my $u (@upstreams) { + my $work = $head; + fresh_workarea(); + in_workarea sub { + runcmd @git, qw(reset --quiet), $u->{Commit}, qw(-- .); + runcmd @git, qw(checkout), $u->{Commit}, qw(-- .); + runcmd @git, qw(clean -xdff); + runcmd @git, qw(checkout), $head, qw(-- debian); + if ($some_patches) { + rm_subdir_cached 'debian/patches'; + $work = make_commit [ $work ], [ + 'git-debrebase convert-from-dgit-view: drop upstream changes from breakwater', + "Drop upstream changes, and delete debian/patches, as part of converting\n". + "to git-debrebase format. Upstream changes will appear as commits.", + '[git-debrebase convert-from-dgit-view: drop patches from tree]' + ]; + } + $work = make_commit [ $work, $u->{Commit} ], [ + 'git-debrebase convert-from-dgit-view: declare upstream', + '(Re)constructed breakwater merge.', + '[git-debrebase anchor: declare upstream]' + ]; + runcmd @git, qw(checkout --quiet -b mk), $work; + if ($some_patches) { + runcmd @git, qw(checkout), $head, qw(-- debian/patches); + runcmd @git, qw(reset --quiet); + my @gbp_cmd = (qw(gbp pq import)); + if (!$diagnose) { + my $gbp_err = "../gbp-pq-err"; + @gbp_cmd = shell_cmd "exec >$gbp_err 2>&1", @gbp_cmd; + } + my $r = system @gbp_cmd; + if ($r) { + printf STDERR + " %s: couldn't apply patches: gbp pq %s", + $u->{Source}, waitstatusmsg(); + return; + } + } + my $work = git_rev_parse qw(HEAD); + my $diffout = cmdoutput @git, qw(diff-tree --stat HEAD), $work; + if (length $diffout) { + print STDERR + " $u->{Source}: applying patches gives different tree\n"; + print STDERR $diffout if $diagnose; + return; + } + # OMG! + $u->{Result} = $work; + $result = $u; + }; + last if $result; + } + + if (!$result) { + fail <{Source}; + + ffq_check $result->{Result}; + snags_maybe_bail(); + update_head_checkout $head, $result->{Result}, + 'convert-from-dgit-view'; +} + sub cmd_downstream_rebase_launder_v0 () { badusage "needs 1 argument, the baseline" unless @ARGV==1; my ($base) = @ARGV; @@ -1419,11 +2025,29 @@ sub cmd_downstream_rebase_launder_v0 () { } } -GetOptions("D+" => \$debuglevel, +getoptions_main + ("bad options\n", + "D+" => \$debuglevel, 'noop-ok', => \$opt_noop_ok, - 'f=s' => \@fproblem_force_opts, + 'f=s' => \@snag_force_opts, 'anchor=s' => \@opt_anchors, - 'force!') or die badusage "bad options\n"; + '--dgit=s' => \($dgit[0]), + '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=(); + }, + 'help' => sub { print $usage_message or die $!; finish 0; }, + ); + initdebug('git-debrebase '); enabledebug if $debuglevel; @@ -1434,7 +2058,7 @@ $rd = fresh_playground "$playprefix/misc"; @opt_anchors = map { git_rev_parse $_ } @opt_anchors; -if (!@ARGV || $ARGV[0] =~ m{^-}) { +if (!@ARGV || $opt_defaultcmd_interactive || $ARGV[0] =~ m{^-}) { defaultcmd_rebase(); } else { my $cmd = shift @ARGV; @@ -1445,3 +2069,5 @@ if (!@ARGV || $ARGV[0] =~ m{^-}) { $cmdfn or badusage "unknown git-debrebase sub-operation $cmd"; $cmdfn->(); } + +finish 0;