chiark / gitweb /
Better documentation for quilt series handling.
[dgit.git] / dgit.1
1 .TH dgit 1 "" "Debian Project" "dgit"
2 .SH NAME
3 dgit \- git integration with the Debian archive
4 .
5 .SH SYNOPSIS
6 .B dgit
7 [\fIdgit\-opts\fP] \fBclone\fP [\fIdgit\-opts\fP]
8 \fIpackage\fP [\fIsuite\fP] [\fB./\fP\fIdir|\fB/\fP\fIdir\fR]
9 .br
10 .B dgit
11 [\fIdgit\-opts\fP] \fBfetch\fP|\fBpull\fP [\fIdgit\-opts\fP]
12 [\fIsuite\fP]
13 .br
14 .B dgit
15 [\fIdgit\-opts\fP] \fBbuild\fP|\fBsbuild\fP|\fBbuild-source\fP
16 [\fIbuild\-opts\fp]
17 .br
18 .B dgit
19 [\fIdgit\-opts\fP] \fBpush\fP [\fIdgit\-opts\fP]
20 [\fIsuite\fP]
21 .br
22 .B dgit
23 [\fIdgit\-opts\fP] \fBrpush\fR \fIbuild-host\fR\fB:\fR\fIbuild-dir\fR
24 [\fIpush args...\fR]
25 .br
26 .B dgit
27 [\fIdgit\-opts\fP] \fIaction\fR ...
28 .SH DESCRIPTION
29 .B dgit
30 treats the Debian archive as a version control system, and
31 bidirectionally gateways between the archive and git.  The git view of
32 the package can contain the usual upstream git history, and will be
33 augmented by commits representing uploads done by other developers not
34 using dgit.  This git history is stored in a canonical location known
35 as
36 .B dgit-repos
37 which lives outside the Debian archive (currently, on Alioth).
38
39 The usual workflow is: 1. clone or fetch; 2. make and commit changes
40 in git as desired; 3. run dgit build, dgit sbuild or dgit
41 build-source, or generate the source and binary packages for upload
42 some other way; 4. do pre-upload tests of the proposed upload; 5. run
43 dgit push.
44 .TP
45 \fBdgit clone\fR \fIpackage\fP [\fIsuite\fP] [\fB./\fP\fIdir|\fB/\fP\fIdir\fR]
46 Consults the archive and dgit-repos to construct the git view of
47 history for
48 .I package
49 in
50 .I suite
51 .RB ( sid
52 by default)
53 in a new directory (named
54 .BI ./ package
55 by default);
56 also, downloads any necessary orig tarballs.
57
58 The suite's git tip is
59 left on the local branch
60 .BI dgit/ suite
61 ready for work, and on the corresponding dgit remote tracking branch.
62 The
63 .B origin
64 remote will be set up to point to the package's dgit-repos tree
65 for the distro to which
66 .I suite
67 belongs.
68
69 For your convenience, the
70 .B vcs-git
71 remote will be set up from the package's Vcs-Git field, if there is
72 one - but note that in the general case the history found there may be
73 different to or even disjoint from dgit's view.
74 .TP
75 \fBdgit fetch\fR [\fIsuite\fP]
76 Consults the archive and git-repos to update the git view of
77 history for a specific suite (and downloads any necessary orig
78 tarballs), and updates the remote tracking branch
79 .BR remotes/dgit/dgit/ \fIsuite\fR.
80 If the current branch is
81 .BI dgit/ suite
82 then dgit fetch defaults to
83 .IR suite ;
84 otherwise it parses debian/changelog and uses the suite specified
85 there.
86 .TP
87 \fBdgit pull\fR [\fIsuite\fP]
88 Does dgit fetch, and then merges the new head of the remote tracking
89 branch
90 .BI remotes/dgit/dgit/ suite
91 into the current branch.
92 .TP
93 \fBdgit build\fR ...
94 Runs
95 .B dpkg-buildpackage
96 with some suitable options.  Options and argumments after build
97 will be passed on to dpkg-buildpackage.  It is not necessary to use
98 dgit build when using dgit; it is OK to use any approach which ensures
99 that the generated source package corresponds to the relevant git
100 commit.
101
102 Tagging, signing and actually uploading should be left to dgit push.
103 .TP
104 \fBdgit build-source\fR ...
105 Builds the source package, and a changes file for a prospective
106 source-only upload, using
107 .BR dpkg-source .
108 The output is left in
109 .IR package \fB_\fR version \fB.dsc\fR
110 and
111 .IR package \fB_\fR version \fB_source.changes\fR.
112
113 Tagging, signing and actually uploading should be left to dgit push.
114 .TP
115 .B dgit clean
116 Cleans the current working tree (according to the --clean= option in
117 force).
118 .TP
119 .B dgit help
120 Print a usage summary.
121 .TP
122 \fBdgit sbuild\fR ...
123 Constructs the source package, uses
124 .B  sbuild
125 to do a binary build, and uses mergechanges to merge the source and
126 binary changes files.  Options and argumments after sbuild will be
127 passed on to sbuild.  Changes files matching
128 .IB package _ version _*.changes
129 in the parent directory will be removed; the output is left in
130 .IR package \fB_\fR version \fB_multi.changes\fR.
131
132 Tagging, signing and actually uploading should be left to dgit push.
133 .TP
134 \fBdgit git-build\fR ...
135 Runs
136 .B git-buildpackage
137 with some suitable options.  Options and argumments after git-build
138 will be passed on to git-buildpackage.
139
140 Tagging, signing and actually uploading should be left to dgit push.
141 .TP
142 \fBdgit push\fR [\fIsuite\fP]
143 Does an `upload', pushing the current HEAD to the archive (as a source
144 package) and to dgit-repos (as git commits).  The package must already
145 have been built ready for upload, with the .dsc and .changes
146 left in the parent directory.
147
148 In more detail: dgit push checks that the current HEAD corresponds to
149 the .dsc.  It then pushes the HEAD to the suite's dgit-repos branch,
150 makes a signed git tag, edits the .dsc to contain the dgit metadata
151 field, runs debsign to sign the upload (.dsc and .changes), pushes the
152 signed tag, and finally uses dput to upload the .changes to the
153 archive.
154
155 dgit push always uses the package, suite and version specified in the
156 debian/changelog and the .dsc, which must agree.  If the command line
157 specifies a suite then that must match too.
158
159 If dgit push fails while uploading, it is fine to simply retry the
160 dput on the .changes file at your leisure.
161 .TP
162 \fBdgit rpush\fR \fIbuild-host\fR\fB:\fR\fIbuild-dir\fR [\fIpush args...\fR]
163 Pushes the contents of the specified directory on a remote machine.
164 This is like running dgit push on build-host with build-dir as the
165 current directory; however, signing operations are done on the
166 invoking host.  This allows you to do a push when the system which has
167 the source code and the build outputs has no access to the key.
168
169 However, the build-host must be able to ssh to the dgit repos.  If
170 this is not already the case, you must organise it separately, for
171 example by the use of ssh agent forwarding.
172
173 The remaining arguments are treated just as dgit push would handle
174 them.
175
176 build-host and build\-dir can be passed as separate
177 arguments; this is assumed to be the case if the first argument
178 contains no : (except perhaps one in [ ], to support IPv6 address
179 literals).
180
181 You will need similar enough versions of dgit on the build-host and
182 the invocation host.  The build-host needs gnupg installed, with your
183 public key in its keyring (but not your private key, obviously).
184 .TP
185 .B dgit quilt-fixup
186 `3.0 (quilt)' format source packages need changes representing not
187 only in-tree but also as patches in debian/patches.  dgit quilt-fixup
188 checks whether this has been done; if not, dgit will make appropriate
189 patches in debian/patches and also commit the resulting changes to
190 git.
191
192 This is normally done automatically by dgit build and dgit push.
193
194 dgit will try to turn each relevant commit in your git history into a
195 new quilt patch.  dgit cannot convert nontrivial merges, or certain
196 other kinds of more exotic history.  If dgit can't find a suitable
197 linearisation of your history, by default it will fail, but you can
198 ask it to generate a single squashed patch instead.
199 .TP
200 .B dgit version
201 Prints version information and exits.
202 .SH OPTIONS
203 .TP
204 .BR --dry-run | -n
205 Go through the motions, fetching all information needed, but do not
206 actually update the output(s).  For push, dgit does
207 the required checks and leaves the new .dsc in a temporary file,
208 but does not sign, tag, push or upload.
209 .TP
210 .BR --damp-run | -L
211 Go through many more of the motions: do everything that doesn't
212 involve either signing things, or making changes on the public
213 servers.
214 .TP
215 .BI -k keyid
216 Use
217 .I keyid
218 for signing the tag and the upload.
219 .TP
220 .BR --no-sign
221 does not sign tags or uploads (meaningful only with push).
222 .TP
223 .TP
224 .BI -p package
225 Specifies that we should process source package
226 .I package
227 rather than looking in debian/control or debian/changelog.
228 Valid with dgit fetch and dgit pull, only.
229 .TP
230 .BR --clean=git | -wg
231 The source tree should be cleaned, before building a source package
232 with one of the build options, using
233 .BR "git clean -xdf" .
234 This will delete all files which are not tracked by git.
235 .TP
236 .BR --clean=none | -wn
237 Do not clean the tree before building a source package.  If there are
238 files which are not in git, a subsequent dgit push will fail.
239 .TP
240 .BR --clean=dpkg-source | -wd
241 Use dpkg-buildpackage to do the clean, so that the source package
242 is cleaned by dpkg-source running the package's clean target.
243 This is the default.  It requires the package's build dependencies.
244 .TP
245 .BR -N | --new
246 The package may be new in this suite.  Without this, dgit will
247 refuse to push.
248 .TP
249 .BR --ignore-dirty
250 Do not complain if the working tree does not match your git HEAD.
251 This can be useful with build, if you plan to commit later.  (dgit
252 push will still ensure that the .dsc you upload and the git tree
253 you push are identical, so this option won't make broken pushes.)
254 .TP
255 .BR --quilt=linear
256 When fixing up source format `3.0 (quilt)' metadata, insist on
257 generating a linear patch stack.  If such a stack cannot be generated,
258 fail.
259 .TP
260 .BR --quilt=auto
261 When fixing up source format `3.0 (quilt)' metadata, prefer to
262 generate a linear patch stack, but if that doesn't seem possible,
263 generate a single squashed patch for all the changes made in git.
264 This is not a good idea for an NMU in Debian.
265 .TP
266 .BR --quilt=smash
267 When fixing up source format `3.0 (quilt)' metadata,
268 generate a single squashed patch for all the changes made in git.
269 This is not a good idea for an NMU in Debian.
270 .TP
271 .BR --quilt=nofix
272 Check whether source format `3.0 (quilt)' metadata would need fixing
273 up, but, if it does, fail.  You must then fix the metadata yourself
274 somehow before pushing.  (NB that dpkg-source --commit will not work
275 because the dgit git tree does not have a
276 .B .pc
277 directory.)
278 .TP
279 .BR --no-quilt-fixup
280 Do not check whether up source format `3.0 (quilt)' metadata needs
281 fixing up.  If you use this option and the metadata did in fact need
282 fixing up, dgit push will fail.
283 .TP
284 .BI -D
285 Prints debugging information to stderr.  Repeating the option produces
286 more output (currently, up to -DD is meaningfully different).
287 .TP
288 .BI -c name = value
289 Specifies a git configuration option.  dgit itself is also controlled
290 by git configuration options.
291 .TP
292 .RI \fB-v\fR version "|\fB_\fR | " \fB--since-version=\fR version |\fB_\fR
293 Specifies the
294 .BI -v version
295 option to pass to dpkg-genchanges, during builds.  Changes (from
296 debian/changelog) since this version will be included in the built
297 changes file, and hence in the upload.  If this option is not
298 specified, dgit will query the archive and use the latest version
299 uploaded to the intended suite.
300
301 Specifying
302 .B _
303 inhibits this, so that no -v option will be passed to dpkg-genchanges
304 (and as a result, only the last stanza from debian/changelog will
305 be used for the build and upload).
306 .TP
307 .RI \fB-m\fR maintaineraddress
308 Passed to dpkg-genchanges (eventually).
309 .TP
310 .RI \fB--ch:\fR option
311 Specifies a single additional option to pass, eventually, to
312 dpkg-genchanges.
313 .TP
314 .RI \fB--curl=\fR program |\fB--dput=\fR program |...
315 Specifies alternative programs to use instead of
316 .BR curl ,
317 .BR dput ,
318 .BR debsign ,
319 .BR dpkg-source ,
320 .BR dpkg-buildpackage ,
321 .BR dpkg-genchanges ,
322 .BR sbuild ,
323 .BR gpg ,
324 .BR ssh ,
325 .BR dgit ,
326 or
327 .BR mergechanges .
328
329 For dpkg-buildpackage, dpkg-genchanges, mergechanges and sbuild,
330 this applies only when the program is invoked directly by dgit.
331
332 For dgit, specifies the command to run on the remote host when dgit
333 rpush needs to invoke a remote copy of itself.  (dgit also reinvokes
334 itself as the EDITOR for dpkg-source --commit; this is done using
335 argv[0], and is not affected by --dgit=).
336
337 For ssh, the default value is taken from the
338 .B DGIT_SSH
339 or
340 .B GIT_SSH
341 environment variables, if set (see below).  And, for ssh, when accessing the
342 archive and dgit-repos, this command line setting is overridden by the
343 git config variables
344 .BI dgit-distro. distro .ssh
345 and
346 .B .dgit.default.ssh
347 (which can in turn be overridden with -c).  Also, when dgit is using
348 git to access dgit-repos, only git's idea of what ssh to use (eg,
349 .BR GIT_SSH )
350 is relevant.
351 .TP
352 .RI \fB--curl:\fR option |\fB--dput:\fR option |...
353 Specifies a single additional option to pass to
354 .BR curl ,
355 .BR dput ,
356 .BR debsign ,
357 .BR dpkg-source ,
358 .BR dpkg-buildpackage ,
359 .BR dpkg-genchanges ,
360 .BR sbuild ,
361 .BR ssh ,
362 .BR dgit ,
363 or
364 .BR mergechanges .
365 Can be repeated as necessary.
366
367 For dpkg-buildpackage, dpkg-genchanges, mergechanges and sbuild,
368 this applies only when the program is invoked directly by dgit.
369 Usually, for passing options to dpkg-genchanges, you should use
370 .BR --ch: \fIoption\fR.
371
372 See notes above regarding ssh and dgit.
373
374 NB that --gpg:option is not supported (because debsign does not
375 have that facility).  But see -k.
376 .TP
377 .BR -d "\fIdistro\fR | " --distro= \fIdistro\fR
378 Specifies that the suite to be operated on is part of distro
379 .IR distro .
380 This overrides the default value found from the git config option
381 .BR dgit-suite. \fIsuite\fR .distro .
382 The only effect is that other configuration variables (used
383 for accessing the archive and dgit-repos) used are
384 .BR dgit-distro. \fIdistro\fR .* .
385
386 If your suite is part of a distro that dgit already knows about, you
387 can use this option to make dgit work even if your dgit doesn't know
388 about the suite.  For example, specifying
389 .B -ddebian
390 will work when the suite is an unknown suite in the Debian archive.
391
392 To define a new distro it is necessary to define methods and URLs
393 for fetching (and, for dgit push, altering) a variety of information both
394 in the archive and in dgit-repos.  How to do this is not yet
395 documented, and currently the arrangements are unpleasant.  See
396 BUGS.
397 .TP
398 .BI -C changesfile
399 Specifies the .changes file which is to be uploaded.  By default
400 dgit push looks for single .changes file in the parent directory whose
401 filename suggests it is for the right package and version - or,
402 if there is a _multi.changes file, dgit uses that.
403
404 If the specified
405 .I changesfile
406 pathname contains slashes, the directory part is also used as
407 the value for
408 .BR --build-products-dir ;
409 otherwise, the changes file is expected in that directory (by
410 default, in
411 .BR .. ).
412 .TP
413 .BI --build-products-dir= directory
414 Specifies where to find the built files to be uploaded.
415 By default, dgit looks in the parent directory
416 .BR .. ).
417 .TP
418 .BI --existing-package= package
419 dgit push needs to canonicalise the suite name.  Sometimes, dgit
420 lacks a way to ask the archive to do this without knowing the
421 name of an existing package.  Without --new we can just use the
422 package we are trying to push.  But with --new that will not work, so
423 we guess
424 .B dpkg
425 or use the value of this option.  This option is not needed with the
426 default mechanisms for accessing the archive.
427 .TP
428 .BR -h | --help
429 Print a usage summary.
430 .TP
431 .BI --initiator-tempdir= directory
432 dgit rpush uses a temporary directory on the invoking (signing) host.
433 This option causes dgit to use
434 .I directory
435 instead.  Furthermore, the specified directory will be emptied,
436 removed and recreated before dgit starts, rather than removed
437 after dgit finishes.  The directory specified must be an absolute
438 pathname.
439 .TP
440 .BI --no-rm-on-error
441 Do not delete the destination directory if clone fails.
442 .SH WORKFLOW - SIMPLE
443 It is always possible with dgit to clone or fetch a package, make
444 changes in git (using git-commit) on the suite branch
445 .RB ( "git checkout dgit/" \fIsuite\fR)
446 and then dgit push.  You can use whatever gitish techniques you like
447 to construct the commit to push; the only requirement is that it is a
448 descendant of the state of the archive, as provided by dgit in the
449 remote tracking branch
450 .BR remotes/dgit/dgit/ \fIsuite\fR.
451
452 If you are using dgit to do an NMU, and don't know about the
453 maintainers' preferred packaging workflows, you should make your
454 changes as a linear series of (logicially separated) commits on top of
455 what's already in the archive.
456
457 If you are lucky the other uploaders have also used dgit and
458 integrated the other relevant git history; if not you can fetch it
459 into your tree and cherry-pick etc. as you wish.
460 .SH WORKFLOW - INTEGRATING BETWEEN DGIT AND OTHER GIT HISTORY
461 If you are the maintainer of a package dealing with uploads made
462 without dgit, you will probably want to merge the synthetic commits
463 (made by dgit to represent the uploads) into your git history.
464 Normally you can just merge the dgit branch into your own master, or
465 indeed if you do your work on the dgit local suite branch
466 .BI dgit/ suite
467 you can just use dgit pull.
468
469 However the first time dgit is used it will generate a new origin
470 commit from the archive which won't be linked into the rest of your
471 git history.  You will need to merge this.
472
473 If last upload was in fact made with git, you should usually proceed
474 as follows: identify the commit which was actually used to build the
475 package.  (Hopefully you have a tag for this.)  Check out the dgit
476 branch
477 .RB ( "git checkout dgit/" \fIsuite\fR)
478 and merge that other commit
479 .RB ( "git merge debian/" \fIversion\fR).
480 Hopefully this merge will be trivial because the two trees should
481 be the same.  The resulting branch head can be merged into your
482 working branches
483 .RB ( "git checkout master && git merge dgit/" \fIsuite\fR).
484
485 If last upload was not made with git, a different approach is required
486 to start using dgit.  First, do
487 .B dgit fetch
488 (or clone) to obtain a git history representation of what's in the
489 archive and record it in the
490 .BI remotes/dgit/dgit/ suite
491 tracking branch.  Then somehow, using your other git history
492 plus appropriate diffs and cherry picks from the dgit remote tracking
493 branch, construct a git commit whose tree corresponds to the tree to use for the
494 next upload.  If that commit-to-be-uploaded is not a descendant of the
495 dig remote tracking branch, check it out and say
496 .BR "git merge -s ours remotes/dgit/dgit/" \fIsuite\fR;
497 that tells git that we are deliberately throwing away any differences
498 between what's in the archive and what you intend to upload.
499 Then run
500 .BR "dgit push"
501 to actually upload the result.
502 .SH MODEL
503 You may use any suitable git workflow with dgit, provided you
504 satisfy dgit's requirements:
505
506 dgit maintains a pseudo-remote called
507 .BR dgit ,
508 with one branch per suite.  This remote cannot be used with
509 plain git.
510
511 The
512 .B dgit-repos
513 repository for each package contains one ref per suite named
514 \fBrefs/dgit/\fR\fIsuite\fR.  These should be pushed to only by
515 dgit.  They are fast forwarding.  Each push on this branch
516 corresponds to an upload (or attempted upload).
517
518 However, it is perfectly fine to have other branches in dgit-repos;
519 normally the dgit-repos repo for the package will be accessible via
520 the remote name `origin'.
521
522 dgit push will also (by default) make signed tags called
523 .BI debian/ version
524 and push them to dgit-repos, but nothing depends on these tags
525 existing.
526
527 dgit push can operate on any commit which is a descendant of the
528 current dgit/suite tip in dgit-repos.
529
530 Uploads made by dgit contain an additional field
531 .B Dgit
532 in the source package .dsc.  (This is added by dgit push.)
533 This specifies a commit (an ancestor of the dgit/suite
534 branch) whose tree is identical to the unpacked source upload.
535
536 Uploads not made by dgit are represented in git by commits which are
537 synthesised by dgit.  The tree of each such commit corresponds to the
538 unpacked source; there is an origin commit with the contents, and a
539 psuedo-merge from last known upload - that is, from the contents of
540 the dgit/suite branch.
541
542 dgit expects repos that it works with to have a
543 .B dgit
544 remote.  This refers to the well-known dgit-repos location
545 (currently, the dgit-repos project on Alioth).  dgit fetch updates
546 the remote tracking branch for dgit/suite.
547
548 dgit does not (currently) represent the orig tarball(s) in git.  The
549 orig tarballs are downloaded (by dgit clone) into the parent
550 directory, as with a traditional (non-gitish) dpkg-source workflow.
551 You need to retain these tarballs in the parent directory for dgit
552 build and dgit push.
553
554 To a user looking at the archive, changes pushed using dgit look like
555 changes made in an NMU: in a `3.0 (quilt)' package the delta from the
556 previous upload is recorded in a new patch constructed by dpkg-source.
557 .SH READ-ONLY DISTROS
558 Distros which do not maintain a set of dgit history git repositories
559 can still be used in a read-only mode with dgit.  Currently Ubuntu
560 is configured this way.
561 .SH PACKAGE SOURCE FORMATS
562 If you are not the maintainer, you do not need to worry about the
563 source format of the package.  You can just make changes as you like
564 in git.  If the package is a `3.0 (quilt)' package, the patch stack
565 will usually not be represented in the git history.
566 .SH FORMAT 3.0 (QUILT)
567 For a format `3.0 (quilt)' source package, dgit may have to make a
568 commit on your current branch to contain metadata used by quilt and
569 dpkg-source.
570
571 This is because `3.0 (quilt)' source format represents the patch stack
572 as files in debian/patches/ actually inside the source tree.  This
573 means that, taking the whole tree (as seen by git or ls) (i)
574 dpkg-source cannot represent certain trees, and (ii) packing up a tree
575 in `3.0 (quilt)' and then unpacking it does not always yield the same
576 tree.
577
578 dgit will automatically work around this for you when building and
579 pushing.  The only thing you need to know is that dgit build, sbuild,
580 etc., may make new commits on your HEAD.  If you're not a quilt user
581 this commit won't contain any changes to files you care about.
582
583 You can explicitly request that dgit do just this fixup, by running
584 dgit quilt-fixup.
585
586 If you are a quilt user you need to know that dgit's git trees are
587 `patches applied packaging branches' and do not contain the .pc
588 directory (which is used by quilt to record which patches are
589 applied).  If you want to manipulate the patch stack you probably want
590 to be looking at tools like git-dpm.
591 .SH FILES IN THE SOURCE PACKAGE BUT NOT IN GIT
592 This section is mainly of interest to maintainers who want to use dgit
593 with their existing git history for the Debian package.
594
595 Some developers like to have an extra-clean git tree which lacks files
596 which are normally found in source tarballs and therefore in Debian
597 source packages.  For example, it is conventional to ship ./configure
598 in the source tarball, but some people prefer not to have it present
599 in the git view of their project.
600
601 dgit requires that the source package unpacks to exactly the same
602 files as are in the git commit on which dgit push operates.  So if you
603 just try to dgit push directly from one of these extra-clean git
604 branches, it will fail.
605
606 As the maintainer you therefore have the following options:
607 .TP
608 \(bu
609 Persuade upstream that the source code in their git history and the
610 source they ship as tarballs should be identical.  Of course simply
611 removing the files from the tarball may make the tarball hard for
612 people to use.
613 .IP
614 One answer is to commit the (maybe autogenerated)
615 files, perhaps with some simple automation to deal with conflicts and
616 spurious changes.  This has the advantage that someone who clones
617 the git repository finds the program just as easy to build as someone
618 who uses the tarball.
619 .TP
620 \(bu
621 Have separate git branches which do contain the extra files, and after
622 regenerating the extra files (whenever you would have to anyway),
623 commit the result onto those branches.
624 .TP
625 \(bu
626 Provide source packages which lack the files you don't want
627 in git, and arrange for your package build to create them as needed.
628 This may mean not using upstream source tarballs and makes the Debian
629 source package less useful for people without Debian build
630 infrastructure.
631 .LP
632 Of course it may also be that the differences are due to build system
633 bugs, which cause unintended files to end up in the source package.
634 dgit will notice this and complain.  You may have to fix these bugs
635 before you can unify your existing git history with dgit's.
636 .SH CONFIGURATION
637 dgit looks at the following git config keys to control its behaviour.
638 You may set them with git-config (either in system-global or per-tree
639 configuration), or provide
640 .BI -c key = value
641 on the dgit command line.
642 .TP
643 .BI dgit-suite. suite .distro
644 .TP
645 .BI dgit.default.distro
646 .TP
647 .BI dgit-distro. distro .username
648 .TP
649 .BI dgit-distro. distro .git-url
650 .TP
651 .BI dgit-distro. distro .git-user
652 .TP
653 .BI dgit-distro. distro .git-host
654 .TP
655 .BI dgit-distro. distro .git-proto
656 .TP
657 .BI dgit-distro. distro .git-path
658 .TP
659 .BI dgit-distro. distro .git-check
660 .TP
661 .BI dgit-distro. distro .git-create
662 .TP
663 .BI dgit-distro. distro .upload-host
664 .TP
665 .BI dgit-distro. distro .mirror
666 .TP
667 .BI dgit-distro. distro .archive-query
668 .TP
669 .BI dgit-distro. distro .archive-query-default-component
670 .TP
671 .BI dgit-distro. distro .sshpsql-user
672 .TP
673 .BI dgit-distro. distro .sshpsql-host
674 .TP
675 .BI dgit-distro. distro .sshpsql-dbname
676 .TP
677 .BI dgit-distro. distro .ssh
678 .TP
679 .BI dgit-distro. distro .keyid
680 .TP
681 .BR dgit.default. *
682 for each
683 .BR dgit-distro. \fIdistro\fR . *
684 .SH ENVIRONMENT VARIABLES
685 .TP
686 .BR DGIT_SSH ", " GIT_SSH
687 specify an alternative default program (and perhaps arguments) to use
688 instead of ssh.  DGIT_SSH is consulted first and may contain arguments;
689 if it contains any whitespace will be passed to the shell.  GIT_SSH
690 specifies just the program; no arguments can be specified, so dgit
691 interprets it the same way as git does.
692 See
693 also the --ssh= and --ssh: options.
694 .TP
695 .BR gpg ", " dpkg- "..., " debsign ", " git ", " curl ", " dput ", " LWP::UserAgent
696 and other subprograms and modules used by dgit are affected by various
697 environment variables.  Consult the documentaton for those programs
698 for details.
699 .SH BUGS
700 We should be using some kind of vhost/vpath setup for the git repos on
701 alioth, so that they can be moved later if and when this turns out to
702 be a good idea.
703
704 dgit push should perhaps do `git push origin', or something similar,
705 by default.
706
707 Debian does not have a working rmadison server, so to find out what
708 version of a package is in the archive, or to canonicalise suite
709 names, we ssh directly into the ftpmaster server and run psql there to
710 access the database.
711
712 The mechanism for checking for and creating per-package repos on
713 alioth is a hideous bodge.  One consequence is that dgit currently
714 only works for people with push access.
715
716 Debian Maintainers are currently not able to push, as there is not
717 currently any mechanism for determining and honouring the archive's
718 ideas about access control.  Currently only DDs can push.
719
720 dgit's git representation of format `3.0 (quilt)' source packages does
721 not represent the patch stack as git commits.  Currently the patch
722 series representation cannot round trip between git and the archive.
723 Ideally dgit would represent a quilty package with an origin commit of
724 some kind followed by the patch stack as a series of commits followed
725 by a pseudo-merge (to make the branch fast-forwarding).  This would
726 also mean a new `dgit rebase-prep' command or some such to turn such a
727 fast-forwarding branch back into a rebasing patch stack, and a `force'
728 option to dgit push (perhaps enabled automatically by a note left by
729 rebase-prep) which will make the required pseudo-merge.
730
731 If the dgit push fails halfway through, it should be restartable and
732 idempotent.  However this is not true for the git tag operation.
733 Also, it would be good to check that the proposed signing key is
734 available before starting work.
735
736 dgit's handling of .orig.tar.gz is not very sophisticated.  Ideally
737 the .orig.tar.gz could be transported via the git repo as git tags.
738 Doing this is made more complicated by the possibility of a `3.0
739 (quilt)' package with multiple .orig tarballs.
740
741 dgit's build functions, and dgit push, should not make any changes to
742 your current HEAD.  Sadly this is necessary for packages in the `3.0
743 (quilt)' source format.  This is ultimately due to what I consider
744 design problems in quilt and dpkg-source.
745
746 There should be an option which arranges for the `3.0 (quilt)'
747 autocommit(s) to not appear on your HEAD, but instead only in the
748 remote tracking suite branch.
749
750 The option parser requires values to be cuddled to the option name.
751
752 dgit assumes knowledge of the archive database.  (The information dgit
753 needs is not currently available via any public online service with a
754 well-defined interface, let alone a secure one.)
755
756 --dry-run does not always work properly, as not doing some of the git
757 fetches may result in subsequent actions being different.  Doing a
758 non-dry-run dgit fetch first will help.
759 .SH SEE ALSO
760 \fBcurl\fP(1),
761 \fBdput\fP(1),
762 \fBdebsign\fP(1),
763 \fBgit-config\fP(1),
764 \fBgit-buildpackage\fP(1),
765 \fBdpkg-buildpackage\fP(1),
766 .br
767 https://wiki.debian.org/Alioth