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