chiark / gitweb /
po/list-documents: Set translation threshold to 10%
[dgit.git] / NOTES.git-debrebase
index 32e5edf..bd6e715 100644 (file)
@@ -1,77 +1,34 @@
-TODO
-   reference docs
-      git-debrebase(5)   data model
-      git-debrebase(1)   command line
-   tutorial
-      dgit-maint-debrebase(7)
-      someone should set branch.<name>.mergeOptions to include --ff-only ?
+# problems / outstanding questions:
+#
+#  * new-upstream has an awkward UI for multiple upstream pieces.
+#    You end up with giant runic command lines.  Does this matter /
+#    One consequence of the lack of richness it can need -f in
+#    fairly sensible situations.
+#
+#  * There should be a good 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.
+#
+#  * 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?
+#    maybe the hypothetical git-ffqrebase is part of it too.
+       
+
+# undocumented usages:
+#
+#    git-debrebase [<options>] downstream-rebase-launder-v0  # experimental
 
-   clean up remains of NOTES and README
-
-   arrange for dgit to automatically stitch on push
-
-========================================
-
-#  refs/ffq-prev/REF    relates to refs/REF
-
-=======================================
-
-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 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]
-
-m{^\[git-debrebase (?:\w*-)?upstream combine \.((?: $extra_orig_namepart_re)+)\]}
-
-Every anchor commit must be a merge.  In principle, this is not
-necessary.  After all, 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.
-
-=======================================
-
-workflow
-
-  git-debrebase blah [implies start]       strips pseudomerge(s)
-
-  commit / git-debrebase / etc.
-
-  dgit --damp-run push
-      hook: call git-debrebase prep-push   dgit push does not update remote
-      or something, must add patches at least
-
-  commit / git-debrebase / etc.            strips patches
-
-  dgit push
-      hook: call git-debrebase prep-push   dgit push DOES update remote
-
-  commit / git-debrebase / etc.            strips last pm, but arranges
-                                           that remade pm will incorporate it
 
 ========================================
 
 Theory for ffq-prev
 
+  refs/ffq-prev/REF    relates to refs/REF
+
 When we strip a pm, we need to maybe record it (or something) as the
 new start point.
 
@@ -121,67 +78,6 @@ When we do a thing
 
 We check we are ff from remotes before recording new ffq-prev
 
-  ---------- now follows much the same info in different words ----------
-
-1. git-debrebase [-i etc.]
-
-     should:
-        check for ffq-prev
-        if is already a ffq-prev, fine, do no more
-        if not:
-
-        check our origin branch exists and we are ff from it
-        if not fail
-
-        check our other might-be-pushed to branches
-        check we are ff from them
-        if not fail
-
-        set ffq-prev to something which is ff from
-          all above branches
-
-        we use our tip, as discussed above
-        (optionally, can use some other commit which is ff
-         from all of the above, eg one of them)
-
-N. git-debrebase [--noop-ok] record-ffq-prev
-
-     does what is described above
-
-2. git-debrebase [--noop-ok] stitch
-
-    makes pseudomerge with ffq-prev
-    deletes ffq-prev
-
-    we will teach dgit to do
-       git-debrebase stitch
-
-3. git-debrebase push
-
-    like git push only does stitch first
-    ??? command line parsing!
-
-4. git-debrebase release
-
-    stiches, finalises changelog, signs tags, pushes everything
-    for the future, when there is some automatic builder
-
-ffq-prev for each ref
-    refs/heads/FOO
-is
-    refs/ffq-prev/FOO
-
-========================================
-
-import from gbp
-
-what about dgit view branch ?
-ideally, would make pseudomerge over dgit view
-would need to check that dgit view is actually dgit view of
-  ond of our ancestors
-failing that first push will need --overwrite
-that is what is currently implemented
-
 ========================================
 
 how to handle divergence and merges (if not detected soon enough)
@@ -224,6 +120,8 @@ current avaiable strategies:
 
 ========================================
 
+For downstreams of Debian, sketch of git-ffqrebase
+
 #    git-ffqrebase start [BASE]
 #                # records previous HEAD so it can be overwritten
 #                # records base for future git-ffqrebase