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