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