chiark / gitweb /
git-debrebase(5): minor improvements
[dgit.git] / git-debrebase
index cdd6348a122efc405a6de50d3338d6b1356da12d..9d87e76760ce866c717e0962fdec78868652bc4f 100755 (executable)
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-
-# usages:
-#
-#    git-debrebase [<options>] new-upstream-v0 \
-#             <new-version> [<orig-commitish> \
-#            [<extra-orig-name> <extra-orig-commitish> ...] \
-#            [<git-rebase options>...]]
-#
-#    git-debrebase [<options> --] [<git-rebase options...>]
-#    git-debrebase [<options>] analyse
-#    git-debrebase [<options>] breakwater      # prints breakwater tip only
-#    git-debrebase [<options>] stitch [--prose=<for commit message>]
-#    git-debrebase [<options>] launder-v0      # prints breakwater tip etc.
-#    git-debrebase [<options>] downstream-rebase-launder-v0  # experimental
-#
-#    git-debrebase [<options>] convert-from-gbp [<upstream-git-rev>]
-#    git-debrebase [<options>] 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);
@@ -438,6 +378,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");