gbp options: Document

[dgit.git] / dgit.1

diff --git a/dgit.1 b/dgit.1
index 87ad0fce4b8f589f38ec85d378567d632cf9ffca..0659562796a5e66b754a63a520ac6b0d58969825 100644 (file)
--- a/dgit.1
+++ b/dgit.1
@@ -330,6 +330,38 @@ This can be useful with build, if you plan to commit later.  (dgit
 push will still ensure that the .dsc you upload and the git tree
 you push are identical, so this option won't make broken pushes.)
 .TP
+.BR --overwrite =\fIprevious-version\fR
+Declare that even though your git branch is not a descendant
+of the version in the archive
+according to the revision history,
+it really does contain
+all the (wanted) changes from that version.
+
+This option is useful if you are the maintainer, and you have
+incorporated NMU changes into your own git workflow in a way that
+doesn't make your branch a fast forward from the NMU.
+
+.I previous-version
+ought to be the version currently in the archive.  If
+.I previous-version
+is not
+specified, dgit will check that the version in the archive is
+mentioned in your debian/changelog.
+(This will avoid losing
+changes unless someone committed to git a finalised changelog
+entry, and then made later changes to that version.)
+
+dgit push --overwrite
+will make a
+pseudo-merge (that is, something that looks like the result
+of git merge -s ours) to stitch the archive's version into your own
+git history, so that your push is a fast forward from the archive.
+
+(In quilt mode
+.BR gbp ", " dpm " or " unpatched ,
+implying a split between the dgit view and the
+maintainer view, the pseudo-merge will appear only in the dgit view.)
+.TP
 .BI --deliberately- something
 Declare that you are deliberately doing
 .IR something .
@@ -430,18 +462,40 @@ Specifies alternative programs to use instead of
 .BR ssh ,
 .BR dgit ,
 .BR git ,
+.BR gbp-pq ,
+.BR gbp-build ,
 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.
 
-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=).
 
-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
@@ -467,6 +521,8 @@ Specifies a single additional option to pass to
 .BR sbuild ,
 .BR ssh ,
 .BR dgit ,
+.BR gbp-pq ,
+.BR gbp-build ,
 or
 .BR mergechanges .
 Can be repeated as necessary.
@@ -619,14 +675,17 @@ archive and record it in the
 tracking branch.  Then somehow, using your other git history
 plus appropriate diffs and cherry picks from the dgit remote tracking
 branch, construct a git commit whose tree corresponds to the tree to use for the
-next upload.  If that commit-to-be-uploaded is not a descendant of the
-dgit remote tracking branch, check it out and say
-.BR "git merge -s ours remotes/dgit/dgit/" \fIsuite\fR;
-that tells git that we are deliberately throwing away any differences
+next upload. 
+
 between what's in the archive and what you intend to upload.
 Then run
 .BR "dgit push"
 to actually upload the result.
+
+If the commit-to-be-uploaded is not a descendant of the
+dgit remote tracking branch, you will need to pass
+.B --overwrite
+to dgit.
 .SH CONFIGURATION
 dgit can be configured via the git config system.
 You may set keys with git-config (either in system-global or per-tree