exit status: Fix dgit-badcommit-fixup to use Debian::Dgit::ExitStatus

[dgit.git] / git-debrebase.5.pod

diff --git a/git-debrebase.5.pod b/git-debrebase.5.pod
index d3ecda88242e2c33b9484426a042708fe14fbd6c..5cfa3761080eb5c6accffa98cfd6682b72cbffa0 100644 (file)
--- a/git-debrebase.5.pod
+++ b/git-debrebase.5.pod
@@ -80,6 +80,18 @@ Not used, often deleted, and regenerated when needed
 (such as when uploading to Debian),
 by git-debrebase.
 
+=item Interchange branch; breakwater; stitched; laundered
+
+See L</BRANCHES AND BRANCH STATES - OVERVIEW>.
+
+=item Anchor; Packaging
+
+See L</BRANCH CONTENTS - DETAILED SPECIFICATION>.
+
+=item ffq-prev; debrebase-last
+
+See L</STITCHING, PSEUDO-MERGES, FFQ RECORD>.
+
 =back
 
 =head1 DIAGRAM
@@ -95,9 +107,9 @@ by git-debrebase.
          1        1          1    breakwater branch, merging baseline
         /        /          /     unmodified upstream code
     ---@-----@--A----@--B--C      plus debian/ (but no debian/patches)
-      /     /       /                    no ref refers to this: we
+      /     /       /                     no ref refers to this: we
    --#-----#-------#-----> upstream        reconstruct its identity by
-                                          inspecting interchange branch
+                                           inspecting interchange branch
     Key:
 
       1,2,3   commits touching upstream files only
@@ -111,7 +123,7 @@ by git-debrebase.
      -/-      pseudomerge; contents are identical to
      /         parent lower on diagram.
 
-      %       dgit-generated commit of debian/patches.
+      %       dgit- or git-debrebase- generated commit of debian/patches.
               `3.0 (quilt)' only; generally dropped by git-debrebase.
 
       *       Maintainer's HEAD was here while they were editing,
@@ -489,6 +501,7 @@ The full set of annotations is:
   [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: export and commit patches]
 
   [git-debrebase convert-from-gbp: drop patches]
   [git-debrebase anchor: declare upstream]
@@ -506,9 +519,14 @@ when git-debrebase rewrites the commit.
 
 =head1 APPENDIX - DGIT IMPORT HANDLING
 
+The dgit .dsc import format is not documented or specified
+(so some of the following terms are not defined anywhere).
+The dgit import format it is defined by the implementation in dgit,
+of which git-debrebase has special knowledge.
+
 Consider a non-dgit NMU followed by a dgit NMU:
 
-            interchange --/--B3!--%--/----D*-->
+            interchange --/--B3!--%--//----D*-->
                          /          /
                         %          4
                        /          3
@@ -519,21 +537,22 @@ Consider a non-dgit NMU followed by a dgit NMU:
                   1          0 00 =XBC%
                  /
                 /
-                 --@--A     breakwater
-          /
-       --#--------> upstream
+          --@--A     breakwater
+           /
+        --#--------> upstream
 
 
  Supplementary key:
 
     =XBC%     dgit tarball import of .debian.tar.gz containing
-              Debian packaging including changes B C and quilt patches
-
+               Debian packaging including changes B C and quilt patches
     0         dgit tarball import of upstream tarball
-    00        dgit tarball import of supplementary upstream tarball
-    &_        dgit nearly-breakwater import
+    00        dgit tarball import of supplementary upstream piece
+    &_        dgit import nearly-breakwater-anchor
+    //        dgit fetch / import-dsc pseudomerge to make fast forward
+
     &'        git-debrebase converted import (upstream files only)
-    D'        git-debrebase converted debian/ changes import
+    C'        git-debrebase converted packaging change import
 
     * **      before and after HEAD
 
@@ -544,43 +563,43 @@ We want to transform this into:
 =item I. No new upstream version
 
  (0 + 00 eq #)
-                        --/--B3!--%--/------D*-------------/-->
-                         /          /                    /
-                        %          4                    4**
-                       /          3                    3
-                      /          2                    2
-                     /          1                    1
-                    2          &_                   /
-                   /          /| \                 /
+                        --/--B3!--%--//-----D*-------------/-->
+                         /          /                     /
+                        %          4                     4**
+                       /          3                     3
+                      /          2                     2
+                     /          1                     1
+                    2          &_                    /
+                   /          /| \                  /
                   1          0 00 =XBC%            /
-                 /                                       /
-                /                                       /
-         --@--A-----B-----------------------C--D
-          /
-       --#----------------------------------------->
+                 /                                /
+                /                                /
+          --@--A-----B---------------------C'---D
+           /
+        --#----------------------------------------->
 
 =item II. New upstream
 
  (0 + 00 neq #)
 
-                        --/--B3!--%--/------D*-------------/-->
-                         /          /                    /
-                        %          4                    4**
-                       /          3                    3
-                      /          2                    2
-                     /          1                    1
-                    2          &_                   /
-                   /          /| \                 /
+                        --/--B3!--%--//-----D*-------------/-->
+                         /          /                     /
+                        %          4                     4**
+                       /          3                     3
+                      /          2                     2
+                     /          1                     1
+                    2          &_                    /
+                   /          /| \                  /
                   1          0 00 =XBC%            /
-                 /                               /
-                /                               /
-         --@--A-----B--------------------@--C--D
-          /                             /
-       --#----------------------- - -  /  - - ----->
-                                      /
-                                     &'
-                                    /|
-                                   0 00
+                 /                                /
+                /                                /
+          --@--A-----B-----------------@---C'---D
+           /                          /
+        --#--------------------- - - / - - --------->
+                                    /
+                                   &'
+                                  /|
+                                 0 00
 
 =back