chiark / gitweb /
git-debrebase: rework commit annotations
authorIan Jackson <ijackson@chiark.greenend.org.uk>
Sat, 10 Feb 2018 15:19:52 +0000 (15:19 +0000)
committerIan Jackson <ijackson@chiark.greenend.org.uk>
Sat, 16 Jun 2018 11:25:49 +0000 (12:25 +0100)
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
NOTES.git-debrebase
git-debrebase

index 6510c6e..635f72b 100644 (file)
 =========
 
 special commit tags
+overall format
+  [git-debrebase[ COMMIT-TYPE [ ARGS...]]: PROSE, MORE PROSE]
 
-[git-debrebase split mixed commit: debian part]
-[git-debrebase split mixed commit: upstream part]
-[git-debrebase convert dgit import: debian changes]
-[git-debrebase convert dgit import: upstream changes]
+[git-debrebase: split mixed commit, debian part]
+[git-debrebase: split mixed commit, upstream-part]
+[git-debrebase: convert dgit import, debian changes]
+[git-debrebase breakwater: convert dgit import, upstream changes]
 
-[git-debrebase new-upstream combine . [PIECES...]]
-[git-debrebase new-upstream breakwater NEW-UPSTREAM-VERSION]
-[git-debrebase new-upstream changelog NEW-UPSTREAM-VERSION]
+[git-debrebase upstream-combine . PIECE[ PIECE...]: new upstream]
+[git-debrebase breakwater: new upstream NEW-UPSTREAM-VERSION, merge]
+[git-debrebase: new upstream NEW-UPSTREAM-VERSION, changelog]
 
-[git-debrebase gbp2debrebase drop-patches]
-[git-debrebase declare-upstream breakwater]
+[git-debrebase: gbp2debrebase, drop patches]
+[git-debrebase breakwater: declare upstream]
 
 m{^\[git-debrebase (?:\w*-)?upstream combine \.((?: $extra_orig_namepart_re)+)\]}
 
index 88118aa..87928bc 100755 (executable)
@@ -492,10 +492,11 @@ 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 {
@@ -628,7 +629,8 @@ sub walk ($;$$) {
                    push @brw_cl, {
                        %$cl,
                        SpecialMethod => 'DgitImportUpstreamUpdate',
-                       $xmsg->("convert dgit import: upstream changes")
+                       $xmsg->("convert dgit import: upstream changes",
+                               " breakwater")
                    };
                }
                $prline->(" Import");
@@ -876,7 +878,7 @@ sub cmd_new_upstream_v0 () {
 
     if ($old_upstream->{Msg} =~ m{^\[git-debrebase }m) {
        if ($old_upstream->{Msg} =~
- m{^\[git-debrebase (?:\w*-)?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} };
@@ -886,7 +888,7 @@ sub cmd_new_upstream_v0 () {
            }
        } else {
            fproblem "previous upstream $old_upstream->{CommitId} is from".
-                 " git-debrebase but not an \`upstream combine' commit";
+                 " git-debrebase but not an \`upstream-combine' commit";
        }
     }
 
@@ -930,9 +932,9 @@ 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]"),
                 ];
        }
 
@@ -945,7 +947,7 @@ sub cmd_new_upstream_v0 () {
        # index now contains the breakwater 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 breakwater: new upstream $new_upstream_version, merge]",
             ];
 
        # Now we have to add a changelog stanza so the Debian version
@@ -973,7 +975,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]",
             ];
     };
 
@@ -1035,14 +1037,14 @@ sub cmd_gbp2debrebase () {
        $work = make_commit ['HEAD'], [
  'git-debrebase import: drop patch queue',
  'Delete debian/patches, as part of converting to git-debrebase format.',
- '[git-debrebase gbp2debrebase drop-patches]'
+ '[git-debrebase: gbp2debrebase, drop patches]'
                              ];
        # make the breakwater pseudomerge
        # the tree is already exactly right
        $work = make_commit [$work, $upstream], [
  'git-debrebase import: declare upstream',
  'First breakwater merge.',
- '[git-debrebase declare-upstream breakwater]'
+ '[git-debrebase breakwater: declare upstream]'
                              ];
 
        # rebase the patch queue onto the new breakwater