dgit.1: Document --quilt=gbp et al.

[dgit.git] / dgit.1

diff --git a/dgit.1 b/dgit.1
index 39edaaaf6802f07e2c4f7e799c8f3ea6eeb588a3..b3a4f9392be39fac79845503c5295aa5eda7c4d7 100644 (file)
--- a/dgit.1
+++ b/dgit.1
@@ -419,6 +419,54 @@ Do not check whether up source format `3.0 (quilt)' metadata needs
 fixing up.  If you use this option and the metadata did in fact need
 fixing up, dgit push will fail.
 .TP
 fixing up.  If you use this option and the metadata did in fact need
 fixing up, dgit push will fail.
 .TP

+.BR --quilt=gbp " | " --quilt=dpm " | " --quilt=unapplied
+Tell dgit that you are using a nearly-dgit-compatible git branch,
+aka a
+.BR "maintainer view" ,
+and
+do not want your branch changed by dgit.
+
+.B --quilt=gbp
+is for use with git-buildpackage.
+Your HEAD is expected to be
+a patches-unapplied git branch, except that it might contain changes
+to upstream .gitignore files.
+
+.B --quilt=dpm
+is for use with git-dpm.
+Your HEAD is expected to be
+a patches-applied git branch,
+except that it might contain changes to upstream .gitignore files.
+
+.B --quilt=unapplied
+specifies that your HEAD is a patches-unapplied git branch (and
+that any changes to upstream .gitignore files are represented as
+patches in debian/patches).
+
+Instead, dgit quilt-fixup and dgit-push will automatically
+convert your git branch into the right form,
+and dgit push will push the
+dgit-compatible form (the
+.BR "dgit view" )
+to the dgit git server.
+The dgit view will be visible to you
+in the dgit remote tracking branches, but your own branch will
+not be modified.
+dgit will create a tag
+.BI debian/ version
+for the maintainer view, and the dgit tag
+.BI archive/debian/ version
+for the dgit view.
+
+.B If you have a branch like this it is essential to specify the appropriate --quilt= option!
+This is because it is not always possible to tell: a patches-unapplied
+git branch of a package with one patch, for example, looks just the
+same as a patches-applied branch where the user has used git revert to
+undo the patch, expecting to actually revert it.
+If you fail to specify the right \-\-quilt option,
+and you aren't too lucky, dgit will notice the problem and stop,
+with a useful hint. 
+.TP

 .BI -D
 Prints debugging information to stderr.  Repeating the option produces
 more output (currently, up to -DDDD is meaningfully different).
 .BI -D
 Prints debugging information to stderr.  Repeating the option produces
 more output (currently, up to -DDDD is meaningfully different).


@@ -462,18 +510,40 @@ Specifies alternative programs to use instead of
 .BR ssh ,
 .BR dgit ,
 .BR git ,
 .BR ssh ,
 .BR dgit ,
 .BR git ,

+.BR gbp-pq ,
+.BR gbp-build ,

 or
 .BR mergechanges .
 
 or
 .BR mergechanges .
 

-For dpkg-buildpackage, dpkg-genchanges, mergechanges and sbuild,
+For
+.BR dpkg-buildpackage ,
+.BR dpkg-genchanges ,
+.B mergechanges
+and
+.BR sbuild ,

 this applies only when the program is invoked directly by dgit.
 
 this applies only when the program is invoked directly by dgit.
 

-For dgit, specifies the command to run on the remote host when dgit
+For
+.BR dgit ,
+specifies the command to run on the remote host when dgit

 rpush needs to invoke a remote copy of itself.  (dgit also reinvokes
 itself as the EDITOR for dpkg-source --commit; this is done using
 argv[0], and is not affected by --dgit=).
 
 rpush needs to invoke a remote copy of itself.  (dgit also reinvokes
 itself as the EDITOR for dpkg-source --commit; this is done using
 argv[0], and is not affected by --dgit=).
 

-For ssh, the default value is taken from the
+.BR gbp-build 's
+value
+is used instead of gbp build or git-buildpackage.  (The default is
+the latter unless the former exists on PATH.)
+.BR gbp-pq 's
+value
+is used instead of gbp pq.
+In both cases,
+unusually, the specified value is split on whitespace
+to produce a command and possibly some options and/or arguments.
+
+For
+.BR ssh ,
+the default value is taken from the

 .B DGIT_SSH
 or
 .B GIT_SSH
 .B DGIT_SSH
 or
 .B GIT_SSH


@@ -499,6 +569,8 @@ Specifies a single additional option to pass to
 .BR sbuild ,
 .BR ssh ,
 .BR dgit ,
 .BR sbuild ,
 .BR ssh ,
 .BR dgit ,

+.BR gbp-pq ,
+.BR gbp-build ,

 or
 .BR mergechanges .
 Can be repeated as necessary.
 or
 .BR mergechanges .
 Can be repeated as necessary.