1 .TH dgit 1 "" "Debian Project" "dgit"
3 dgit \- git integration with the Debian archive
7 [\fIdgit\-opts\fP] \fBclone\fP [\fIdgit\-opts\fP]
8 \fIpackage\fP [\fIsuite\fP] [\fB./\fP\fIdir|\fB/\fP\fIdir]
11 [\fIdgit\-opts\fP] \fBfetch\fP|\fBpull\fP [\fIdgit\-opts\fP]
15 [\fIdgit\-opts\fP] \fBbuild\fP
16 [\fIgit\-buildpackage\-opts\fP|\fIdpkg\-buildpackage\-opts\fp]
19 [\fIdgit\-opts\fP] \fBpush\fP [\fIdgit\-opts\fP]
23 treats the Debian archive as a version control system, and
24 bidirectionally gateways between the archive and git. The git view of
25 the package can contain the usual upstream git history, and will be
26 augmented by commits representing uploads done by other developers not
27 using dgit. This git history is stored in a canonical location known
30 which lives outside the Debian archive (currently, on Alioth).
35 consult the archive and dgit-repos and fetch and/or construct the
36 git view of the history. With clone, the destination directory (by
37 default, the package name in the current directory) will be created,
38 and the new directory's `origin' remote will be set up to point to
39 the package's dgit-repos tree.
44 with some suitable options. Options after
46 will be passed on to git-buildpackage. It is not necessary to
47 use dgit build; it is OK to use any approach which ensures that
48 the generated source package corresponds to the relevant git commit.
49 Tagging and signing should be left to dgit push.
52 does an `upload', pushing the current HEAD to the archive (as a source
53 package) and to dgit-repos (as git commits). This also involves
54 making a signed git tag, and signing the files to be uploaded to the
56 .SH MODEL AND WORKFLOW
57 You may use any suitable git workflow with dgit, provided you
58 satisfy dgit's requirements:
60 dgit maintains a pseudo-remote called
62 with one branch per suite. This remote cannot be used with
67 repository for each package contains one ref per suite named
68 \fBrefs/dgit/\fR\fIsuite\fR. These should be pushed to only by
69 dgit. They are fast forwarding. Each push on this branch
70 corresponds to an upload (or attempted upload).
72 However, it is perfectly fine to have other branches in dgit-repos;
73 normally the dgit-repos repo for the package will be accessible via
74 the remote name `origin'.
76 dgit push can operate on any commit which is a descendant of the
77 current dgit/suite tip in dgit-repos.
79 Uploads made by dgit contain an additional field
81 in the source package .dsc. (This is added by dgit push.)
82 This specifies a commit (an ancestor of the dgit/suite
83 branch) whose tree is identical to the unpacked source upload.
85 Uploads not made by dgit are represented in git by commits which are
86 synthesised by dgit. The tree of each such commit corresponds to the
87 unpacked source; the single parent is the last known upload - that is,
88 the contents of the dgit/suite branch.
90 dgit expects repos that it works with to have a
92 remote. This refers to the well-known dgit-repos location
93 (currently, the dgit-repos project on Alioth). dgit fetch updates
94 the remote tracking branch for dgit/suite.
98 Go through the motions, fetching all information needed, but do not
99 actually update the output(s). For push, dgit does
100 the required checks and leaves the new .dsc in a temporary file,
101 but does not sign, tag, push or upload.
106 for signing the tag and the upload.
109 does not sign tags or uploads (meaningful only with push).
113 Specifies that we should process source package
115 rather than looking in debian/control or debian/changelog.
116 Valid with dgit fetch and dgit pull, only.
119 The package may be new in this suite. Without this, dgit will
123 Prints debugging information to stderr. Repeating the option produces
124 more output (currently, up to -DD is meaningfully different).
127 Specifies a git configuration option. dgit itself is also controlled
128 by git configuration options.
130 .RI \fB--dget=\fR program |\fB--dput=\fR program |\fB--debsign=\fR program
131 Specifies alternative programs to use instead of dget, dput
134 .RI \fB--dget:\fR option |\fB--dput:\fR option |\fB--debsign:\fR option
135 Specifies a single additional option to pass to dget, dput or
136 debsign. Use repeatedly if multiple additional options are required.
139 Specifies the .changes file which is to be uploaded. By default
140 dgit push looks for single .changes file in the parent directory whose
141 filename suggests it is for the right package and version.
143 dgit looks at the following git config keys to control its behaviour.
144 You may set them with git-config (either in system-global or per-tree
145 configuration), or provide
147 on the dgit command line.
149 .BI dgit-suite. suite .distro
151 .BI dgit.default.distro
153 .BI dgit.default.username
155 .BI dgit-distro. distro .git-url
157 .BI dgit-distro. distro .git-host
159 .BI dgit-distro. distro .git-proto
161 .BI dgit-distro. distro .git-path
163 .BI dgit-distro. distro .git-check
165 .BI dgit-distro. distro .git-create
167 .BI dgit-distro. distro .upload-host
169 .BI dgit-distro. distro .mirror
171 .BI dgit-distro. distro .archive-query
173 .BI dgit-distro. distro .archive-query-default-component
175 .BI dgit-distro. distro .ssh
179 .BR dgit-distro. \fIdistro\fR . *
181 We should be using some kind of vhost/vpath setup for the git repos on
182 alioth, so that they can be moved later if and when this turns out to
185 Debian Policy needs to be updated to describe the new Vcs-Dgit-Master
186 field (and to specify that it is an RC bug for that field to refer
187 to an unavailable commit).
189 dgit cannot currently introduce a package into a suite.
191 dgit push should perhaps do `git push origin', or something similar,
194 The mechanism for checking for and creating per-package repos on
195 alioth is a hideous bodge. One consequence is that dgit currently
196 only works for people with push access.
198 Debian Maintainers are currently not able to push, as there is not
199 currently any mechanism for determining and honouring the archive's
200 ideas about access control. Currently only DDs can push.
202 dgit's representation of format `3.0 (quilt)' source packages does not
203 represent the patch stack. Currently the patch series representation
204 cannot round trip through the archive. Ideally dgit would represent a
205 quilty package with an origin commit of some kind followed by the
206 patch stack as a series of commits followed by a pseudo-merge (to make
207 the branch fast-forwarding). This would also mean a new `dgit
208 rebase-prep' command or some such to turn such a fast-forwarding
209 branch back into a rebasing patch stack, and a `force' option to dgit
210 push (perhaps enabled automatically by a note left by rebase-prep)
211 which will make the required pseudo-merge.
213 dgit's handling of .orig.tar.gz is not very sophisticated. Ideally
214 the .orig.tar.gz could be transported via the git repo as git tags.
215 Doing this is made more complicated by the possibility of a `3.0
216 (quilt)' package with multiple .orig tarballs.
218 The error messages are often unhelpfully terse and tend to refer to
219 line numbers in dgit.
221 The option parser requires values to be cuddled to the option name.
223 dgit assumes knowledge of the archive layout. There appears to be no
224 sane way to find the path in the archive pool of the .dsc for a
225 particular suite. I'm assured that the archive layout is a
226 `well known algorithm' by now.
228 --dry-run often does not work with fetch, even though this is a
229 logically plausible request. (It fails, instead.)