dgit: quilt_fixup_dpkgsource_singlepatch: Add bug commentary

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

1 files changed, 9 insertions, 0 deletions

diff --git a/dgit b/dgit
index 9f1cb66..fd0a852 100755
--- a/dgit
+++ b/dgit
@@ -6042,6 +6042,15 @@ sub quilt_fixup_dpkgsource_singlepatch ($$$) {
     # get it to generate debian/patches/debian-changes, it is
     # necessary to build the source package.
 
+    # We "trust" dpkg-source to get this right, and in particular, to
+    # complain about things it can't represent.  However, this is not
+    # always the case.  See the test cases in tests/tests/unrepresentable
+    # which have as outcome "LATE-EP:...".  When this happens, quilt fixup
+    # succeeds and dgit push fails.  This is one of the reasons we
+    # deprecate this in the docs.  In principle, we could do better by
+    # rejecting these situations earlier, but we would need another
+    # lot of recapitulation of dpkg-source behaviours.
+
     unpack_playtree_linkorigs($upstreamversion, sub { });
     unpack_playtree_need_cd_work($headref);