chiark / gitweb /
changelog: start 9.14
[dgit.git] / dgit.7
diff --git a/dgit.7 b/dgit.7
index 7ad5abaee9446462544d85cdd3fb89452783a3d8..d1e5c7ea579309a047ac495e1cef8da3256fd80b 100644 (file)
--- a/dgit.7
+++ b/dgit.7
@@ -161,7 +161,7 @@ or to try to upload to it.
 
 When using this facility, it is important to always specify the
 same suites in the same order:
-dgit will not be make a coherent fast-forwarding history
+dgit will not make a coherent fast-forwarding history
 view otherwise.
 
 The history generated by this feature is not normally suitable
@@ -249,6 +249,16 @@ See
 and
 .B dgit setup-gitattributes
 in dgit(1).
+
+Note that dgit does not disable gitattributes
+unless they would actually interfere with your work on dgit branches.
+In particular, gitattributes which affect
+.B git archive
+are not disabled,
+so .origs you generate by hand can be wrong.
+You should consider using
+.B git-deborig (1)
+which gets this right, suppressing the attributes.
 .SH PACKAGE SOURCE FORMATS
 If you are not the maintainer, you do not need to worry about the
 source format of the package.  You can just make changes as you like
@@ -284,6 +294,13 @@ pushing.  The only thing you need to know is that dgit build, sbuild,
 etc., may make new commits on your HEAD.  If you're not a quilt user
 this commit won't contain any changes to files you care about.
 
+Simply committing to source files
+(whether in debian/ or not, but not to patches)
+will result in a branch that dgit quilt-fixup can linearise.
+Other kinds of changes,
+including editing patches or merging,
+cannot be handled this way.
+
 You can explicitly request that dgit do just this fixup, by running
 dgit quilt-fixup.
 
@@ -291,8 +308,92 @@ If you are a quilt user you need to know that dgit's git trees are
 `patches applied packaging branches' and do not contain the .pc
 directory (which is used by quilt to record which patches are
 applied).  If you want to manipulate the patch stack you probably want
-to be looking at tools like git-dpm.
-.SH SPLIT VIEW QUILT MODE
+to be looking at tools like
+git-debrebase, gbp pq, or git-dpm.
+
+.SS quilt fixup error messages
+When dgit's quilt fixup fails, it prints messages like this:
+
+.EX
+dgit: base trees orig=5531f03d8456b702eab6 o+d/p=135338e9cc253cc85f84
+dgit: quilt differences: src:  == orig ##     gitignores:  == orig ##
+dgit: quilt differences:      HEAD ## o+d/p               HEAD ## o+d/p
+starting quiltify (multiple patches, linear mode)
+
+dgit: error: quilt fixup cannot be linear.  Stopped at:
+dgit:  696c9bd5..84ae8f96: changed debian/patches/test-gitignore
+.EE
+
+.TP
+.B orig
+is an import of the .orig tarballs dgit found,
+with the debian/ directory from your HEAD substituted.
+This is a git tree object, not a commit:
+you can pass its hash to git-diff but not git-log.
+
+.TP
+.B o+d/p
+is another tree object,
+which is the same as orig
+but with the patches from debian/patches applied.
+
+.TP
+.B HEAD
+is of course your own git HEAD.
+
+.TP
+.B quilt differences
+shows whether each of the these trees differs from the others
+(i) in upstream files excluding .gitignore files;
+(ii) in upstream .gitignore files.
+.B ==
+indicates equality;
+.B ##
+indicates inequality.
+.LP
+dgit quilt-fixup --quilt=linear walks commits
+backwards from your HEAD
+trying to construct a linear set of additional patches,
+starting at the end.
+It hopes to eventually find an ancestor
+whose tree is identical to o+d/p in all upstream files.
+
+In the error message,
+696c9bd5..84ae8f96
+is the first commit child-parent edge
+which cannot sensibly be
+either ignored, or turned into a patch in debian/patches.
+In this example, this is because
+it itself changes files in debian/patches,
+indicating that something unusual is going on
+and that continuing is not safe.
+But you might also see other kinds of troublesome commit or edge.
+
+Your appropriate response depends on the cause and the context.
+If you have been freely merging your git branch
+and do not need need a pretty linear patch queue,
+you can use
+.B --quilt=smash
+(or use the
+.B 1.0
+or
+.B single-debian-patch
+source formats; see
+.BR dpkg-source(1) .)
+If you want a pretty linear series,
+and this message is unexpected,
+it can mean that you have unwittingly committed changes
+that are not representable by dpkg-source (such as some mode changes).
+Or maybe you just forgot a necessary
+.B --quilt=
+option.
+
+Finally,
+this problem can occur if you have provided
+Debian git tooling such as git-debrebase, git-dpm or git-buildpackage
+with upstream git commit(s) or tag(s)
+which are not 100% identical to your orig tarball(s).
+.SH SPLIT VIEW AND SPLITTING QUILT MODES
 When working with git branches intended
 for use with the `3.0 (quilt)' source format
 dgit can automatically convert a suitable
@@ -300,21 +401,33 @@ maintainer-provided git branch
 (in one of a variety of formats)
 into a dgit branch.
 
-When a split view mode is engaged
+When a splitting quilt mode is selected
 dgit build commands and
 dgit push
 will, on each invocation,
 convert the user's HEAD into the dgit view,
 so that it can be built and/or uploaded.
 
-dgit push in split view mode will push the dgit view to the dgit
+Split view mode can also be enabled explicitly
+with
+the --split-view command line option
+and
+the .split-view access configuration key.
+
+When split view is in operation,
+regardless of the quilt mode,
+any dgit-generated pseudomerges
+and any quilt fixup commits
+will appear only in the dgit view.
+dgit push
+will push the dgit view to the dgit
 git server.
 The dgit view is always a descendant of the maintainer view.
 dgit push will also make a maintainer view tag
 according to DEP-14
 and push that to the dgit git server.
 
-Split view mode must be enabled explicitly
+Splitting quilt modes must be enabled explicitly
 (by the use of the applicable command line options,
 subcommands, or configuration).
 This is because it is not possible to reliably tell
@@ -346,7 +459,7 @@ As the maintainer you therefore have the following options:
 Delete the files from your git branches,
 and your Debian source packages,
 and carry the deletion as a delta from upstream.
-(With `3.0 (quilt)' this means represeting the deletions as patches.
+(With `3.0 (quilt)' this means representing the deletions as patches.
 You may need to pass --include-removal to dpkg-source --commit,
 or pass corresponding options to other tools.)
 This can make the Debian