X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=dgit.git;a=blobdiff_plain;f=dgit.1;h=6d46b20a4c7887158a567a89f90a82db53176e0a;hp=9878c20e258492d247a749ede48473d0ab1013f9;hb=bcca6a6dfc34e624274055ed1dd3fc3371a539a4;hpb=54f843c7e1644527e902e01eb401e98a02c44889 diff --git a/dgit.1 b/dgit.1 index 9878c20e..6d46b20a 100644 --- a/dgit.1 +++ b/dgit.1 @@ -17,7 +17,7 @@ dgit \- git integration with the Debian archive [\fIbuild\-opts\fp] .br .B dgit -[\fIdgit\-opts\fP] \fBpush\fP [\fIdgit\-opts\fP] +[\fIdgit\-opts\fP] \fBpush\fP|\fBpush-source\fP [\fIdgit\-opts\fP] [\fIsuite\fP] .br .B dgit @@ -30,6 +30,10 @@ dgit \- git integration with the Debian archive .B dgit allows you to treat the Debian archive as if it were a git repository. +Conversely, +it allows Debian to publish the source of its packages +as git branches, in a format which is directly useable +by ordinary people. This is the command line reference. Please read the tutorial(s): @@ -73,6 +77,11 @@ for the distro to which .I suite belongs. +.I suite +may be a combination of several underlying suites in the form +.IR mainsuite \fB,\fR subsuite ...; +see COMBINED SUITES in dgit(7). + For your convenience, the .B vcs-git remote will be set up from the package's Vcs-Git field, if there is @@ -90,6 +99,7 @@ then dgit fetch defaults to .IR suite ; otherwise it parses debian/changelog and uses the suite specified there. +suite may be a combined suite, as for clone. .TP \fBdgit pull\fR [\fIsuite\fP] Does dgit fetch, and then merges the new head of the remote tracking @@ -117,7 +127,8 @@ The output is left in and .IR package \fB_\fR version \fB_source.changes\fR. -Tagging, signing and actually uploading should be left to dgit push. +Tagging, signing and actually uploading should be left to dgit +push-source, or dgit push. .TP .B dgit clean Cleans the current working tree (according to the --clean= option in @@ -134,7 +145,11 @@ binary changes files. Options and arguments after sbuild will be passed on to sbuild. The output is left in .IR package \fB_\fR version \fB_multi.changes\fR. - +.IP +Note that by default +sbuild does not build arch-independent packages. +You probably want to pass -A, to request those. +.IP Tagging, signing and actually uploading should be left to dgit push. .TP \fBdgit gbp-build\fR ... @@ -170,9 +185,14 @@ archive. dgit push always uses the package, suite and version specified in the debian/changelog and the .dsc, which must agree. If the command line specifies a suite then that must match too. +.TP +\fBdgit push-source\fR [\fIsuite\fP] +Without \fB-C\fR, builds a source package and dgit pushes it. Saying +\fBdgit push-source\fR is like saying "update the source code in the +archive to match my git HEAD, and let the autobuilders do the rest." -If dgit push fails while uploading, it is fine to simply retry the -dput on the .changes file at your leisure. +With \fB-C\fR, performs a dgit push, additionally ensuring that no +binary packages are uploaded. .TP \fBdgit rpush\fR \fIbuild-host\fR\fB:\fR\fIbuild-dir\fR [\fIpush args...\fR] Pushes the contents of the specified directory on a remote machine. @@ -181,15 +201,14 @@ current directory; however, signing operations are done on the invoking host. This allows you to do a push when the system which has the source code and the build outputs has no access to the key: +.TS +l l. 1. Clone on build host (dgit clone) -.br 2. Edit code on build host (edit, git commit) -.br 3. Build package on build host (dgit build) -.br 4. Test package on build host or elsewhere (dpkg -i, test) -.br 5. Upload by invoking dgit rpush on host with your GPG key. +.TE However, the build-host must be able to ssh to the dgit repos. If this is not already the case, you must organise it separately, for @@ -210,9 +229,10 @@ public key in its keyring (but not your private key, obviously). .B dgit setup-new-tree Configure the current working tree the way that dgit clone would have set it up. Like running -.B dgit setup-useremail -and +.BR "dgit setup-useremail" , .B setup-mergechangelogs +and +.B setup-gitattributes (but only does each thing if dgit is configured to do it automatically). You can use these in any git repository, not just ones used with the other dgit operations. @@ -229,6 +249,29 @@ Configures a git merge helper for the file which uses .BR dpkg-mergechangelogs . .TP +.B dgit setup-gitattributes +Set up the working tree's +.B .git/info/attributes +to disable all transforming attributes for all files. +This is done by defining a macro attribute +.B dgit-defuse-attrs +and applying it to +.BR * . +For why, see +.B GITATTRIBUTES +in +.BR dgit(7) . + +(If there is already a macro attribute line +.B [attr]dgit-defuse-attrs +in .git/info/attributes +(whatever its effects), +this operation does nothing further. +This fact can be used to defeat or partially defeat +dgit setup-gitattributes +and hence +dgit setup-new-tree.) +.TP .B dgit quilt-fixup `3.0 (quilt)' format source packages need changes representing not only in-tree but also as patches in debian/patches. dgit quilt-fixup @@ -261,6 +304,16 @@ and it therefore does not make a pseudomerge to bind the import into any existing git history. +Because a .dsc can contain a Dgit field naming a git commit +(which you might not have), +and specifying where to find that commit +(and any history rewrite table), +import-dsc might need online access. +If this is a problem +(or dgit's efforts to find the commit fail), +consider --no-chase-dsc-distro +or --force-import-dsc-with-dgit-field. + There is only only sub-option: .B --require-valid-signature @@ -291,12 +344,6 @@ dgit will stop with an error message. If .I branch does not start with refs/, refs/heads/ is prepended. -The specified branch is unconditionally updated. - -If the specified .dsc contains a Dgit field, -dgit will simply make a branch of that commit. -If you cannot manage to find that commit anywhere, -consider --force-import-dsc-with-dgit-field. .TP .B dgit version Prints version information and exits. @@ -304,6 +351,18 @@ Prints version information and exits. .BI "dgit clone-dgit-repos-server" " destdir" Tries to fetch a copy of the source code for the dgit-repos-server, as actually being used on the dgit git server, as a git tree. +.TP +.BI "dgit print-dgit-repos-server-source-url" +Prints the url used by dgit clone-dgit-repos-server. +This is hopefully suitable for use as a git remote url. +It may not be useable in a browser. +.TP +.BI "dgit print-dpkg-source-ignores" +Prints the -i and -I arguments which must be passed to dpkg-souce +to cause it to exclude exactly the .git diredcory +and nothing else. +The separate arguments are unquoted, separated by spaces, +and do not contain spaces. .SH OPTIONS .TP .BR --dry-run " | " -n @@ -401,7 +460,7 @@ This can be useful with build, if you plan to commit later. (dgit push will still ensure that the .dsc you upload and the git tree you push are identical, so this option won't make broken pushes.) .TP -.BR --overwrite =\fIprevious-version\fR +.BR --overwrite [=\fIprevious-version\fR] Declare that even though your git branch is not a descendant of the version in the archive according to the revision history, @@ -451,6 +510,30 @@ someone should make a suitable dgit push to update the contents of dgit-repos to a version without the controversial changes. .TP +.BR --no-chase-dsc-distro +Tells dgit not to look online +for additional git repositories +containing information about a particular .dsc being imported. +Chasing is the default. + +For most operations +(such as fetch and pull), +disabling chasing +means dgit will access only the git server +for the distro you are directly working with, +even if the .dsc was copied verbatim from another distro. +For import-dsc, +disabling chasing +means dgit will work completely offline. + +Disabling chasing can be hazardous: +if the .dsc names a git commit which has been rewritten +by those in charge of the distro, +this option may prevent that rewrite from being effective. +Also, +it can mean that +dgit fails to find necessary git commits. +.TP .BR --dgit-view-save= \fIbranch\fR|\fIref\fR Specifies that when a split view quilt mode is in operation, and dgit calculates @@ -491,6 +574,17 @@ Declare that you are deliberately rewinding history. When pushing to Debian, use this when you are making a renewed upload of an entirely new source package whose previous version was not accepted for release from NEW because of problems with copyright or redistributibility. + +In split view quilt modes, +this also prevents the construction by dgit of a pseudomerge +to make the dgit view fast forwarding. +Normally only one of +--overwrite (which creates a suitable pseudomerge) +and +--deliberately-not-fast-forward +(which suppresses the pseudomerge and the fast forward checks) +should be needed; +--overwrite is usually better. .TP .BR --deliberately-include-questionable-history Declare that you are deliberately including, in the git history of @@ -651,6 +745,9 @@ The default is not to remove, but .B \-\-no-rm-old-changes can be used to override a previous \-\-rm-old-changes or the .rm-old-changes configuration setting. + +Note that \fBdgit push-source\fR will always find the right .changes, +regardless of this option. .TP .BI --build-products-dir= directory Specifies where to find the built files to be uploaded. @@ -660,6 +757,24 @@ By default, dgit looks in the parent directory .BI --no-rm-on-error Do not delete the destination directory if clone fails. .TP +.BI --dep14tag +Generates a DEP-14 tag (eg +.BR debian/ \fIversion\fR) +as well as a dgit tag (eg +.BR archive/debian/ \fIversion\fR) +where possible. This is the default. +.TP +.BI --no-dep14tag +Do not generate a DEP-14 tag, except in split quilt view mode. +(On servers where only the old tag format is supported, +the dgit tag will have the DEP-14 name. +This option does not prevent that.) +.TP +.BI --dep14tag-always +Insist on generating a DEP-14 tag +as well as a dgit tag. +If the server does not support that, dgit push will fail. +.TP .BI -D Prints debugging information to stderr. Repeating the option produces more output (currently, up to -DDDD is meaningfully different). @@ -710,6 +825,8 @@ Specifies a single additional option to pass to .BR sbuild , .BR ssh , .BR dgit , +.BR apt-get , +.BR apt-cache , .BR gbp-pq , .BR gbp-build , or @@ -755,6 +872,8 @@ Specifies alternative programs to use instead of .BR gpg , .BR ssh , .BR dgit , +.BR apt-get , +.BR apt-cache , .BR git , .BR gbp-pq , .BR gbp-build , @@ -834,7 +953,7 @@ These options are provided as an escape hatch, in case dgit is confused. (They might also be useful for testing error cases.) .TP -.B --import-dsc-with-dgit-field +.B --force-import-dsc-with-dgit-field Tell dgit import-dsc to treat a .dsc with a Dgit field like one without it. The result is a fresh import, @@ -879,10 +998,16 @@ Settings likely to be useful for an end user include: Specifies the distro for a suite. dgit keys off the suite name (which appears in changelogs etc.), and uses that to determine the distro which is involved. The config used is thereafter that for the distro. + +.I suite +may be a glob pattern. .TP .BI dgit.default.distro " distro" The default distro for an unknown suite. .TP +.BI dgit.default.default-suite " suite" +The default suite (eg for clone). +.TP .BR dgit.default. * for each .BR dgit-distro. \fIdistro\fR . *, @@ -933,6 +1058,12 @@ Whether to setup a merge driver which uses dpkg-mergechangelogs for debian/changelog. True by default. Ignored for dgit setup-mergechangelogs, which does it anyway. .TP +.BI dgit-distro. distro .setup-gitattributes +Whether to configure .git/info/attributes +to suppress checkin/checkout file content transformations +in new git trees. +True by default. Ignored for dgit setup-gitattributes, which does it anyway. +.TP .BI dgit-distro. distro .cmd- cmd Program to use instead of .IR cmd . @@ -955,6 +1086,12 @@ services (archive and git) are provided. These should not normally be adjusted, but are documented for the benefit of distros who wish to adopt dgit. .TP +.BI dgit-distro. distro .nominal-distro +Shown in git tags, Dgit fields, and so on. +.TP +.BI dgit-distro. distro .alias-canon +Used for all access configuration lookup. +.TP .BR dgit-distro. \fIdistro\fR /push. * If set, overrides corresponding non \fB/push\fR config when .BR readonly=false , @@ -987,6 +1124,8 @@ or when pushing and .TP .BI dgit-distro. distro .dgit-tag-format .TP +.BR dgit-distro. \fIdistro\fR .dep14tag " " want | no | always +.TP .BI dgit-distro. distro .ssh .TP .BI dgit-distro. distro .sshpsql-dbname @@ -994,6 +1133,16 @@ or when pushing and .BR dgit-distro. \fIdistro\fR . ( git | sshpsql ) - ( user | host | user-force ) .TP .BI dgit-distro. distro .backports-quirk +.TP +.BI dgit-distro. distro .rewrite-map-enable +.TP +.BI dgit.default.old-dsc-distro +.TP +.BI dgit.dsc-url-proto-ok. protocol +.TP +.BI dgit.dsc-url-proto-ok.bad-syntax +.TP +.BI dgit.default.dsc-url-proto-ok .SH ENVIRONMENT VARIABLES .TP .BR DGIT_SSH ", " GIT_SSH