git-debrebase: some NOTES

[dgit.git] / NOTES.git-debrebase

diff --git a/NOTES.git-debrebase b/NOTES.git-debrebase
index 4d7cf20f26912c40babad44d646d5832b31612f5..cd0decba5c05cf7ca3f59f93def6712595465b76 100644 (file)
--- a/NOTES.git-debrebase
+++ b/NOTES.git-debrebase
@@ -1,5 +1,13 @@
+TODO
+   more tests, see "todo" in gdr-editw
+   reference docs
+      git-debrebase(5)   data model
+      git-debrebase(1)   command line
+   tutorial
+      dgit-maint-debrebase(7)
+
+   clean up remains of NOTES and README
 
-#
 #    git-ffqrebase start [BASE]
 #                # records previous HEAD so it can be overwritten
 #                # records base for future git-ffqrebase
@@ -8,9 +16,7 @@
 #    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
@@ -44,6 +50,7 @@ overall format
 
 [git-debrebase: gbp2debrebase, drop patches]
 [git-debrebase breakwater: declare upstream]
+[git-debrebase pseudomerge: stitch]
 
 m{^\[git-debrebase (?:\w*-)?upstream combine \.((?: $extra_orig_namepart_re)+)\]}
 
@@ -174,6 +181,69 @@ 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
 
 [ all this is done now:
@@ -202,3 +272,6 @@ 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.