diff options
author | Ian Jackson <ijackson@chiark.greenend.org.uk> | 2018-02-18 22:46:58 +0000 |
---|---|---|
committer | Ian Jackson <ijackson@chiark.greenend.org.uk> | 2018-06-16 16:06:59 +0100 |
commit | b822b6c13035de35290d03c497fdbd72560e3d34 (patch) | |
tree | e9ef0965444be132fc6d85b2a8c540dcb2ec7d7d /git-debrebase.5.pod | |
parent | 4d17885419daca2127f870a06503ec5643d0f626 (diff) |
git-debrebase(5): Document commit message annotations
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
Diffstat (limited to 'git-debrebase.5.pod')
-rw-r--r-- | git-debrebase.5.pod | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/git-debrebase.5.pod b/git-debrebase.5.pod index 6fc1ae5..6d61baa 100644 --- a/git-debrebase.5.pod +++ b/git-debrebase.5.pod @@ -352,6 +352,42 @@ in B<debian/patches/>. =back +=head1 COMMIT MESSAGE ANNOTATIONS + +git-debrebase makes annotations +in the messages of commits it generates. + +The general form is + + [git-debrebase[ COMMIT-TYPE [ ARGS...]]: PROSE, MORE PROSE] + +git-debrebase does not pay attention to anything after the colon, +so PROSE is ignored. + +The full set of annotations is: + [git-debrebase: split mixed commit, debian part] + [git-debrebase: split mixed commit, upstream-part] + [git-debrebase: convert dgit import, debian changes] + [git-debrebase anchor: convert dgit import, upstream changes] + + [git-debrebase upstream-combine . PIECE[ PIECE...]: new upstream] + [git-debrebase anchor: new upstream NEW-UPSTREAM-VERSION, merge] + [git-debrebase: new upstream NEW-UPSTREAM-VERSION, changelog] + + [git-debrebase convert-from-gbp: drop patches] + [git-debrebase anchor: declare upstream] + [git-debrebase pseudomerge: stitch] + + [git-debrebase convert-to-gbp: commit patches] + +Only anchor merges have the C<[git-debrebase anchor: ...]> tag. +Single-parent anchors are not generated by git-debrebase, +and when made manually should not be tagged. + +The C<split mixed commit> and C<convert dgit import> +tags are added to the pre-existing commit message, +when git-debrebase rewrites the commit. + =head1 TERMINOLOGY =over |