X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=dgit.git;a=blobdiff_plain;f=git-debrebase;h=ab1990aff7be6c721d2e8629083fbcb994ee3b23;hp=8e472514c34f82c92affe9dd629a71a7c770a28e;hb=def888415f7c15890ac55019b3187b5931c0682e;hpb=e68aa7468e1c7bb526e74bc90255744ef69b0338 diff --git a/git-debrebase b/git-debrebase index 8e472514..ab1990af 100755 --- a/git-debrebase +++ b/git-debrebase @@ -18,66 +18,6 @@ # 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 [] breakwater # prints breakwater tip only -# git-debrebase [] stitch [--prose=] -# 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? - use strict; use Debian::Dgit qw(:DEFAULT :playground); @@ -91,13 +31,14 @@ 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 $us = qw(git-debrebase); sub badusage ($) { my ($m) = @_; - die "bad usage: $m\n"; + print STDERR "bad usage: $m\n"; + exit 12; } sub cfg ($;$) { @@ -284,40 +225,40 @@ sub make_commit ($$) { return cmdoutput @cmd; } -our @fproblem_force_opts; -our $fproblems_forced; -our $fproblems_tripped; -sub fproblem ($$) { +our @snag_force_opts; +our $snags_forced; +our $snags_tripped; +sub snag ($$) { my ($tag,$msg) = @_; - if (grep { $_ eq $tag } @fproblem_force_opts) { - $fproblems_forced++; - print STDERR "git-debrebase: safety catch overridden (-f$tag): $msg\n"; + 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) { +sub snags_maybe_bail () { + 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; } } } -sub any_fproblems () { - return $fproblems_forced || $fproblems_tripped; +sub any_snags () { + return $snags_forced || $snags_tripped; } # classify returns an info hash like this @@ -356,6 +297,8 @@ sub any_fproblems () { # has additional entry in classification result # OrigParents = [ subset of Parents ] # singleton list # +# TreatAsAnchor +# # BreakwaterStart # # Unknown @@ -424,6 +367,10 @@ sub classify ($) { return $r; }; + 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; @@ -432,6 +379,23 @@ sub classify ($) { # 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). + 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"); @@ -531,40 +495,81 @@ 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) = @_; + # => ($anchor, $breakwater) + + # $unclean->("unclean-$tagsfx", $msg) + # $furniture->("unclean-$tagsfx", $msg) + # $dgitimport->("unclean-$tagsfx", $msg) + # 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. + # + # 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 $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); }; for (;;) { my $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)"); + $x->($furniture, (lc $ty), + "found interchange bureaucracy commit ($ty, $head)"); } elsif ($ty eq 'DgitImportUnpatched') { - $unclean->("found dgit dsc import ($head)"); + $x->($trouble, 'dgitimport', + "found dgit dsc import ($head)"); + $breakwater = undef; + $anchor = undef; + no warnings qw(exiting); + last; } else { fail "found unprocessable commit, cannot cope: $head; $cl->{Why}"; } $head = $cl->{Parents}[0]{CommitId}; } - return $breakwater; + return ($anchor, $breakwater); } sub walk ($;$$); @@ -677,7 +682,7 @@ sub walk ($;$$) { $rewrite_from_here->(\@upp_cl); $cur = $contrib; next; - } elsif ($ty eq 'Anchor') { + } elsif ($ty eq 'Anchor' or $ty eq 'TreatAsAnchor') { $last_anchor = $cur; $build_start->("Anchor", $cur); } elsif ($ty eq 'DgitImportUnpatched') { @@ -881,6 +886,15 @@ 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; + 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(); @@ -892,10 +906,7 @@ 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'; + my ($tip,$breakwater) = do_launder_head 'launder for rebase'; runcmd @git, qw(rebase), @ARGV, $breakwater; } @@ -913,7 +924,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, @@ -923,8 +934,9 @@ sub ffq_prev_branchinfo () { return ('weird-symref', 'HEAD symref is not to refs/') unless $current =~ m{^refs/}; my $ffq_prev = "refs/$ffq_refprefix/$'"; + my $gdrlast = "refs/$gdrlast_refprefix/$'"; printdebug "ffq_prev_branchinfo branch current $current\n"; - return ('branch', undef, $current, $ffq_prev); + return ('branch', undef, $current, $ffq_prev, $gdrlast); } sub record_ffq_prev_deferred () { @@ -935,11 +947,12 @@ sub record_ffq_prev_deferred () { # detached # weird-symref # notbranch - # if not ff from some branch we should be ff from, is an fproblem + # 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) = ffq_prev_branchinfo(); + my ($status, $message, $current, $ffq_prev, $gdrlast) + = ffq_prev_branchinfo(); return ($status, $message) unless $status eq 'branch'; my $currentval = get_head(); @@ -974,10 +987,10 @@ sub record_ffq_prev_deferred () { $checked{$lrref} = 1; } 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"; } }; @@ -1003,9 +1016,10 @@ sub record_ffq_prev_deferred () { $check->("refs/remotes/dgit/dgit/sid", 'remote dgit branch for sid'); } - fproblems_maybe_bail(); + 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); } @@ -1014,24 +1028,78 @@ 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 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(); + 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) = @_; + + 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, \&snag, \&snag, \&snag; + + stitch($dangling_head, $ffq_prev, $gdrlast, $ffq_prev_commitish, $prose); +} + sub cmd_new_upstream_v0 () { # automatically and unconditionally launders before rebasing # if rebase --abort is used, laundering has still been done 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(); @@ -1074,13 +1142,17 @@ sub cmd_new_upstream_v0 () { my $old_bw_cl = classify $old_bw; my $old_anchor_cl = classify $old_anchor; - confess unless $old_anchor_cl->{OrigParents}; - my $old_upstream = parsecommit - $old_anchor_cl->{OrigParents}[0]{CommitId}; - - $piece->('', Old => $old_upstream->{CommitId}); + 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 ) { @@ -1091,21 +1163,23 @@ sub cmd_new_upstream_v0 () { $piece->($n, Old => $old_upstream->{CommitId}.'^'.$parentix); } } 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}"; } } @@ -1113,7 +1187,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; @@ -1121,7 +1195,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}; } @@ -1211,44 +1285,23 @@ 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 = ''; + my $prose = 'stitch'; GetOptions('prose=s', \$prose) or die badusage("bad options to stitch"); 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; - } - 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; - } - } - 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"; + do_stitch($prose); } sub cmd_convert_from_gbp () { @@ -1268,25 +1321,25 @@ sub cmd_convert_from_gbp () { } 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; @@ -1323,8 +1376,8 @@ sub cmd_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; + my (undef, undef, undef, $ffq, $gdrlast) = ffq_prev_branchinfo(); + my ($anchor, $bw) = keycommits $head, 0; fresh_workarea(); my $out; in_workarea sub { @@ -1339,6 +1392,7 @@ sub cmd_convert_to_gbp () { }; if (defined $ffq) { push @deferred_updates, "delete $ffq"; + push @deferred_updates, "delete $gdrlast"; } update_head_checkout $head, $out, "convert to gbp (v0)"; print < \$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"; initdebug('git-debrebase '); enabledebug if $debuglevel; @@ -1409,6 +1464,8 @@ chdir $toplevel or die "chdir $toplevel: $!"; $rd = fresh_playground "$playprefix/misc"; +@opt_anchors = map { git_rev_parse $_ } @opt_anchors; + if (!@ARGV || $ARGV[0] =~ m{^-}) { defaultcmd_rebase(); } else {