[\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
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
and want to merge your branch with updates from the archive,
use dgit pull.
-dgit checkout will normally need to aceess the archive server,
+dgit checkout will normally need to access the archive server,
to canonicalise the provided suite name.
The exception is if you specify the canonical name,
and the branch (or tracking branch) already exists.
Tagging, signing and actually uploading should be left to dgit push.
-dgit's build operations access the the network,
+dgit's build operations access the network,
to get the -v option right.
See -v, below.
.TP
.IP
Tagging, signing and actually uploading should be left to dgit push.
.TP
+\fBdgit pbuilder\fR [\fIdebbuildopts\fP]
+Constructs the source package, uses
+.B pbuilder
+to do a binary build, and uses mergechanges to merge the source and
+binary changes files.
+The output is left in
+.IR package \fB_\fR version \fB_multi.changes\fR.
+
+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
+(remember 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
debian/changelog and the .dsc, which must agree. If the command line
specifies a suite then that must match too.
-With \fB-C\fR, performs a dgit push, additionally ensuring that no
-binary packages are uploaded.
-
When used on a git-debrebase branch,
dgit calls git-debrebase
to prepare the branch
Without \fB-C\fR, builds a source package and dgit pushes it. Saying
\fBdgit push-source\fR is like saying "update the source code in the
archive to match my git HEAD, and let the autobuilders do the rest."
+
+With \fB-C\fR, performs a dgit push, additionally ensuring that no
+binary packages are uploaded.
.TP
\fBdgit rpush\fR \fIbuild-host\fR\fB:\fR\fIbuild-dir\fR [\fIpush args...\fR]
Pushes the contents of the specified directory on a remote machine.
.B GITATTRIBUTES
in
.BR dgit(7) .
+Note that only attributes affecting the working tree are suppressed.
+git-archive may remain exciting.
If there is an existing macro attribute line
.B [attr]dgit-defuse-attrs
consider --no-chase-dsc-distro
or --force-import-dsc-with-dgit-field.
-There is only only sub-option:
+There is only one sub-option:
.B --require-valid-signature
causes dgit to insist that the signature on the .dsc is valid
.I branch
is prefixed with
.B +
-then if it already exists, it will be simply ovewritten,
+then if it already exists, it will be simply overwritten,
no matter its existing contents.
If
.I branch
.TP
.BI "dgit print-dpkg-source-ignores"
Prints the -i and -I arguments which must be passed to dpkg-souce
-to cause it to exclude exactly the .git diredcory
+to cause it to exclude exactly the .git directory
and nothing else.
The separate arguments are unquoted, separated by spaces,
and do not contain spaces.
+.TP
+.B dgit print-unapplied-treeish
+Constructs a tree-ish approximating the patches-unapplied state
+of your 3.0 (quilt) package,
+and prints the git object name to stdout.
+This requires appropriate .orig tarballs.
+This tree object is identical to your .origs
+as regards upstream files.
+The contents of the debian subdirectory is not interesting
+and should not be inspected;
+except that debian/patches will be identical to your HEAD.
+
+To make this operate off-line,
+the access configuration key
+which is used to determine the build-products-dir
+is the uncanonicalised version of the suite name from the changelog,
+or (of course) dgit.default.build-products-dir.
+See ACCESS CONFIGURATION, below.
+
+This function is primarily provided for the benefit of git-debrebase.
.SH OPTIONS
.TP
.BR --dry-run " | " -n
options other than dpkg-source
are useful when the package's clean target is troublesome, or
to avoid needing the build-dependencies.
-.TP
+
+dgit will only actually clean the tree if it needs to
+(because it needs to build the source package
+or binaries from your working tree).
+Otherwise any untracked files will be simply ignored.
+p.TP
.BR --clean=git-ff " | " -wgf
Use
.BR "git clean -xdff"
but it also removes any subdirectories containing different git
trees (which only unusual packages are likely to create).
.TP
-.BR --clean=check " | " -wc
+.BR --clean=check " | " --clean=check,ignores " | " -wc " | " -wci
Merely check that the tree is clean (does not contain uncommitted
files).
Avoids running rules clean,
and can avoid needing the build-dependencies.
+
+With
+.BR ,ignores
+or
+.BR -wci ,
+untracked files covered by .gitignore are tolerated,
+so only files which show up as
+.B ?
+in git status
+(ie, ones you maybe forgot to git add)
+are treated as a problem.
.TP
.BR --clean=none " | " -wn
Do not clean the tree, nor check that it is clean.
files which are not in git, or if the build creates such files, a
subsequent dgit push will fail.
.TP
-.BR --clean=dpkg-source " | " -wd
+.BR --clean=dpkg-source "[" -d "] | " -wd " | " -wdd
Use dpkg-buildpackage to do the clean, so that the source package
is cleaned by dpkg-source running the package's clean target.
-This is the default.
-Requires the package's build dependencies.
-.TP
-.BR --clean=dpkg-source-d " | " -wdd
-Use
-.B dpkg-buildpackage -d
-to do the clean,
-so that the source package
-is cleaned by dpkg-source running the package's clean target.
-The build-dependencies are not checked (due to
-.BR -d ),
+--clean=dpkg-source is the default.
+
+Without the extra
+.BR d ,
+requires the package's build dependencies.
+
+With
+.BR ... -d
+or
+.BR -wdd ,
+the build-dependencies are not checked
+(due to passing
+.BR -d
+to dpkg-buildpackage),
which violates policy, but may work in practice.
+
+The rules clean target will only be run if it is needed:
+when dgit is going to build source or binary packages
+from your working tree,
+rather than from your git branch
+(for example because of --include-dirty
+or because the binary package build uses your working tree).
+
+In all cases,
+dgit will check that there are (after rules clean, if applicable) no
+untracked un-ignored files,
+in case these are files you forgot to git add.
+(Except that this check is not done
+for a `3.0 (quilt)' package
+when dgit has to apply patches, dirtily, to the working tree.)
+If your package does not have a good .gitignore
+you will probably need --clean=dpkg-source,no-check aka -wdn.
+.TP
+.BR --clean=dpkg-source "[" -d "]" ,no-check " | " -wdn " | " -wddn
+Like --clean=dpkg-source, but
+does not care about untracked un-ignored files.
+.TP
+.BR --clean=dpkg-source "[" -d "]" ,all-check " | " -wda " | " -wdda
+Like --clean=dpkg-source, but
+fails even on ignored untracked files.
+This could perhaps be used to detect bugs in your rules clean target.
.TP
.BR -N " | " --new
The package is or may be new in this suite. Without this, dgit will
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
of the version in the archive
according to the git revision history.
+It is safer not to specify
+.IR previous-version ,
+and usually it's not needed.
+Just say
+.BR --overwrite ,
+unless you know what you are doing.
+
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.
it can mean that
dgit fails to find necessary git commits.
.TP
-.BR --dgit-view-save= \fIbranch\fR|\fIref\fR
+.BR --save-dgit-view= \fIbranch\fR|\fIref\fR
Specifies that when a split view quilt mode is in operation,
and dgit calculates
(or looks up in its cache)
--quilt=unpatched.
If ref does not start with refs/
-it is taken to to be a branch -
+it is taken to be a branch -
i.e. refs/heads/ is prepended.
+
+.B --dgit-view-save
+is a deprecated alias for
+--save-dgit-view.
.TP
.BI --deliberately- something
Declare that you are deliberately doing
When doing a build, delete any changes files matching
.IB package _ version _*.changes
before starting. This ensures that
-dgit push (and dgit sbuild) will be able to unambigously
+dgit push (and dgit sbuild) will be able to unambiguously
identify the relevant changes files from the most recent build, even
if there have been previous builds with different tools or options.
The default is not to remove, but
regardless of this option.
.TP
.BI --build-products-dir= directory
-Specifies where to find the built files to be uploaded.
-By default, dgit looks in the parent directory
+Specifies where to find and create tarballs, binary packages,
+source packages, .changes files, and so on.
+
+By default, dgit uses the parent directory
.RB ( .. ).
+
+Changing this setting may necessitate
+moving .orig tarballs to the new directory,
+so it is probably best to
+use the
+.BI dgit.default.build-products-dir
+configuration setting
+(see CONFIGURATION, below)
+which this command line option overrides).
.TP
.BI --no-rm-on-error
Do not delete the destination directory if clone fails.
.BR dpkg-buildpackage ,
.BR dpkg-genchanges ,
.BR sbuild ,
+.BR pbuilder ,
+.BR cowbuilder ,
.BR ssh ,
.BR dgit ,
.BR git-debrebase ,
.BR dpkg-buildpackage ,
.BR dpkg-genchanges ,
.BR sbuild ,
+.BR pbuilder ,
+.BR cowbuilder ,
.BR gpg ,
.BR ssh ,
.BR dgit ,
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
.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
One of the values for the command line --clean= option; used if
--clean is not specified.
.TP
-.BR dgit-distro. \fIdistro\fR .quilt-mode
+.BR dgit-distro. \fIdistro\fR .clean-mode-newer
+Like .clean-mode,
+but ignored if the value does not make sense to this version of dgit.
+Setting both .clean-mode and .clean-mode-newer is useful
+to provide a single git config compatible with different dgit versions.
+.TP
+.BR dgit-distro. \fIdistro\fR .quilt-
One of the values for the command line --quilt= option; used if
--quilt is not specified.
.TP
.TP
.BR gpg ", " dpkg- "..., " debsign ", " git ", " curl ", " dput ", " LWP::UserAgent
and other subprograms and modules used by dgit are affected by various
-environment variables. Consult the documentaton for those programs
+environment variables. Consult the documentation for those programs
for details.
.SH BUGS
There should be
~ianmdlvl / dgit.git / blobdiff