git-debrebase: do not add -i in default invocation

[dgit.git] / NOTES.git-debrebase

diff --git a/NOTES.git-debrebase b/NOTES.git-debrebase
index 6510c6ec0c294ec554e61e9d1bec8f5dcb2620bd..8aed2ff28887803b6481e75e4a2997ca59221a65 100644 (file)
--- a/NOTES.git-debrebase
+++ b/NOTES.git-debrebase
@@ -8,9 +8,7 @@
 #    git-ffqrebase finish
 #    git-ffqrebase status [BRANCH]
 #
 #    git-ffqrebase finish
 #    git-ffqrebase status [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
+#  refs/ffq-prev/REF    relates to refs/REF

 #
 # git-debrebase without start, if already started, is willing
 # to strip pseudomerges provided that they overwrite exactly
 #
 # git-debrebase without start, if already started, is willing
 # to strip pseudomerges provided that they overwrite exactly


@@ -30,21 +28,35 @@
 =========
 
 special commit tags
 =========
 
 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)+)\]}
 
 
 m{^\[git-debrebase (?:\w*-)?upstream combine \.((?: $extra_orig_namepart_re)+)\]}
 

+Every breakwater commit must be a merge.  In principle, this is not
+necessary.  After all, we are relying on the
+    [git-debrebase breakwater: ...]
+commit message annotation in "declare" breakwater merges (which
+do not have any upstream changes), to distinguish those breakwater
+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 a breakwater base commit.  git-rebase
+trips up on merges, so that is a useful safety catch.
+
+

 =========
 
 workflow
 =========
 
 workflow


@@ -160,8 +172,72 @@ so that the overall result will be series of pseudomerges.
 
 ========================================
 
 
 ========================================
 

+So, pm handling specifics:
+
+strategy is to avoid making needless pseudomerges
+pseudomerges that exist will be preserved
+(by being included in will-overwrite)
+
+This is good because the presence of a pseudomerge means we know we
+want to keep it; and that allows explicit control over history detail
+level.
+
+It does mean we must avoid making the pseudomerges unnecessarily.
+They should be made just before (ideally, part of) dgit push.
+
+1. git-debrebase [-i etc.]
+
+     should:
+        check for will-overwrite
+        if is already a will-overwrite, 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 will-overwrite 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 will-overwrite
+    deletes will-overwrite
+
+    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
+
+will-overwrite for each ref
+    refs/heads/FOO
+is
+    refs/ffq-prev/FOO
+
+========================================
+

 import from gbp
 
 import from gbp
 

+[ all this is done now:

  inputs:
    current HEAD (patches-unapplied),
      this is going to be the base of the old breakwater
  inputs:
    current HEAD (patches-unapplied),
      this is going to be the base of the old breakwater


@@ -180,9 +256,13 @@ import from gbp
        commit to remove d/patches
        breakwater pseudomerge with upstream
        "rebase" of pq branch, each commit with d/patches stripped
        commit to remove d/patches
        breakwater pseudomerge with upstream
        "rebase" of pq branch, each commit with d/patches stripped

+]

 
 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
 
 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

+
+should this be called import or gbp2debrebase as it is now ?
+gbp uses "import" oddly but I'm tempted to use it normally here.