X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=dgit.git;a=blobdiff_plain;f=dgit.1;h=0659562796a5e66b754a63a520ac6b0d58969825;hp=ffb67468160fc694cf2c87793a33f817d4221323;hb=80eae30139e06600e50a4e35f652b741a471bced;hpb=d4bd3417c76450f248952606bff7e586600e34a8 diff --git a/dgit.1 b/dgit.1 index ffb67468..06595627 100644 --- a/dgit.1 +++ b/dgit.1 @@ -127,9 +127,8 @@ Constructs the source package, uses .B sbuild to do a binary build, and uses mergechanges to merge the source and binary changes files. Options and arguments after sbuild will be -passed on to sbuild. Changes files matching -.IB package _ version _*.changes -in the parent directory will be removed; the output is left in +passed on to sbuild. +The output is left in .IR package \fB_\fR version \fB_multi.changes\fR. Tagging, signing and actually uploading should be left to dgit push. @@ -331,6 +330,38 @@ 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 +Declare that even though your git branch is not a descendant +of the version in the archive +according to the revision history, +it really does contain +all the (wanted) changes from that version. + +This option is useful if you are the maintainer, and you have +incorporated NMU changes into your own git workflow in a way that +doesn't make your branch a fast forward from the NMU. + +.I previous-version +ought to be the version currently in the archive. If +.I previous-version +is not +specified, dgit will check that the version in the archive is +mentioned in your debian/changelog. +(This will avoid losing +changes unless someone committed to git a finalised changelog +entry, and then made later changes to that version.) + +dgit push --overwrite +will make a +pseudo-merge (that is, something that looks like the result +of git merge -s ours) to stitch the archive's version into your own +git history, so that your push is a fast forward from the archive. + +(In quilt mode +.BR gbp ", " dpm " or " unpatched , +implying a split between the dgit view and the +maintainer view, the pseudo-merge will appear only in the dgit view.) +.TP .BI --deliberately- something Declare that you are deliberately doing .IR something . @@ -431,18 +462,40 @@ Specifies alternative programs to use instead of .BR ssh , .BR dgit , .BR git , +.BR gbp-pq , +.BR gbp-build , or .BR mergechanges . -For dpkg-buildpackage, dpkg-genchanges, mergechanges and sbuild, +For +.BR dpkg-buildpackage , +.BR dpkg-genchanges , +.B mergechanges +and +.BR sbuild , this applies only when the program is invoked directly by dgit. -For dgit, specifies the command to run on the remote host when dgit +For +.BR dgit , +specifies the command to run on the remote host when dgit rpush needs to invoke a remote copy of itself. (dgit also reinvokes itself as the EDITOR for dpkg-source --commit; this is done using argv[0], and is not affected by --dgit=). -For ssh, the default value is taken from the +.BR gbp-build 's +value +is used instead of gbp build or git-buildpackage. (The default is +the latter unless the former exists on PATH.) +.BR gbp-pq 's +value +is used instead of gbp pq. +In both cases, +unusually, the specified value is split on whitespace +to produce a command and possibly some options and/or arguments. + +For +.BR ssh , +the default value is taken from the .B DGIT_SSH or .B GIT_SSH @@ -468,6 +521,8 @@ Specifies a single additional option to pass to .BR sbuild , .BR ssh , .BR dgit , +.BR gbp-pq , +.BR gbp-build , or .BR mergechanges . Can be repeated as necessary. @@ -514,8 +569,7 @@ How to set this up is not yet documented. .BI -C changesfile Specifies the .changes file which is to be uploaded. By default dgit push looks for single .changes file in the parent directory whose -filename suggests it is for the right package and version - or, -if there is a _multi.changes file, dgit uses that. +filename suggests it is for the right package and version. If the specified .I changesfile @@ -526,6 +580,18 @@ otherwise, the changes file is expected in that directory (by default, in .BR .. ). .TP +.B --rm-old-changes +When doing a build, delete any changes files matching +.IB package _ version _*.changes +before starting. This ensures that +dgit push (and dgit sbuild) will be able to unambigously +identify the relevant changes files from the most recent build, even +if there have been previous builds with different tools or options. +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. +.TP .BI --build-products-dir= directory Specifies where to find the built files to be uploaded. By default, dgit looks in the parent directory @@ -609,14 +675,17 @@ archive and record it in the tracking branch. Then somehow, using your other git history plus appropriate diffs and cherry picks from the dgit remote tracking branch, construct a git commit whose tree corresponds to the tree to use for the -next upload. If that commit-to-be-uploaded is not a descendant of the -dgit remote tracking branch, check it out and say -.BR "git merge -s ours remotes/dgit/dgit/" \fIsuite\fR; -that tells git that we are deliberately throwing away any differences +next upload. + between what's in the archive and what you intend to upload. Then run .BR "dgit push" to actually upload the result. + +If the commit-to-be-uploaded is not a descendant of the +dgit remote tracking branch, you will need to pass +.B --overwrite +to dgit. .SH CONFIGURATION dgit can be configured via the git config system. You may set keys with git-config (either in system-global or per-tree @@ -634,10 +703,23 @@ which is involved. The config used is thereafter that for the distro. .BI dgit.default.distro " distro" The default distro for an unknown suite. .TP +.BR dgit.default. * +for each +.BR dgit-distro. \fIdistro\fR . *, +the default value used if there is no distro-specific setting. +.TP .BR dgit-distro. \fIdistro\fR .clean-mode One of the values for the command line --clean= option; used if --clean is not specified. .TP +.BR dgit-distro. \fIdistro\fR .quilt-mode +One of the values for the command line --quilt= option; used if +--quilt is not specified. +.TP +.BR dgit-distro. \fIdistro\fR .rm-old-changes +Boolean, used if neither \-\-rm-old-changes nor \-\-no-rm-old-changes +is specified. The default is not to remove. +.TP .BR dgit-distro. \fIdistro\fR .readonly " " auto | a " | " true | t | y | 1 " | " false | f | n | 0 Whether you have push access to the distro. For Debian, it is OK to use auto, which uses readonly mode if you are @@ -723,6 +805,8 @@ or when pushing and .TP .BI dgit-distro. distro .archive-query-default-component .TP +.BI dgit-distro. distro .dgit-tag-format +.TP .BI dgit-distro. distro .ssh .TP .BI dgit-distro. distro .sshpsql-dbname @@ -730,10 +814,6 @@ or when pushing and .BR dgit-distro. \fIdistro\fR . ( git | sshpsql ) - ( user | host | user-force ) .TP .BI dgit-distro. distro .backports-quirk -.TP -.BR dgit.default. * -for each -.BR dgit-distro. \fIdistro\fR . * .SH ENVIRONMENT VARIABLES .TP .BR DGIT_SSH ", " GIT_SSH @@ -784,8 +864,6 @@ There should be an option which arranges for the `3.0 (quilt)' autocommit(s) to not appear on your HEAD, but instead only in the remote tracking suite branch. -The option parser requires values to be cuddled to the option name. - --dry-run does not always work properly, as not doing some of the git fetches may result in subsequent actions being different. Doing a non-dry-run dgit fetch first will help.