dgit(1): document new pbuilder and cowbuilder subcommands

[dgit.git] / dgit.1

diff --git a/dgit.1 b/dgit.1
index 67aa2fab65c2785091ae5847dfb110225f03d2b0..2976e136305c57a7d03006817d420b0a01b3e56e 100644 (file)
--- a/dgit.1
+++ b/dgit.1
@@ -17,6 +17,10 @@ dgit \- git integration with the Debian archive
 [\fIbuild\-opts\fP]
 .br
 .B dgit
+[\fIdgit\-opts\fP] \fBpbuilder\fP|\fBcowbuilder\fP
+[\fIdebbuildopts\fP]
+.br
+.B dgit
 [\fIdgit\-opts\fP] \fBpush\fP|\fBpush-source\fP [\fIdgit\-opts\fP]
 [\fIsuite\fP]
 .br
@@ -46,6 +50,7 @@ dgit-maint-debrebase(7)       for maintainers: a pure-git rebasish workflow
 dgit-maint-merge(7)    for maintainers: a pure-git merging workflow
 dgit-maint-gbp(7)      for maintainers already using git-buildpackage
 dgit-sponsorship(7)    for sponsors and sponsored contributors
+dgit-downstream-dsc(7) setting up dgit push for a new distro
 .TE
 .LP
 See \fBdgit(7)\fP for detailed information about the data
@@ -193,6 +198,34 @@ You probably want to pass -A, to request those.
 .IP
 Tagging, signing and actually uploading should be left to dgit push.
 .TP
+\fBdgit pbuilder\fR [\fIdebbuildopts\fP]
+Like \fBdgit sbuild\fR, but uses
+.B pbuilder
+instead of
+.BR sbuild ,
+and builds arch-independent packages by default.
+
+You should ensure that your dgit --build-products-dir setting matches
+your pbuilder --buildresult.
+
+The \fIdebbuildopts\fP are passed to pbuilder using its --debbuildopts
+option.  If you want to pass other options to pbuilder, use the
+\fB--pbuilder:\fR dgit option as described below
+(recalling that dgit options should appear between \fBdgit\fR and
+\fBpbuilder\fR).
+
+You should ensure that in your pbuilderrc you do
+.B not
+have the setting
+.B SOURCE_ONLY_CHANGES=yes
+as this may cause trouble.
+.TP
+\fBdgit cowbuilder\fR [\fIdebbuildopts\fP]
+Like \fBdgit pbuilder\fR, but uses
+.B cowbuilder
+instead of
+.B pbuilder.
+.TP
 \fBdgit gbp-build\fR ...
 Runs
 .B git-buildpackage
@@ -528,12 +561,17 @@ refuse to push.  It may (for Debian, will) be unable to access the git
 history for any packages which have been newly pushed and have not yet
 been published.
 .TP
-.BR --ignore-dirty
-Do not complain if the working tree does not match your git HEAD.
+.BR --include-dirty
+Do not complain if the working tree does not match your git HEAD,
+and when building,
+include the changes from your working tree.
 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 --ignore-dirty
+Deprecated alias for --include-dirty.
+.TP
 .BR --overwrite [=\fIprevious-version\fR]
 Declare that your HEAD really does contain
 all the (wanted) changes
@@ -841,6 +879,11 @@ regardless of this option.
 Specifies where to find the built files to be uploaded.
 By default, dgit looks in the parent directory
 .RB ( .. ).
+
+Also see the
+.BI dgit.default.build-products-dir
+configuration option
+(which this command line option overrides).
 .TP
 .BI --no-rm-on-error
 Do not delete the destination directory if clone fails.
@@ -911,6 +954,8 @@ Specifies a single additional option to pass to
 .BR dpkg-buildpackage ,
 .BR dpkg-genchanges ,
 .BR sbuild ,
+.BR pbuilder ,
+.BR cowbuilder ,
 .BR ssh ,
 .BR dgit ,
 .BR git-debrebase ,
@@ -958,6 +1003,8 @@ Specifies alternative programs to use instead of
 .BR dpkg-buildpackage ,
 .BR dpkg-genchanges ,
 .BR sbuild ,
+.BR pbuilder ,
+.BR cowbuilder ,
 .BR gpg ,
 .BR ssh ,
 .BR dgit ,
@@ -996,6 +1043,14 @@ In both cases,
 unusually, the specified value is split on whitespace
 to produce a command and possibly some options and/or arguments.
 
+For pbuilder and cowbuilder, the defaults are
+.BR "sudo -E pbuilder"
+and
+.BR "sudo -E cowbuilder"
+respectively.
+Like with gbp-build and gbp pq,
+the specified value is split on whitespace.
+
 For
 .BR ssh ,
 the default value is taken from the
@@ -1095,6 +1150,12 @@ on the dgit command line.
 .LP
 Settings likely to be useful for an end user include:
 .TP
+.BI dgit.default.build-products-dir
+Specifies where to find the built files to be uploaded,
+when --build-products-dir is not specified.  The default is
+the parent directory
+.RB ( .. ).
+.TP
 .BR dgit-suite. \fIsuite\fR .distro " \fIdistro\fR"
 Specifies the distro for a suite.  dgit keys off the suite name (which
 appears in changelogs etc.), and uses that to determine the distro