chiark / gitweb /
[dgit.git] / dgit.1
1 .TH dgit 1 "" "Debian Project" "dgit"
3 dgit \- git integration with the Debian archive
4 .
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 ...
29 .B dgit
30 allows you to treat the Debian archive as if it were a git
31 repository.  See \fBdgit\fP(7) for detailed information about the data
32 model, common problems likely to arise with certain kinds of package,
33 etc.
35 The usual workflow is:
36 .br
37 1.      \fBdgit clone\fR or \fBfetch\fR;
38 .br
39 2.      make, do dev tests, and commit changes in git as desired;
40 .br
41 3.      build packages for upload, using e.g. \fBdgit sbuild\fR
42 .br
43 4.      do pre-upload tests of the proposed upload;
44 .br
45 5.      \fBdgit push\fR.
47 .TP
48 \fBdgit clone\fR \fIpackage\fP [\fIsuite\fP] [\fB./\fP\fIdir|\fB/\fP\fIdir\fR]
49 Consults the archive and dgit-repos to construct the git view of
50 history for
51 .I package
52 in
53 .I suite
54 .RB ( sid
55 by default)
56 in a new directory (named
57 .BI ./ package
58 by default);
59 also, downloads any necessary orig tarballs.
61 The suite's git tip is
62 left on the local branch
63 .BI dgit/ suite
64 ready for work, and on the corresponding dgit remote tracking branch.
65 The
66 .B origin
67 remote will be set up to point to the package's dgit-repos tree
68 for the distro to which
69 .I suite
70 belongs.
72 For your convenience, the
73 .B vcs-git
74 remote will be set up from the package's Vcs-Git field, if there is
75 one - but note that in the general case the history found there may be
76 different to or even disjoint from dgit's view.
77 .TP
78 \fBdgit fetch\fR [\fIsuite\fP]
79 Consults the archive and git-repos to update the git view of
80 history for a specific suite (and downloads any necessary orig
81 tarballs), and updates the remote tracking branch
82 .BR remotes/dgit/dgit/ \fIsuite\fR.
83 If the current branch is
84 .BI dgit/ suite
85 then dgit fetch defaults to
86 .IR suite ;
87 otherwise it parses debian/changelog and uses the suite specified
88 there.
89 .TP
90 \fBdgit pull\fR [\fIsuite\fP]
91 Does dgit fetch, and then merges the new head of the remote tracking
92 branch
93 .BI remotes/dgit/dgit/ suite
94 into the current branch.
95 .TP
96 \fBdgit build\fR ...
97 Runs
98 .B dpkg-buildpackage
99 with some suitable options.  Options and arguments after build
100 will be passed on to dpkg-buildpackage.  It is not necessary to use
101 dgit build when using dgit; it is OK to use any approach which ensures
102 that the generated source package corresponds to the relevant git
103 commit.
105 Tagging, signing and actually uploading should be left to dgit push.
106 .TP
107 \fBdgit build-source\fR ...
108 Builds the source package, and a changes file for a prospective
109 source-only upload, using
110 .BR dpkg-source .
111 The output is left in
112 .IR package \fB_\fR version \fB.dsc\fR
113 and
114 .IR package \fB_\fR version \fB_source.changes\fR.
116 Tagging, signing and actually uploading should be left to dgit push.
117 .TP
118 .B dgit clean
119 Cleans the current working tree (according to the --clean= option in
120 force).
121 .TP
122 .B dgit help
123 Print a usage summary.
124 .TP
125 \fBdgit sbuild\fR ...
126 Constructs the source package, uses
127 .B  sbuild
128 to do a binary build, and uses mergechanges to merge the source and
129 binary changes files.  Options and arguments after sbuild will be
130 passed on to sbuild.
131 The output is left in
132 .IR package \fB_\fR version \fB_multi.changes\fR.
134 Tagging, signing and actually uploading should be left to dgit push.
135 .TP
136 \fBdgit gbp-build\fR ...
137 Runs
138 .B git-buildpackage
139 with some suitable options.  Options and arguments after gbp-build
140 will be passed on to git-buildpackage.
142 By default this uses \-\-quilt=gbp, so HEAD should be a
143 git-buildpackage style branch, not a patches-applied branch.
145 Tagging, signing and actually uploading should be left to dgit push.
146 .TP
147 \fBdgit push\fR [\fIsuite\fP]
148 Does an `upload', pushing the current HEAD to the archive (as a source
149 package) and to dgit-repos (as git commits).  The package must already
150 have been built ready for upload, with the .dsc and .changes
151 left in the parent directory.  It is normally best to do the build
152 with dgit too (eg with dgit sbuild): some existing build tools pass
153 unhelpful options to dpkg-source et al by default, which can result in
154 the built source package not being identical to the git tree.
156 In more detail: dgit push checks that the current HEAD corresponds to
157 the .dsc.  It then pushes the HEAD to the suite's dgit-repos branch,
158 makes a signed git tag, edits the .dsc to contain the dgit metadata
159 field, runs debsign to sign the upload (.dsc and .changes), pushes the
160 signed tag, and finally uses dput to upload the .changes to the
161 archive.
163 dgit push always uses the package, suite and version specified in the
164 debian/changelog and the .dsc, which must agree.  If the command line
165 specifies a suite then that must match too.
167 If dgit push fails while uploading, it is fine to simply retry the
168 dput on the .changes file at your leisure.
169 .TP
170 \fBdgit rpush\fR \fIbuild-host\fR\fB:\fR\fIbuild-dir\fR [\fIpush args...\fR]
171 Pushes the contents of the specified directory on a remote machine.
172 This is like running dgit push on build-host with build-dir as the
173 current directory; however, signing operations are done on the
174 invoking host.  This allows you to do a push when the system which has
175 the source code and the build outputs has no access to the key:
177 1.      Clone on build host (dgit clone)
178 .br
179 2.      Edit code on build host (edit, git commit)
180 .br
181 3.      Build package on build host (dgit build)
182 .br
183 4.      Test package on build host or elsewhere (dpkg -i, test)
184 .br
185 5.      Upload by invoking dgit rpush on host with your GPG key.
187 However, the build-host must be able to ssh to the dgit repos.  If
188 this is not already the case, you must organise it separately, for
189 example by the use of ssh agent forwarding.
191 The remaining arguments are treated just as dgit push would handle
192 them.
194 build-host and build\-dir can be passed as separate
195 arguments; this is assumed to be the case if the first argument
196 contains no : (except perhaps one in [ ], to support IPv6 address
197 literals).
199 You will need similar enough versions of dgit on the build-host and
200 the invocation host.  The build-host needs gnupg installed, with your
201 public key in its keyring (but not your private key, obviously).
202 .TP
203 .B dgit setup-new-tree
204 Configure the current working tree the way that dgit clone would have
205 set it up.  Like running
206 .B dgit setup-useremail
207 and
208 .B setup-mergechangelogs
209 (but only does each thing if dgit is configured to do it automatically).
210 You can use these in any git repository, not just ones used with
211 the other dgit operations.
212 .TP
213 .B dgit setup-useremail
214 Set the working tree's and from the
215 distro-specific dgit configuration
216 .RB ( dgit-distro. \fIdistro\fR .user-name " and " .user-email ),
218 .TP
219 .B dgit setup-mergechangelogs
220 Configures a git merge helper for the file
221 .B debian/changelog
222 which uses
223 .BR dpkg-mergechangelogs .
224 .TP
225 .B dgit quilt-fixup
226 `3.0 (quilt)' format source packages need changes representing not
227 only in-tree but also as patches in debian/patches.  dgit quilt-fixup
228 checks whether this has been done; if not, dgit will make appropriate
229 patches in debian/patches and also commit the resulting changes to
230 git.
232 This is normally done automatically by dgit build and dgit push.
234 dgit will try to turn each relevant commit in your git history into a
235 new quilt patch.  dgit cannot convert nontrivial merges, or certain
236 other kinds of more exotic history.  If dgit can't find a suitable
237 linearisation of your history, by default it will fail, but you can
238 ask it to generate a single squashed patch instead.
239 .TP
240 .B dgit version
241 Prints version information and exits.
242 .TP
243 .BI "dgit clone-dgit-repos-server" " destdir"
244 Tries to fetch a copy of the source code for the dgit-repos-server,
245 as actually being used on the dgit git server, as a git tree.
247 .TP
248 .BR --dry-run " | " -n
249 Go through the motions, fetching all information needed, but do not
250 actually update the output(s).  For push, dgit does
251 the required checks and leaves the new .dsc in a temporary file,
252 but does not sign, tag, push or upload.
253 .TP
254 .BR --damp-run " | " -L
255 Go through many more of the motions: do everything that doesn't
256 involve either signing things, or making changes on the public
257 servers.
258 .TP
259 .BI -k keyid
260 Use
261 .I keyid
262 for signing the tag and the upload.  The default comes from the
263 distro's
264 .B keyid
265 config setting (see CONFIGURATION, below), or failing that, the
266 uploader trailer line in debian/changelog.
267 .TP
268 .BR --no-sign
269 does not sign tags or uploads (meaningful only with push).
270 .TP
271 .TP
272 .BI -p package
273 Specifies that we should process source package
274 .I package
275 rather than looking in debian/control or debian/changelog.
276 Valid with dgit fetch and dgit pull, only.
277 .TP
278 .BR --clean=git " | " -wg
279 The source tree should be cleaned, before building a source package
280 with one of the build options, using
281 .BR "git clean -xdf" .
282 This will delete all files which are not tracked by git.  Also, -wg
283 causes dgit to pass
284 .B -nc
285 to dpkg-buildpackage, which prevents the package's own clean target
286 from being run.
288 --clean=git is useful when the package's clean target is troublesome;
289 the downside is simply that git clean may delete files you forgot to
290 git add.  --clean=git can also avoid needing the build-dependencies.
291 .TP
292 .BR --clean=git-ff " | " -wgf
293 The source tree should be cleaned, before building a source package
294 with one of the build options, using
295 .BR "git clean -xdff" .
296 This is like
297 "git clean -xdf"
298 but it also removes any subdirectories containing different git
299 trees (which only unusual packages are likely to create).
300 .TP
301 .BR --clean=check " | " -wc
302 Merely check that the tree is clean (does not contain uncommitted
303 files), before building a source package.
304 .TP
305 .BR --clean=none " | " -wn
306 Do not clean the tree before building a source package.  If there are
307 files which are not in git, or if the build creates such files, a
308 subsequent dgit push will fail.
309 .TP
310 .BR --clean=dpkg-source " | " -wd
311 Use dpkg-buildpackage to do the clean, so that the source package
312 is cleaned by dpkg-source running the package's clean target.
313 This is the default.  It requires the package's build dependencies.
314 .TP
315 .BR --clean=dpkg-source-d " | " -wdd
316 Use
317 .B dpkg-buildpackage -d
318 to do the clean, so that the source package
319 is cleaned by dpkg-source running the package's clean target.
320 The build-dependencies are not checked (due to
321 .BR -d ),
322 which violates policy, but may work in practice.
323 .TP
324 .BR -N " | " --new
325 The package is or may be new in this suite.  Without this, dgit will
326 refuse to push.  It may (for Debian, will) be unable to access the git
327 history for any packages which have been newly pushed and have not yet
328 been published.
329 .TP
330 .BR --ignore-dirty
331 Do not complain if the working tree does not match your git HEAD.
332 This can be useful with build, if you plan to commit later.  (dgit
333 push will still ensure that the .dsc you upload and the git tree
334 you push are identical, so this option won't make broken pushes.)
335 .TP
336 .BR --overwrite =\fIprevious-version\fR
337 Declare that even though your git branch is not a descendant
338 of the version in the archive
339 according to the revision history,
340 it really does contain
341 all the (wanted) changes from that version.
343 This option is useful if you are the maintainer, and you have
344 incorporated NMU changes into your own git workflow in a way that
345 doesn't make your branch a fast forward from the NMU.
347 .I previous-version
348 ought to be the version currently in the archive.  If
349 .I previous-version
350 is not
351 specified, dgit will check that the version in the archive is
352 mentioned in your debian/changelog.
353 (This will avoid losing
354 changes unless someone committed to git a finalised changelog
355 entry, and then made later changes to that version.)
357 dgit push --overwrite
358 will make a
359 pseudo-merge (that is, something that looks like the result
360 of git merge -s ours) to stitch the archive's version into your own
361 git history, so that your push is a fast forward from the archive.
363 (In quilt mode
364 .BR gbp ", " dpm " or " unpatched ,
365 implying a split between the dgit view and the
366 maintainer view, the pseudo-merge will appear only in the dgit view.)
367 .TP
368 .BI --deliberately- something
369 Declare that you are deliberately doing
370 .IR something .
371 This can be used to override safety catches, including safety catches
372 which relate to distro-specific policies.  The meanings of
373 .IR something s
374 understood in the context of Debian are discussed below:
375 .TP
376 .BR --deliberately-not-fast-forward
377 Declare that you are deliberately rewinding history.  When pushing to
378 Debian, use this when you are making a renewed upload of an entirely
379 new source package whose previous version was not accepted for release
380 from NEW because of problems with copyright or redistributibility.
381 .TP
382 .BR --deliberately-include-questionable-history
383 Declare that you are deliberately including, in the git history of
384 your current push, history which contains a previously-submitted
385 version of this package which was not approved (or has not yet been
386 approved) by the ftpmasters.  When pushing to Debian, only use this
387 option after verifying that: none of the rejected-from-NEW (or
388 never-accepted) versions in the git history of your current push, were
389 rejected by ftpmaster for copyright or redistributability reasons.
390 .TP
391 .BR --deliberately-fresh-repo
392 Declare that you are deliberately rewinding history and want to
393 throw away the existing repo.  Not relevant when pushing to Debian,
394 as the Debian server will do this automatically when necessary.
395 .TP
396 .BR --quilt=linear
397 When fixing up source format `3.0 (quilt)' metadata, insist on
398 generating a linear patch stack.  If such a stack cannot be generated,
399 fail.  This is the default for Debian.
400 .TP
401 .BR --quilt=auto
402 When fixing up source format `3.0 (quilt)' metadata, prefer to
403 generate a linear patch stack, but if that doesn't seem possible,
404 generate a single squashed patch for all the changes made in git.
405 This is not a good idea for an NMU in Debian.
406 .TP
407 .BR --quilt=smash
408 When fixing up source format `3.0 (quilt)' metadata,
409 generate a single squashed patch for all the changes made in git.
410 This is not a good idea for an NMU in Debian.
411 .TP
412 .BR --quilt=nofix
413 Check whether source format `3.0 (quilt)' metadata would need fixing
414 up, but, if it does, fail.  You must then fix the metadata yourself
415 somehow before pushing.  (NB that dpkg-source --commit will not work
416 because the dgit git tree does not have a
417 .B .pc
418 directory.)
419 .TP
420 .BR --quilt=nocheck " | " --no-quilt-fixup
421 Do not check whether up source format `3.0 (quilt)' metadata needs
422 fixing up.  If you use this option and the metadata did in fact need
423 fixing up, dgit push will fail.
424 .TP
425 .BR --quilt=gbp " | " --quilt=dpm " | " --quilt=unapplied
426 Tell dgit that you are using a nearly-dgit-compatible git branch,
427 aka a
428 .BR "maintainer view" ,
429 and
430 do not want your branch changed by dgit.
432 .B --quilt=gbp
433 is for use with git-buildpackage.
434 Your HEAD is expected to be
435 a patches-unapplied git branch, except that it might contain changes
436 to upstream .gitignore files.  This is the default for dgit gbp-build.
438 .B --quilt=dpm
439 is for use with git-dpm.
440 Your HEAD is expected to be
441 a patches-applied git branch,
442 except that it might contain changes to upstream .gitignore files.
444 .B --quilt=unapplied
445 specifies that your HEAD is a patches-unapplied git branch (and
446 that any changes to upstream .gitignore files are represented as
447 patches in debian/patches).
449 Instead, dgit quilt-fixup and dgit-push will automatically
450 convert your git branch into the right form,
451 and dgit push will push the
452 dgit-compatible form (the
453 .BR "dgit view" )
454 to the dgit git server.
455 The dgit view will be visible to you
456 in the dgit remote tracking branches, but your own branch will
457 not be modified.
458 dgit will create a tag
459 .BI debian/ version
460 for the maintainer view, and the dgit tag
461 .BI archive/debian/ version
462 for the dgit view.
464 .B If you have a branch like this it is essential to specify the appropriate --quilt= option!
465 This is because it is not always possible to tell: a patches-unapplied
466 git branch of a package with one patch, for example, looks just the
467 same as a patches-applied branch where the user has used git revert to
468 undo the patch, expecting to actually revert it.
469 If you fail to specify the right \-\-quilt option,
470 and you aren't too lucky, dgit will notice the problem and stop,
471 with a useful hint. 
472 .TP
473 .BI -D
474 Prints debugging information to stderr.  Repeating the option produces
475 more output (currently, up to -DDDD is meaningfully different).
476 .TP
477 .BI -c name = value
478 Specifies a git configuration option, to be used for this run.
479 dgit itself is also controlled by git configuration options.
480 .TP
481 .RI \fB-v\fR version "|\fB_\fR | " \fB--since-version=\fR version |\fB_\fR
482 Specifies the
483 .BI -v version
484 option to pass to dpkg-genchanges, during builds.  Changes (from
485 debian/changelog) since this version will be included in the built
486 changes file, and hence in the upload.  If this option is not
487 specified, dgit will query the archive and use the latest version
488 uploaded to the intended suite.
490 Specifying
491 .B _
492 inhibits this, so that no -v option will be passed to dpkg-genchanges
493 (and as a result, only the last stanza from debian/changelog will
494 be used for the build and upload).
495 .TP
496 .RI \fB-m\fR maintaineraddress
497 Passed to dpkg-genchanges (eventually).
498 .TP
499 .RI \fB--ch:\fR option
500 Specifies a single additional option to pass, eventually, to
501 dpkg-genchanges.
502 .TP
503 .RI \fB--curl=\fR program " | \fB--dput=\fR" program  " |..."
504 Specifies alternative programs to use instead of
505 .BR curl ,
506 .BR dput ,
507 .BR debsign ,
508 .BR dpkg-source ,
509 .BR dpkg-buildpackage ,
510 .BR dpkg-genchanges ,
511 .BR sbuild ,
512 .BR gpg ,
513 .BR ssh ,
514 .BR dgit ,
515 .BR git ,
516 .BR gbp-pq ,
517 .BR gbp-build ,
518 or
519 .BR mergechanges .
521 For
522 .BR dpkg-buildpackage ,
523 .BR dpkg-genchanges ,
524 .B mergechanges
525 and
526 .BR sbuild ,
527 this applies only when the program is invoked directly by dgit.
529 For
530 .BR dgit ,
531 specifies the command to run on the remote host when dgit
532 rpush needs to invoke a remote copy of itself.  (dgit also reinvokes
533 itself as the EDITOR for dpkg-source --commit; this is done using
534 argv[0], and is not affected by --dgit=).
536 .BR gbp-build 's
537 value
538 is used instead of gbp build or git-buildpackage.  (The default is
539 the latter unless the former exists on PATH.)
540 .BR gbp-pq 's
541 value
542 is used instead of gbp pq.
543 In both cases,
544 unusually, the specified value is split on whitespace
545 to produce a command and possibly some options and/or arguments.
547 For
548 .BR ssh ,
549 the default value is taken from the
551 or
552 .B GIT_SSH
553 environment variables, if set (see below).  And, for ssh, when accessing the
554 archive and dgit-repos, this command line setting is overridden by the
555 git config variables
556 .BI dgit-distro. distro .ssh
557 and
558 .B .dgit.default.ssh
559 (which can in turn be overridden with -c).  Also, when dgit is using
560 git to access dgit-repos, only git's idea of what ssh to use (eg,
561 .BR GIT_SSH )
562 is relevant.
563 .TP
564 .RI \fB--curl:\fR option " | \fB--dput:\fR" option " |..."
565 Specifies a single additional option to pass to
566 .BR curl ,
567 .BR dput ,
568 .BR debsign ,
569 .BR dpkg-source ,
570 .BR dpkg-buildpackage ,
571 .BR dpkg-genchanges ,
572 .BR sbuild ,
573 .BR ssh ,
574 .BR dgit ,
575 .BR gbp-pq ,
576 .BR gbp-build ,
577 or
578 .BR mergechanges .
579 Can be repeated as necessary.
581 For dpkg-buildpackage, dpkg-genchanges, mergechanges and sbuild,
582 this applies only when the program is invoked directly by dgit.
583 Usually, for passing options to dpkg-genchanges, you should use
584 .BR --ch: \fIoption\fR.
586 Specifying --git not effective for some lower-level read-only git
587 operations performed by dgit, and also not when git is invoked by
588 another program run by dgit.
590 See notes above regarding ssh and dgit.
592 NB that --gpg:option is not supported (because debsign does not
593 have that facility).
594 But see
595 .B -k
596 and the
597 .B keyid
598 distro config setting.
599 .TP
600 .BR -d "\fIdistro\fR | " --distro= \fIdistro\fR
601 Specifies that the suite to be operated on is part of distro
602 .IR distro .
603 This overrides the default value found from the git config option
604 .BR dgit-suite. \fIsuite\fR .distro .
605 The only effect is that other configuration variables (used
606 for accessing the archive and dgit-repos) used are
607 .BR dgit-distro. \fIdistro\fR .* .
609 If your suite is part of a distro that dgit already knows about, you
610 can use this option to make dgit work even if your dgit doesn't know
611 about the suite.  For example, specifying
612 .B -ddebian
613 will work when the suite is an unknown suite in the Debian archive.
615 To define a new distro it is necessary to define methods and URLs
616 for fetching (and, for dgit push, altering) a variety of information both
617 in the archive and in dgit-repos.
618 How to set this up is not yet documented.
619 .TP
620 .BI -C changesfile
621 Specifies the .changes file which is to be uploaded.  By default
622 dgit push looks for single .changes file in the parent directory whose
623 filename suggests it is for the right package and version.
625 If the specified
626 .I changesfile
627 pathname contains slashes, the directory part is also used as
628 the value for
629 .BR --build-products-dir ;
630 otherwise, the changes file is expected in that directory (by
631 default, in
632 .BR .. ).
633 .TP
634 .B --rm-old-changes
635 When doing a build, delete any changes files matching
636 .IB package _ version _*.changes
637 before starting.  This ensures that
638 dgit push (and dgit sbuild) will be able to unambigously
639 identify the relevant changes files from the most recent build, even
640 if there have been previous builds with different tools or options.
641 The default is not to remove, but
642 .B \-\-no-rm-old-changes
643 can be used to override a previous \-\-rm-old-changes
644 or the .rm-old-changes configuration setting.
645 .TP
646 .BI --build-products-dir= directory
647 Specifies where to find the built files to be uploaded.
648 By default, dgit looks in the parent directory
649 .RB ( .. ).
650 .TP
651 .BI --existing-package= package
652 dgit push needs to canonicalise the suite name.  Sometimes, dgit
653 lacks a way to ask the archive to do this without knowing the
654 name of an existing package.  Without --new we can just use the
655 package we are trying to push.  But with --new that will not work, so
656 we guess
657 .B dpkg
658 or use the value of this option.  This option is not needed with the
659 default mechanisms for accessing the archive.
660 .TP
661 .BR -h | --help
662 Print a usage summary.
663 .TP
664 .BI --initiator-tempdir= directory
665 dgit rpush uses a temporary directory on the invoking (signing) host.
666 This option causes dgit to use
667 .I directory
668 instead.  Furthermore, the specified directory will be emptied,
669 removed and recreated before dgit starts, rather than removed
670 after dgit finishes.  The directory specified must be an absolute
671 pathname.
672 .TP
673 .BI --no-rm-on-error
674 Do not delete the destination directory if clone fails.
676 It is always possible with dgit to clone or fetch a package, make
677 changes in git (using git-commit) on the suite branch
678 .RB ( "git checkout dgit/" \fIsuite\fR)
679 and then dgit push.  You can use whatever gitish techniques you like
680 to construct the commits to push;
681 the only requirement is that what you push is a
682 descendant of the state of the archive, as provided by dgit in the
683 remote tracking branch
684 .BR remotes/dgit/dgit/ \fIsuite\fR.
686 If you are using dgit to do an NMU (in Debian),
687 and don't know about the
688 maintainers' preferred packaging workflows, you should make your
689 changes as a linear series of (logicially separated) commits on top of
690 what's already in the archive.
692 If you are lucky the other uploaders have also used dgit and
693 integrated the other relevant git history; if not you can fetch it
694 into your tree and cherry-pick etc. as you wish.
696 If you are the maintainer of a package dealing with uploads made
697 without dgit, you will probably want to merge the synthetic commits
698 (made by dgit to represent the uploads) into your git history.
699 Normally you can just merge the dgit branch into your own master, or
700 indeed if you do your work on the dgit local suite branch
701 .BI dgit/ suite
702 you can just use dgit pull.
704 However the first time dgit is used it will generate a new origin
705 commit from the archive which won't be linked into the rest of your
706 git history.  You will need to merge this.
708 If last upload was in fact made with git, you should usually proceed
709 as follows: identify the commit which was actually used to build the
710 package.  (Hopefully you have a tag for this.)  Check out the dgit
711 branch
712 .RB ( "git checkout dgit/" \fIsuite\fR)
713 and merge that other commit
714 .RB ( "git merge debian/" \fIversion\fR).
715 Hopefully this merge will be trivial because the two trees should
716 be very similar.  The resulting branch head can be merged into your
717 working branches
718 .RB ( "git checkout master && git merge dgit/" \fIsuite\fR).
720 If last upload was not made with git, a different approach is required
721 to start using dgit.  First, do
722 .B dgit fetch
723 (or clone) to obtain a git history representation of what's in the
724 archive and record it in the
725 .BI remotes/dgit/dgit/ suite
726 tracking branch.  Then somehow, using your other git history
727 plus appropriate diffs and cherry picks from the dgit remote tracking
728 branch, construct a git commit whose tree corresponds to the tree to use for the
729 next upload. 
731 between what's in the archive and what you intend to upload.
732 Then run
733 .BR "dgit push"
734 to actually upload the result.
736 If the commit-to-be-uploaded is not a descendant of the
737 dgit remote tracking branch, you will need to pass
738 .B --overwrite
739 to dgit.
741 dgit can be configured via the git config system.
742 You may set keys with git-config (either in system-global or per-tree
743 configuration), or provide
744 .BI -c key = value
745 on the dgit command line.
746 .LP
747 Settings likely to be useful for an end user include:
748 .TP
749 .BR dgit-suite. \fIsuite\fR .distro " \fIdistro\fR"
750 Specifies the distro for a suite.  dgit keys off the suite name (which
751 appears in changelogs etc.), and uses that to determine the distro
752 which is involved.  The config used is thereafter that for the distro.
753 .TP
754 .BI dgit.default.distro " distro"
755 The default distro for an unknown suite.
756 .TP
757 .BR dgit.default. *
758 for each
759 .BR dgit-distro. \fIdistro\fR . *,
760 the default value used if there is no distro-specific setting.
761 .TP
762 .BR dgit-distro. \fIdistro\fR .clean-mode
763 One of the values for the command line --clean= option; used if
764 --clean is not specified.
765 .TP
766 .BR dgit-distro. \fIdistro\fR .quilt-mode
767 One of the values for the command line --quilt= option; used if
768 --quilt is not specified.
769 .TP
770 .BR dgit-distro. \fIdistro\fR .rm-old-changes
771 Boolean, used if neither \-\-rm-old-changes nor \-\-no-rm-old-changes
772 is specified.  The default is not to remove.
773 .TP
774 .BR dgit-distro. \fIdistro\fR .readonly " " auto | a " | " true | t | y | 1 " | " false | f | n | 0
775 Whether you have push access to the distro.
776 For Debian, it is OK to use auto, which uses readonly mode if you are
777 not pushing right now;
778 but, setting this to false will avoid relying on the mirror of the dgit
779 git repository server.
780 .TP
781 .BI dgit-distro. distro .keyid
782 See also
783 .BR -k .
784 .TP
785 .BI dgit-distro. distro .mirror " url"
786 .TP
787 .BI dgit-distro. distro .username
788 Not relevant for Debian.
789 .TP
790 .BI dgit-distro. distro .upload-host
791 Might be useful if you have an intermediate queue server.
792 .TP
793 .BI dgit-distro. distro .user-name " " dgit-distro. distro .user-email
794 Values to configure for and in new git trees.  If
795 not specified, the DEBFULLNAME and DEBEMAIL environment variables are
796 used, respectively.  Only used if .setup-usermail is not disabled.
797 .TP
798 .BI dgit-distro. distro .setup-useremail
799 Whether to set and in new git trees.
800 True by default.  Ignored for dgit setup-setup-useremail, which does it anyway.
801 .TP
802 .BI dgit-distro. distro .setup-mergechangelogs
803 Whether to setup a merge driver which uses dpkg-mergechangelogs for
804 debian/changelog.  True by default.  Ignored for dgit
805 setup-mergechangelogs, which does it anyway.
806 .TP
807 .BI dgit-distro. distro .cmd- cmd
808 Program to use instead of
809 .IR cmd .
810 Works like
811 .BR -- \fIcmd\fR = "... ."
812 .TP
813 .BI dgit-distro. distro .opts- cmd
814 Extra options to pass to
815 .IR cmd .
816 Works like
817 .BR -- \fIcmd\fR : "... ."
818 To pass several options, configure multiple values in git config
819 (with git config --add).  The options for
820 .BI dgit.default.opts- cmd
821 .BI dgit-distro. distro /push.opts- cmd
822 and are all used, followed by options from dgit's command line.
824 There are many other settings which specify how a particular distro's
825 services (archive and git) are provided.  These should not normally be
826 adjusted, but are documented for the benefit of distros who wish to
827 adopt dgit.
828 .TP
829 .BR dgit-distro. \fIdistro\fR /push. *
830 If set, overrides corresponding non \fB/push\fR config when
831 .BR readonly=false ,
832 or when pushing and
833 .BR readonly=auto .
834 .TP
835 .BI dgit-distro. distro .git-url
836 .TP
837 .BR dgit-distro. \fIdistro\fR .git-url [ -suffix ]
838 .TP
839 .BI dgit-distro. distro .git-proto
840 .TP
841 .BI dgit-distro. distro .git-path
842 .TP
843 .BR dgit-distro. \fIdistro\fR .git-check " " true | false | url | ssh-cmd
844 .TP
845 .BI dgit-distro. distro .git-check-suffix
846 .TP
847 .BR dgit-distro. \fIdistro\fR .diverts.divert " " new-distro | / \fIdistro-suffix\fR
848 .TP
849 .BI dgit-distro. distro .git-create " " ssh-cmd | true
850 .TP
851 .BR dgit-distro. \fIdistro\fR .archive-query " " ftpmasterapi: " | " madison: "\fIdistro\fR | " dummycat: "\fI/path\fR  | " sshpsql: \fIuser\fR @ \fIhost\fR : \fIdbname\fR
852 .TP
853 .BR dgit-distro. \fIdistro\fR .archive-query- ( url | tls-key | curl-ca-args )
854 .TP
855 .BI dgit-distro. distro .madison-distro
856 .TP
857 .BI dgit-distro. distro .archive-query-default-component
858 .TP
859 .BI dgit-distro. distro .dgit-tag-format
860 .TP
861 .BI dgit-distro. distro .ssh
862 .TP
863 .BI dgit-distro. distro .sshpsql-dbname
864 .TP
865 .BR dgit-distro. \fIdistro\fR . ( git | sshpsql ) - ( user | host | user-force )
866 .TP
867 .BI dgit-distro. distro .backports-quirk
869 .TP
871 specify an alternative default program (and perhaps arguments) to use
872 instead of ssh.  DGIT_SSH is consulted first and may contain arguments;
873 if it contains any whitespace will be passed to the shell.  GIT_SSH
874 specifies just the program; no arguments can be specified, so dgit
875 interprets it the same way as git does.
876 See
877 also the --ssh= and --ssh: options.
878 .TP
880 Default git and for new trees.  See
881 .BR "dgit setup-new-tree" .
882 .TP
883 .BR gpg ", " dpkg- "..., " debsign ", " git ", " curl ", " dput ", " LWP::UserAgent
884 and other subprograms and modules used by dgit are affected by various
885 environment variables.  Consult the documentaton for those programs
886 for details.
887 .SH BUGS
888 dgit's git representation of format `3.0 (quilt)' source packages does
889 not represent the patch stack as git commits.  Currently the patch
890 series representation cannot round trip between git and the archive.
891 Ideally dgit would represent a quilty package with an origin commit of
892 some kind followed by the patch stack as a series of commits followed
893 by a pseudo-merge (to make the branch fast-forwarding).  This would
894 also mean a new `dgit rebase-prep' command or some such to turn such a
895 fast-forwarding branch back into a rebasing patch stack, and a `force'
896 option to dgit push (perhaps enabled automatically by a note left by
897 rebase-prep) which will make the required pseudo-merge.
899 If the dgit push fails halfway through, it should be restartable and
900 idempotent.  However this is not true for the git tag operation.
901 Also, it would be good to check that the proposed signing key is
902 available before starting work.
904 dgit's handling of .orig.tar.gz is not very sophisticated.  Ideally
905 the .orig.tar.gz could be transported via the git repo as git tags.
906 Doing this is made more complicated by the possibility of a `3.0
907 (quilt)' package with multiple .orig tarballs.
909 dgit's build functions, and dgit push, should not make any changes to
910 your current HEAD.  Sadly this is necessary for packages in the `3.0
911 (quilt)' source format.  This is ultimately due to what I consider
912 design problems in quilt and dpkg-source.
914 There should be an option which arranges for the `3.0 (quilt)'
915 autocommit(s) to not appear on your HEAD, but instead only in the
916 remote tracking suite branch.
918 --dry-run does not always work properly, as not doing some of the git
919 fetches may result in subsequent actions being different.  Doing a
920 non-dry-run dgit fetch first will help.
922 \fBdgit\fP(7),
923 \fBcurl\fP(1),
924 \fBdput\fP(1),
925 \fBdebsign\fP(1),
926 \fBgit-config\fP(1),
927 \fBgit-buildpackage\fP(1),
928 \fBdpkg-buildpackage\fP(1),
929 .br