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]
   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
  16 [\fIgit\-buildpackage\-opts\fP|\fIdpkg\-buildpackage\-opts\fp]
  17 .br
  18 .B dgit
  19 [\fIdgit\-opts\fP] \fBpush\fP [\fIdgit\-opts\fP]
  20 [\fIsuite\fP]
  21 .SH DESCRIPTION
  22 .B dgit
  23 treats the Debian archive as a version control system, and
  24 bidirectionally gateways between the archive and git.  The git view of
  25 the package can contain the usual upstream git history, and will be
  26 augmented by commits representing uploads done by other developers not
  27 using dgit.  This git history is stored in a canonical location known
  28 as
  29 .B dgit-repos
  30 which lives outside the Debian archive (currently, on Alioth).
  31
  32 .B dgit clone
  33 and
  34 .B dgit fetch
  35 consult the archive and dgit-repos and fetch and/or construct the
  36 git view of the history.  With clone, the destination directory (by
  37 default, the package name in the current directory) will be created,
  38 and the new directory's `origin' remote will be set up to point to
  39 the package's dgit-repos tree.
  40
  41 .B dgit build
  42 runs
  43 .B git-buildpackage
  44 with some suitable options.  Options after
  45 .B build
  46 will be passed on to git-buildpackage.  It is not necessary to
  47 use dgit build; it is OK to use any approach which ensures that
  48 the generated source package corresponds to the relevant git commit.
  49 Tagging and signing should be left to dgit push.
  50
  51 .B dgit push
  52 does an `upload', pushing the current HEAD to the archive (as a source
  53 package) and to dgit-repos (as git commits).  This also involves
  54 making a signed git tag, and signing the files to be uploaded to the
  55 archive.
  56 .SH MODEL AND WORKFLOW
  57 You may use any suitable git workflow with dgit, provided you
  58 satisfy dgit's requirements:
  59
  60 dgit maintains a pseudo-remote called
  61 .BR dgit ,
  62 with one branch per suite.  This remote cannot be used with
  63 plain git.
  64
  65 The
  66 .B dgit-repos
  67 repository for each package contains one ref per suite named
  68 \fBrefs/dgit/\fR\fIsuite\fR.  These should be pushed to only by
  69 dgit.  They are fast forwarding.  Each push on this branch
  70 corresponds to an upload (or attempted upload).
  71
  72 However, it is perfectly fine to have other branches in dgit-repos;
  73 normally the dgit-repos repo for the package will be accessible via
  74 the remote name `origin'.
  75
  76 dgit push can operate on any commit which is a descendant of the
  77 current dgit/suite tip in dgit-repos.
  78
  79 Uploads made by dgit contain an additional field
  80 .B Vcs-Dgit-Master
  81 in the source package .dsc.  (This is added by dgit push.)
  82 This specifies a commit (an ancestor of the dgit/suite
  83 branch) whose tree is identical to the unpacked source upload.
  84
  85 Uploads not made by dgit are represented in git by commits which are
  86 synthesised by dgit.  The tree of each such commit corresponds to the
  87 unpacked source; the single parent is the last known upload - that is,
  88 the contents of the dgit/suite branch.
  89
  90 dgit expects repos that it works with to have a
  91 .B dgit
  92 remote.  This refers to the well-known dgit-repos location
  93 (currently, the dgit-repos project on Alioth).  dgit fetch updates
  94 the remote tracking branch for dgit/suite.
  95 .SH OPTIONS
  96 .TP
  97 .BR --dry-run | -n
  98 Go through the motions, fetching all information needed, but do not
  99 actually update the output(s).  For push, dgit does
 100 the required checks and leaves the new .dsc in a temporary file,
 101 but does not sign, tag, push or upload.
 102 .TP
 103 .BI -k keyid
 104 Use
 105 .I keyid
 106 for signing the tag and the upload.
 107 .TP
 108 .BR --no-sign
 109 does not sign tags or uploads (meaningful only with push).
 110 .TP
 111 .TP
 112 .BI -p package
 113 Specifies that we should process source package
 114 .I package
 115 rather than looking in debian/control or debian/changelog.
 116 Valid with dgit fetch and dgit pull, only.
 117 .TP
 118 .BR -N | --new
 119 The package may be new in this suite.  Without this, dgit will
 120 refuse to push.
 121 .TP
 122 .BI -D
 123 Prints debugging information to stderr.  Repeating the option produces
 124 more output (currently, up to -DD is meaningfully different).
 125 .TP
 126 .BI -c name = value
 127 Specifies a git configuration option.  dgit itself is also controlled
 128 by git configuration options.
 129 .TP
 130 .RI \fB--dget=\fR program |\fB--dput=\fR program |\fB--debsign=\fR program
 131 Specifies alternative programs to use instead of dget, dput
 132 or debsign.
 133 .TP
 134 .RI \fB--dget:\fR option |\fB--dput:\fR option |\fB--debsign:\fR option
 135 Specifies a single additional option to pass to dget, dput or
 136 debsign.  Use repeatedly if multiple additional options are required.
 137 .TP
 138 .BI -C changesfile
 139 Specifies the .changes file which is to be uploaded.  By default
 140 dgit push looks for single .changes file in the parent directory whose
 141 filename suggests it is for the right package and version.
 142 .TP
 143 .BI --existing-package= package
 144 dgit push needs to canonicalise the suite name.  But currently
 145 there is no way to ask the archive to do this without knowing the
 146 name of an existing package.  Without --new we can just use the
 147 package we are trying to push.  But with --new that will not work, so
 148 we guess that
 149 .B dpkg
 150 exists in the target suite.  If it doesn't, you can use this option to
 151 specify a package which does.  If the suite is empty, bad luck.
 152 .SH CONFIGURATION
 153 dgit looks at the following git config keys to control its behaviour.
 154 You may set them with git-config (either in system-global or per-tree
 155 configuration), or provide
 156 .BI -c key = value
 157 on the dgit command line.
 158 .TP
 159 .BI dgit-suite. suite .distro
 160 .TP
 161 .BI dgit.default.distro
 162 .TP
 163 .BI dgit.default.username
 164 .TP
 165 .BI dgit-distro. distro .git-url
 166 .TP
 167 .BI dgit-distro. distro .git-host
 168 .TP
 169 .BI dgit-distro. distro .git-proto
 170 .TP
 171 .BI dgit-distro. distro .git-path
 172 .TP
 173 .BI dgit-distro. distro .git-check
 174 .TP
 175 .BI dgit-distro. distro .git-create
 176 .TP
 177 .BI dgit-distro. distro .upload-host
 178 .TP
 179 .BI dgit-distro. distro .mirror
 180 .TP
 181 .BI dgit-distro. distro .archive-query
 182 .TP
 183 .BI dgit-distro. distro .archive-query-default-component
 184 .TP
 185 .BI dgit-distro. distro .ssh
 186 .TP
 187 .BR dgit.default. *
 188 for each
 189 .BR dgit-distro. \fIdistro\fR . *
 190 .SH BUGS
 191 We should be using some kind of vhost/vpath setup for the git repos on
 192 alioth, so that they can be moved later if and when this turns out to
 193 be a good idea.
 194
 195 Debian Policy needs to be updated to describe the new Vcs-Dgit-Master
 196 field (and to specify that it is an RC bug for that field to refer
 197 to an unavailable commit).
 198
 199 The method of canonicalising suite names is bizarre.  See the
 200 .B --existing-package
 201 option for one of the implication.s
 202
 203 dgit push should perhaps do `git push origin', or something similar,
 204 by default.
 205
 206 The mechanism for checking for and creating per-package repos on
 207 alioth is a hideous bodge.  One consequence is that dgit currently
 208 only works for people with push access.
 209
 210 Debian Maintainers are currently not able to push, as there is not
 211 currently any mechanism for determining and honouring the archive's
 212 ideas about access control.  Currently only DDs can push.
 213
 214 dgit's representation of format `3.0 (quilt)' source packages does not
 215 represent the patch stack.  Currently the patch series representation
 216 cannot round trip through the archive.  Ideally dgit would represent a
 217 quilty package with an origin commit of some kind followed by the
 218 patch stack as a series of commits followed by a pseudo-merge (to make
 219 the branch fast-forwarding).  This would also mean a new `dgit
 220 rebase-prep' command or some such to turn such a fast-forwarding
 221 branch back into a rebasing patch stack, and a `force' option to dgit
 222 push (perhaps enabled automatically by a note left by rebase-prep)
 223 which will make the required pseudo-merge.
 224
 225 If the dgit push fails halfway through, it should be restartable and
 226 idempotent.  However this is not true for the git tag operation.
 227 Also, it would be good to check that the proposed signing key is
 228 available before starting work.
 229
 230 dgit's handling of .orig.tar.gz is not very sophisticated.  Ideally
 231 the .orig.tar.gz could be transported via the git repo as git tags.
 232 Doing this is made more complicated by the possibility of a `3.0
 233 (quilt)' package with multiple .orig tarballs.
 234
 235 The error messages are often unhelpfully terse and tend to refer to
 236 line numbers in dgit.
 237
 238 The option parser requires values to be cuddled to the option name.
 239
 240 dgit assumes knowledge of the archive layout.  There appears to be no
 241 sane way to find the path in the archive pool of the .dsc for a
 242 particular suite.  I'm assured that the archive layout is a
 243 `well known algorithm' by now.
 244
 245 --dry-run often does not work with fetch, even though this is a
 246 logically plausible request.  (It fails, instead.)