chiark / gitweb /
git-debrebase: sort out report, and walk, allegedly
[dgit.git] / git-debrebase
index 71167e8..d9bc943 100755 (executable)
@@ -20,8 +20,8 @@
 
 # usages:
 #    git-debrebase status
-#    git-debrebase start       # like ffrebase start + debrebase launder
-#    git-debrebase new-upstream [-f] <upstreaminfo>...
+#    git-debrebase start       # like ffqrebase start + debrebase launder
+#    git-debrebase new-upstream [stuff]  # see below
 #    git-debrebase <git-rebase options>  # does debrebase start if necessary
 #
 #    git-debrebase analyse
 # xxx want auto branch names
 # xxx too complicated
 # how about for now
-#    [+]<commit> [<subdir:> [+]<commit>...]
+#    [+]<commit> [<subdir/> [+]<commit>...]
 # ?  plus options
 #     --new-upstream-different-subtrees
+#
+#  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=<subdir>[/])
+#  branch set adjustments
+#       git-debrebase new-upstream --add <subdir>/
+#       git-debrebase new-upstream --rm <subdir>/
+#       git-debrebase new-upstream / [<subdir>/ ...]
+#             - 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 / [<rootcommitid>] [<subdir>/ [<commitid>] ...]
+#             - 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 \
+#             [<subdir>/]=<commitid>
 
 #    UPSTREAM[,[[SUBDIR:]SUBUPSTREAM]
 #    default for SUBDIR: is from previous upstream merge[xxx terminology]
 # when starting must record original start (for ff)
 # and new rebase basis
 #
-#    git-ffrebase start [BASE] # records previous HEAD so it can be overwritten
-#                              # records base for future git-ffrebase
-#    git-ffrebase set-base BASE
-#    git-ffrebase <git-rebase options>
-#    git-ffrebase finish
-#    git-ffrebase status [BRANCH]
+#    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-rebase options>
+#    git-ffqrebase finish
+#    git-ffqrebase status [BRANCH]
 #
-#  refs/ffrebase-prev/BRANCH    BRANCH may be refs/...; if not it means
-#  refs/ffrebase-base/BRANCH      refs/heads/BRANCH
+#  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
+#
+# 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 ?
 
 use strict;
 
@@ -86,10 +129,10 @@ sub get_commit ($) {
     return ($`,$');
 }
 
-sub D_DEB ()     { return 0x1; }
-sub D_UPS ()     { return 0x2; }
-sub D_PAT_ADD () { return 0x4; }
-sub D_PAT_OTH () { return 0x8; }
+sub D_DEB ()     { return 0x1; } # debian/ (not including debian/patches/)
+sub D_UPS ()     { return 0x2; } # upstream files
+sub D_PAT_ADD () { return 0x4; } # debian/patches/ extra patches at end
+sub D_PAT_OTH () { return 0x8; } # debian/patches other changes
 
 our $rd = ".git/git-debrebase";
 our $ud = "$rd/work";
@@ -101,12 +144,48 @@ sub commit_pr_info ($) {
 
 sub calculate_committer_authline () {
     my $c = cmdoutput @git, qw(commit-tree --no-gpg-sign -m),
-       'XXX DUMMY COMMIT (git-debrebase)', "$basis:";
+       'DUMMY COMMIT (git-debrebase)', "$basis:";
     my ($h,$m) = get_commit $c;
     $h =~ m/^committer .*$/m or confess "($h) ?";
     return $&;
 }
 
+# classify returns an info hash like this
+#   CommitId => $objid
+#   Hdr => # commit headers, including 1 final newline
+#   Msg => # commit message (so one newline is dropped)
+#   Tree => $treeobjid
+#   Type => (see below)
+#   Parents = [ {
+#       Ix => $index # ie 0, 1, 2, ...
+#       CommitId
+#       Differs => return value from get_differs
+#       IsOrigin
+#       IsDggitImport => 'orig' 'tarball' 'unpatched' 'package' (as from dgit)
+#     } ...]
+#   NewMsg => # commit message, but with any [dgit import ...] edited
+#             # to say "[was: ...]"
+#
+# Types:
+#   Packaging
+#   Upstream
+#   AddPatches
+#   Mixed
+#   Unknown
+#
+#   Pseudomerge
+#     has additional entres in classification result
+#       Overwritten = [ subset of Parents ]
+#       Contributor = $the_remaining_Parent
+#
+#   DgitImportUnpatched
+#     has additional entry in classification result
+#       OrigParents = [ subset of Parents ]
+#
+#   BreakwaterUpstreamMerge
+#     has additional entry in classification result
+#       OrigParents = [ subset of Parents ]
+
 sub classify ($) {
     my ($objid) = @_;
 
@@ -214,20 +293,26 @@ sub classify ($) {
        !($p[0]{Differs} & ~D_DEB) &&
        !($p[1]{Differs} & ~D_UPS)) {
        return $classify->(qw(BreakwaterUpstreamMerge),
-                          Upstream => $p[1]);
+                          OrigParents => [ $p[1] ]);
     }
+    # xxx multi-.orig upstreams
 
     return $unknown->("complex merge");
 }
 
-sub launder ($$$) {
-    my ($input, $pseudos_must_overwrite_this, $wantdebonly) = @_;
+sub walk ($;$$$$) {
+    my ($input,
+       $nogenerate,$report,
+       $wantdebonly,$depth) = @_;
     # go through commits backwards
     # we generate two lists of commits to apply
+    # => ($tip, $breakwater_tip)
     my (@deb_cl, @ups_cl, @processed);
     my %found;
     my @pseudomerges;
 
+    $depth //= 0;
+
     my $cl;
     my $xmsg = sub {
        my ($appendinfo) = @_;
@@ -242,11 +327,19 @@ sub launder ($$$) {
 
     my $cur = $input;
 
+    my $prdelim = "";
+    my $prprdelim = sub { print $report $prdelim if $report; $prdelim=""; }
+
     for (;;) {
        $cl = classify $cur;
        my $ty = $cl->{Type};
        my $st = $cl->{SubType};
+       if ($report) {
+           print $report $prdelim, "$cl->{CommitId} $cl->{Type}";
+           $prdelim = "\n";
+       }
        $found{$ty. ( defined($st) ? "-$st" : '' )}++;
+       push @processed, $cl;
        my $p0 = $cl->{Parents}[0]{CommitId};
        if ($ty eq 'AddPatches') {
            $cur = $p0;
@@ -254,12 +347,10 @@ sub launder ($$$) {
            next;
        } elsif ($ty eq 'Packaging') {
            push @deb_cl, $cl;
-           push @processed, $cl;
            $cur = $p0;
            next;
        } elsif ($ty eq 'Upstream') {
            push @ups_cl, $cl;
-           push @processed, $cl;
            $cur = $p0;
            next;
        } elsif ($ty eq 'Mixed') {
@@ -273,9 +364,7 @@ sub launder ($$$) {
            $rewrite_from_here->();
            next;
        } elsif ($ty eq 'Pseudomerge') {
-           if (defined $pseudos_must_overwrite_this) {
-               confess 'xxx actually check this';
-           }
+           print $report " Contributor=$ty->{Contributor}" if $report;
            push @pseudomerges, $cl;
            $rewrite_from_here->();
            $cur = $ty->{Contributor};
@@ -295,7 +384,10 @@ sub launder ($$$) {
            # precisely right.  Otherwise, it was a non-gitish upload
            # of a new upstream version.  We can tell these apart
            # by looking at the tree of the supposed upstream.
+           my $differs = get_differs $previous_breakwater, $cl->{Tree};
+           printf $report " Differs=%#x", $differs if $report;
            if ($differs & D_UPS) {
+               printf $report " D_UPS" if $report;
                push @deb_cl, {
                     %r,
                     SpecialMethod => 'DgitImportUpstreamUpdate',
@@ -307,20 +399,32 @@ sub launder ($$$) {
                SpecialMethod => 'DgitImportDebianUpdate',
                 $xmsg->("convert dgit import: upstream changes")
            };
-           my $differs = get_differs $previous_breakwater, $cl->{Tree};
-           $basis = launder $pseudomerges[0]{Overwritten}, undef, 1;
+           $prprdelim->();
+           $basis = walk
+               $pseudomerges[0]{Overwritten},
+               $nogenerate, $report,
+               1, $depth+1;
            $rewrite_from_here->();
            last;
        } else {
-           die "Reached difficult commit $cur: ".Dumper($cl);
+           print $report " Unprocessable" if $report;
+           $prprdelim->();
+           if ($nogenerate) {
+               return (undef,undef);
+           }
+           die "commit $cur: Cannot cope with this commit";
        }
     }
+    $prprdelim->();
+    if ($nogenerate) {
+       return (undef, $basis);
+    }
+
     # Now we build it back up again
 
     workarea_fresh();
-    in_workarea sub { xxx attributes xxx };
 
-    my $rewriting = 1;
+    my $rewriting = 0;
 
     my $build = $basis;
 
@@ -414,10 +518,27 @@ sub update_head ($$) {
 }
 
 sub cmd_launder () {
+    badusage "no arguments to launder allowed";
     my $old = get_head();
-    my ($tip,$breakwater) = launder $old, 0, undef, 0;
-    update_head $old, $tip, 'launder'; # no tree changes! xxx debian/patches
-    printf "# breakwater tip:\n%s\n", $breakwater;
+    my ($tip,$breakwater) = walk $old;
+    update_head $old, $tip, 'launder';
+    # no tree changes except debian/patches
+    runcmd @git, qw(rm --quiet -rf debian/patches);
+    printf "# breakwater tip\n%s\n", $breakwater;
+}
+
+sub cmd_analyse () {
+    die if ($ARGV[0]//'') =~ m/^-/;
+    badusage "too many arguments to analyse" if @ARGV>1;
+    my ($old) = @ARGV;
+    if (defined $old) {
+       $old = git_rev_parse $old;
+    } else {
+       $old = get_head();
+    }
+    my ($dummy,$breakwater) = walk $old, 1,*STDOUT;
+    print "$breakwater BREAKWATER\n";
+    STDOUT->error and die $!;
 }
 
 my $toplevel = runcmd @git, qw(rev-parse --show-toplevel);