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