chiark / gitweb /
dgit: Break out @forbid in check_not_dirty
[dgit.git] / dgit.7
diff --git a/dgit.7 b/dgit.7
index 0d43ee0d7f70f668156718bd40ab662b690ea53c..d625e8fcbbc32c8a731867a8808e932d7143ff55 100644 (file)
--- a/dgit.7
+++ b/dgit.7
@@ -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,7 +294,7 @@ 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 commiting to source files
+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,
@@ -298,7 +308,8 @@ 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.
+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:
@@ -376,6 +387,12 @@ 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 QUILT MODE
 When working with git branches intended
 for use with the `3.0 (quilt)' source format
@@ -430,7 +447,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