X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=dgit.git;a=blobdiff_plain;f=git-debrebase;h=a5329b6b117ffe27211282038edcc40aefd4e32d;hp=86958820221ec4b1212f708a7e1749572f7a8e29;hb=be8119133fb4de3173b0a39d28f09dd74a112d65;hpb=5e05a8f7605034ee94826bd72688f544c965f74c diff --git a/git-debrebase b/git-debrebase index 86958820..a5329b6b 100755 --- a/git-debrebase +++ b/git-debrebase @@ -3,7 +3,7 @@ # Script helping make fast-forwarding histories while still rebasing # upstream deltas when working on Debian packaging # -# Copyright (C)2017 Ian Jackson +# Copyright (C)2017,2018 Ian Jackson # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by @@ -18,93 +18,65 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . -# git-debrebase new-upstreams-v0 \ -# NEW-VERSION ORIG-COMMITISH -# [EXTRA-ORIG-NAME EXTRA-ORIG-COMMITISH ...] # usages: -# git-debrebase status -# git-debrebase start # like ffqrebase start + debrebase launder -# git-debrebase new-upstream [stuff] # see below -# git-debrebase # does debrebase start if necessary # -# git-debrebase analyse -# git-debrebase launder # prints breakwater tip -# git-debrebase create-new-upstream-breakwater [-f] ... +# git-debrebase [] new-upstream-v0 \ +# \ +# [ ...] \ +# [...] # -# is -# [,][:][+][,...] +# 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 # -# if initial comma is supplied, entries are not positional. Unspecified -# means root (and there may be only one). -# xxx want auto branch names -# xxx too complicated -# how about for now -# [+] [ [+]...] -# ? plus options -# --new-upstream-different-subtrees +# 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. # -# automatic case -# git-debrebase new-upstream -# - previous breakwater merge must be gdr-generated -# - orig set is the same as before -# - implicitly uses upstream branches according to orig set -# - not all upstream branches need be updated -# - insists on fast-forward of each branch, unless -# --force (or --force=[/]) -# branch set adjustments -# git-debrebase new-upstream --add / -# git-debrebase new-upstream --rm / -# git-debrebase new-upstream / [/ ...] -# - orig set is adjusted -# - otherwise like auto (--add is not checked for ffness, obv) -# - multiple --add and --rm may be specified -# - --add makes new upstream the last contributor -# explicit -# git-debrebase / [] [/ [] ...] -# - orig set is precisely as specified now -# - previous breakwater merge is irrelevant -# - no fast forward checks -# for now only explicit with commitids - -# implicitly uses `upstream' -# # (or multiple other branches) -# git-debrebase new-upstream \ -# [/]= - -# UPSTREAM[,[[SUBDIR:]SUBUPSTREAM] -# default for SUBDIR: is from previous upstream merge[xxx terminology] -# +# * There are no tests. # -#xxx -# when starting must record original start (for ff) -# and new rebase basis +# * new-upstream-v0 has a terrible UI. You end up with giant +# runic command lines. # -# git-ffqrebase start [BASE] -# # records previous HEAD so it can be overwritten -# # records base for future git-ffqrebase -# git-ffqrebase set-base BASE -# git-ffqrebase -# git-ffqrebase finish -# git-ffqrebase status [BRANCH] +# 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. # -# refs/ffqrebase-prev/BRANCH BRANCH may be refs/...; if not it means -# refs/ffqrebase-base/BRANCH refs/heads/BRANCH -# zero, one, or both of these may exist +# * There should be a standard convention for the version number, +# and unfinalised or not changelog, after new-upstream. # -# git-debrebase without start, if already started, is willing -# to strip pseudomerges provided that they overwrite exactly -# the previous HEAD -# xxxx is this right ? what matters is have we pushed -# I think in fact the right answer is: -# git-debrebase always strips out pseudomerges from its branch -# a pseudomerge is put in at the time we want to push -# at that time, we make a pseudomerge of the remote tracking -# branch (if raw git) or the dgit view (if dgit) -# for raw git git-ffqrebase, do want preciseley to record -# value of remote tracking branch or our branch, on start, so we -# overwrite only things we intend to -# the previous pseudomerge check for tags and remote branches ? +# * 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; @@ -117,22 +89,30 @@ use POSIX; use Data::Dumper; use Getopt::Long qw(:config posix_default gnu_compat bundling); use Dpkg::Version; +use File::FnMatch qw(:fnmatch); -our ($opt_force); +our ($opt_force, $opt_noop_ok); + +our $us = qw(git-debrebase); sub badusage ($) { my ($m) = @_; die "bad usage: $m\n"; } -sub cfg ($) { - my ($k) = @_; - $/ = "\0"; +sub cfg ($;$) { + my ($k, $optional) = @_; + local $/ = "\0"; my @cmd = qw(git config -z); push @cmd, qw(--get-all) if wantarray; push @cmd, $k; - my $out = cmdoutput @cmd; - return split /\0/, $out; + my $out = cmdoutput_errok @cmd; + if (!defined $out) { + fail "missing required git config $k" unless $optional; + return (); + } + my @l = split /\0/, $out; + return wantarray ? @l : $l[0]; } memoize('cfg'); @@ -146,7 +126,7 @@ sub dd ($) { sub get_commit ($) { my ($objid) = @_; - my $data = git_cat_file $objid, 'commit'; + my $data = (git_cat_file $objid, 'commit'); $data =~ m/(?<=\n)\n/ or die "$objid ($data) ?"; return ($`,$'); } @@ -192,7 +172,7 @@ sub get_differs ($$) { my @cmd = (@git, qw(diff-tree -z --no-renames)); push @cmd, @$opts; push @cmd, "$_:" foreach $x, $y; - push @cmd, @$limits; + push @cmd, '--', @$limits; my $diffs = cmdoutput @cmd; foreach (split /\0/, $diffs) { $fn->(); } }; @@ -230,8 +210,8 @@ sub get_differs ($$) { if ($mode eq 'A' && !m/\.series$/s) { $ok = 1; } elsif ($mode eq 'M' && $_ eq 'series') { - my $x_s = git_cat_file "$x:debian/patches/series", 'blob'; - my $y_s = git_cat_file "$y:debian/patches/series", 'blob'; + my $x_s = (git_cat_file "$x:debian/patches/series", 'blob'); + my $y_s = (git_cat_file "$y:debian/patches/series", 'blob'); chomp $x_s; $x_s .= "\n"; $ok = $x_s eq substr($y_s, 0, length $x_s); } else { @@ -282,6 +262,42 @@ 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"; + } else { + $fproblems_tripped++; + print STDERR "git-debrebase: safety catch tripped (-f$tag): $msg\n"; + } +} + +sub fproblems_maybe_bail () { + if ($fproblems_forced) { + printf STDERR + "%s: safety catch trips: %d overriden by individual -f options\n", + $us, $fproblems_forced; + } + if ($fproblems_tripped) { + if ($opt_force) { + printf STDERR + "%s: safety catch trips: %d overriden by global --force\n", + $us, $fproblems_tripped; + } else { + fail sprintf + "%s: safety catch trips: %d blockers (you could -f, or --force)", + $us, $fproblems_tripped; + } + } +} +sub any_fproblems () { + return $fproblems_forced || $fproblems_tripped; +} + # classify returns an info hash like this # CommitId => $objid # Hdr => # commit headers, including 1 final newline @@ -304,7 +320,6 @@ sub make_commit ($$) { # Upstream # AddPatches # Mixed -# Unknown # # Pseudomerge # has additional entres in classification result @@ -315,9 +330,15 @@ sub make_commit ($$) { # has additional entry in classification result # OrigParents = [ subset of Parents ] # -# BreakwaterUpstreamMerge +# Anchor # has additional entry in classification result # OrigParents = [ subset of Parents ] # singleton list +# +# BreakwaterStart +# +# Unknown +# has additional entry in classification result +# Why => "prose" sub parsecommit ($;$) { my ($objid, $p_ref) = @_; @@ -376,11 +397,40 @@ 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 @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 + + 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). + + $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) { my $d = $r->{Parents}[0]{Differs}; if ($d == D_PAT_ADD) { @@ -414,24 +464,32 @@ sub classify ($) { return $unknown->("origin commit"); } - my @identical = grep { !$_->{Differs} } @p; 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}; @@ -448,46 +506,50 @@ 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 breakwater_of ($) { + my ($head) = @_; # must be laundered + my $breakwater; + my $unclean = sub { + my ($why) = @_; + fail "branch needs laundering (run git-debrebase): $why"; + }; + for (;;) { + my $cl = classify $head; + my $ty = $cl->{Type}; + if ($ty eq 'Packaging' or + $ty eq 'Changelog') { + $breakwater //= $head; + } elsif ($ty eq 'Anchor' or + $ty eq 'BreakwaterStart') { + $breakwater //= $head; + last; + } elsif ($ty eq 'Upstream') { + $unclean->("packaging change ($breakwater)". + " follows upstream change (eg $head)") + if defined $breakwater; + } elsif ($ty eq 'Mixed') { + $unclean->('found mixed upstream/packaging commit ($head)'); + } elsif ($ty eq 'Pseudomerge' or + $ty eq 'AddPatches') { + $unclean->("found interchange conversion commit ($ty, $head)"); + } elsif ($ty eq 'DgitImportUnpatched') { + $unclean->("found dgit dsc import ($head)"); + } else { + fail "found unprocessable commit, cannot cope: $head; $cl->{Why}"; } + $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 $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"; @@ -502,15 +564,17 @@ sub walk ($;$$) { my $cl; my $xmsg = sub { - my ($appendinfo) = @_; + my ($prose, $info) = @_; my $ms = $cl->{Msg}; chomp $ms; - $ms .= "\n\n[git-debrebase $appendinfo]\n"; + $info //= ''; + $ms .= "\n\n[git-debrebase$info: $prose]\n"; 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; @@ -526,13 +590,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; @@ -545,7 +612,7 @@ sub walk ($;$$) { no warnings qw(exiting); last; }; - my $last_upstream_update; + my $last_anchor; for (;;) { $cl = classify $cur; @@ -557,14 +624,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; @@ -578,19 +645,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') { + $last_anchor = $cur; + $build_start->("Anchor", $cur); } elsif ($ty eq 'DgitImportUnpatched') { my $pm = $pseudomerges[-1]; if (defined $pm) { @@ -603,7 +670,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"; @@ -626,25 +694,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") - }; - } $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 { @@ -686,6 +744,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(); @@ -721,8 +781,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 { @@ -738,7 +800,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 ?"; @@ -757,7 +819,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; } } }; @@ -766,12 +828,15 @@ 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 } -sub get_head () { return git_rev_parse qw(HEAD); } +sub get_head () { + git_check_unmodified(); + return git_rev_parse qw(HEAD); +} sub update_head ($$$) { my ($old, $new, $mrest) = @_; @@ -780,26 +845,40 @@ sub update_head ($$$) { sub update_head_checkout ($$$) { my ($old, $new, $mrest) = @_; - my $symref = git_get_symref(); - runcmd @git, qw(checkout), $new, qw(.); update_head $old, $new, $mrest; + runcmd @git, qw(reset --hard); } sub update_head_postlaunder ($$$) { my ($old, $tip, $reflogmsg) = @_; + return if $tip eq $old; + print "git-debrebase: laundered (head was $old)\n"; update_head $old, $tip, $reflogmsg; # no tree changes except debian/patches runcmd @git, qw(rm --quiet --ignore-unmatch -rf debian/patches); } -sub cmd_launder () { - badusage "no arguments to launder allowed" if @ARGV; +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; } sub cmd_analyse () { @@ -809,23 +888,117 @@ sub cmd_analyse () { if (defined $old) { $old = git_rev_parse $old; } else { - $old = get_head(); + $old = git_rev_parse 'HEAD'; } my ($dummy,$breakwater) = walk $old, 1,*STDOUT; STDOUT->error and die $!; } +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); +} + +sub record_ffq_prev () { + # => ('status', "message") + # 'status' may be + # written 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(); + 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; + + return ('not-branch', 'HEAD symref is not to refs/heads/') + unless $current =~ m{^refs/heads/}; + my $branch = $'; + + 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{^[!^]}{}; + last if fnmatch $glob, $lrref; + } + return if $invert; + my $lrval = git_get_ref $lrref; + return unless defined $lrval; + + if (is_fast_fwd $lrval, $currentval) { + print "OK, you are ahead of $lrref\n" or die $!; + $checked{$lrref} = 1; + } elsif (is_fast_fwd $currentval, $lrval) { + $checked{$lrref} = -1; + fproblem 'behind', "you are behind $lrref, divergence risk"; + } else { + $checked{$lrref} = -1; + fproblem 'diverged', "you have diverged from $lrref"; + } + }; + + my $merge = cfg "branch.$branch.merge",1; + if (defined $merge and $merge =~ m{^refs/heads/}) { + my $rhs = $'; + printdebug "ffq merge $rhs\n"; + my $check_remote = sub { + my ($remote, $desc) = @_; + printdebug "ffq check_remote ".($remote//'undef')." $desc\n"; + return unless defined $remote; + $check->("refs/remotes/$remote/$rhs", $desc); + }; + $check_remote->((scalar cfg "branch.$branch.remote",1), + 'remote fetch/merge branch'); + $check_remote->((scalar cfg "branch.$branch.pushRemote",1) // + (scalar cfg "branch.$branch.pushDefault",1), + 'remote push branch'); + } + if ($branch =~ m{^dgit/}) { + $check->("refs/remotes/dgit/$branch", 'remote dgit branch'); + } elsif ($branch =~ m{^master$}) { + $check->("refs/remotes/dgit/dgit/sid", 'remote dgit branch for sid'); + } + + 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); +} + sub cmd_new_upstream_v0 () { - # xxx would like to support more git-rebase options - badusage - "need NEW-VERSION UPS-COMMITISH [EXTRA-UPS-NAME EXTRA-UPS-COMMITISH...]" - unless @ARGV % 2 == 0 and @ARGV >= 2; - # tree should be clean and this is not checked # 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; + # parse args - low commitment my $new_version = (new Dpkg::Version scalar(shift @ARGV), check => 1); my $new_upstream_version = $new_version->version(); @@ -853,8 +1026,12 @@ sub cmd_new_upstream_v0 () { OldIx => 0, New => $new_upstream, ); - while (@ARGV) { + while (@ARGV && $ARGV[0] !~ m{^-}) { my $n = shift @ARGV; + + badusage "for each EXTRA-UPS-NAME need EXTRA-UPS-COMMITISH" + unless @ARGV && $ARGV[0] !~ m{^-}; + my $c = git_rev_parse shift @ARGV; die unless $n =~ m/^$extra_orig_namepart_re$/; $newpiece->($n, New => $c); @@ -871,18 +1048,11 @@ sub cmd_new_upstream_v0 () { my $old_upstream = parsecommit $old_upstream_update_cl->{OrigParents}[0]{CommitId}; - my $problems = 0; - my $problem = sub { - my ($msg) = @_; - $problems++; - print STDERR "preflight check failed: $msg\n"; - }; - $piece->('', Old => $old_upstream->{CommitId}); if ($old_upstream->{Msg} =~ m{^\[git-debrebase }m) { if ($old_upstream->{Msg} =~ - m{^\[git-debrebase new-upstream combine \.((?: $extra_orig_namepart_re)+)\]} + m{^\[git-debrebase upstream-combine \.((?: $extra_orig_namepart_re)+)\:.*\]$}m ) { my @oldpieces = ('', split / /, $1); my $parentix = -1 + scalar @{ $old_upstream->{Parents} }; @@ -891,35 +1061,29 @@ sub cmd_new_upstream_v0 () { $piece->($n, Old => $old_upstream->{CommitId}.'^'.$parentix); } } else { - $problem->("previous upstream $old_upstream->{CommitId} is from". - " git-debrebase but not a \`new-upstream combine' commit"); + fproblem '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}) { - $problem->("introducing upstream piece \`$pc->{Name}'"); + fproblem 'upstream-new-piece', + "introducing upstream piece \`$pc->{Name}'"; } elsif (!$pc->{New}) { - $problem->("dropping upstream piece \`$pc->{Name}'"); + fproblem 'upstream-rm-piece', + "dropping upstream piece \`$pc->{Name}'"; } elsif (!is_fast_fwd $pc->{Old}, $pc->{New}) { - $problem->("not fast forward: $pc->{Name} $pc->{Old}..$pc->{New}"); + fproblem 'upstream-not-ff', + "not fast forward: $pc->{Name} $pc->{Old}..$pc->{New}"; } } printdebug "%pieces = ", (dd \%pieces), "\n"; printdebug "\@newpieces = ", (dd \@newpieces), "\n"; - if ($problems) { - if ($opt_force) { - printf STDERR - "preflight check failures (%d) overriden by --force\n", - $problems; - } else { - fail sprintf - "preflight check failures (%d) (you could --force)", - $problems; - } - } + fproblems_maybe_bail(); my $new_bw; @@ -927,7 +1091,7 @@ sub cmd_new_upstream_v0 () { in_workarea sub { my @upstream_merge_parents; - if (!$problems) { + if (!any_fproblems()) { push @upstream_merge_parents, $old_upstream->{CommitId}; } @@ -946,22 +1110,22 @@ sub cmd_new_upstream_v0 () { # need to make the upstream subtree merge commit $new_upstream = make_commit \@upstream_merge_parents, [ "Combine upstreams for $new_upstream_version", - ("[git-debrebase new-upstream combine . ". - (join " ", map { $_->{Name} } @newpieces[1..$#newpieces]). - "]"), + ("[git-debrebase upstream-combine . ". + (join " ", map { $_->{Name} } @newpieces[1..$#newpieces]). + ": new upstream]"), ]; } # $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 new-upstream breakwater $new_upstream_version]", + "[git-debrebase anchor: new upstream $new_upstream_version, merge]", ]; # Now we have to add a changelog stanza so the Debian version @@ -989,7 +1153,7 @@ END # Now we have the final new breakwater branch in the index $new_bw = make_commit [ $new_bw ], [ "Update changelog for new upstream $new_upstream_version", - "[git-debrebase new-upstream changelog $new_upstream_version]", + "[git-debrebase: new upstream $new_upstream_version, changelog]", ]; }; @@ -1000,11 +1164,171 @@ END update_head_postlaunder $old_head, $old_laundered_tip, 'launder for new upstream'; - my @cmd = (@git, qw(rebase --onto), $new_bw, $old_bw); + my @cmd = (@git, qw(rebase --onto), $new_bw, $old_bw, @ARGV); runcmd @cmd; # now it's for the user to sort out } +sub cmd_record_ffq_prev () { + badusage "no arguments allowed" if @ARGV; + my ($status, $msg) = record_ffq_prev(); + if ($status eq 'exists' && $opt_noop_ok) { + print "Previous head already recorded\n" or die $!; + } elsif ($status eq 'written') { + } else { + fail "Could not preserve: $msg"; + } +} + +sub cmd_breakwater () { + badusage "no arguments allowed" if @ARGV; + my $bw = breakwater_of git_rev_parse 'HEAD'; + print "$bw\n" or die $!; +} + +sub cmd_stitch () { + my $prose = ''; + 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; + } + 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, + "debrebase: stitch (fast forward)"; + runcmd @git, qw(update-ref -d), $ffq_prev; # should be atomic + return; + } + } + fresh_workarea(); + my $new_head = make_commit [ $old_head, $ffq_prev ], [ + 'Declare fast forward / record previous work', + "[git-debrebase pseudomerge: stitch$prose]", + ]; + my @upd_cmd = (@git, qw(update-ref --stdin -m), "debrebase: stitch"); + debugcmd '>|', @upd_cmd; + open U, "|-", @upd_cmd or die $!; + my $u = <= ", $_, "\n" foreach split /\n/, $u; + print U $u; + printdebug ">\$\n"; + close U or failedcmd @upd_cmd; +} + +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; + my $old_head = get_head(); + + my $upsdiff = get_differs $upstream, $old_head; + if ($upsdiff & D_UPS) { + runcmd @git, qw(--no-pager diff), + $upstream, $old_head, + qw( -- :!/debian :/); + fail "upstream ($upstream_spec) and HEAD are not identical in upstream files"; + } + + if (!is_fast_fwd $upstream, $old_head) { + fproblem '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', + "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', + "upstream ($upstream) contains debian/ directory"; + } + + fproblems_maybe_bail(); + + my $work; + + fresh_workarea(); + in_workarea sub { + runcmd @git, qw(checkout -q -b gdr-internal), $old_head; + # make a branch out of the patch queue - we'll want this in a mo + runcmd qw(gbp pq import); + # strip the patches out + runcmd @git, qw(checkout -q gdr-internal~0); + rm_subdir_cached 'debian/patches'; + $work = make_commit ['HEAD'], [ + 'git-debrebase convert-from-gbp: drop patches from tree', + 'Delete debian/patches, as part of converting to git-debrebase format.', + '[git-debrebase convert-from-gbp: drop patches from tree]' + ]; + # 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 anchor: declare upstream]' + ]; + + # rebase the patch queue onto the new breakwater + 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'; + }; + + 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 $out; + 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]', + ]; + }; + if (defined $ffq) { + runcmd @git, qw(update-ref -m), + "debrebase: converting corresponding main branch to gbp format", + $ffq, $git_null_obj; + } + 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"; initdebug('git-debrebase '); enabledebug if $debuglevel; @@ -1064,10 +1390,14 @@ chdir $toplevel or die "chdir $toplevel: $!"; $rd = fresh_playground "$playprefix/misc"; -my $cmd = shift @ARGV; -my $cmdfn = $cmd; -$cmdfn =~ y/-/_/; -$cmdfn = ${*::}{"cmd_$cmdfn"}; +if (!@ARGV || $ARGV[0] =~ m{^-}) { + defaultcmd_rebase(); +} else { + my $cmd = shift @ARGV; + my $cmdfn = $cmd; + $cmdfn =~ y/-/_/; + $cmdfn = ${*::}{"cmd_$cmdfn"}; -$cmdfn or badusage "unknown git-debrebase sub-operation $cmd"; -$cmdfn->(); + $cmdfn or badusage "unknown git-debrebase sub-operation $cmd"; + $cmdfn->(); +}