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