diff options
| -rw-r--r-- | dgit.1 | 160 |
1 files changed, 80 insertions, 80 deletions
@@ -147,8 +147,8 @@ commit. Tagging, signing and actually uploading should be left to dgit push. dgit's build operations access the network, -to get the -v option right. -See -v, below. +to get the \-v option right. +See \-v, below. .TP \fBdgit build-source\fR ... Builds the source package, and a changes file for a prospective @@ -163,12 +163,12 @@ 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 +Cleans the current working tree (according to the \-\-clean= option in force). .TP -\fBdgit update-vcs-git\fR [\fIsuite\fP|\fB.\fR] [\fB--\fR] [\fIgit fetch options\fR] +\fBdgit update-vcs-git\fR [\fIsuite\fP|\fB.\fR] [\fB\-\-\fR] [\fIgit fetch options\fR] .TQ -\fBdgit update-vcs-git\fR [\fIsuite|\fP\fB.\fR] \fB-\fR +\fBdgit update-vcs-git\fR [\fIsuite|\fP\fB.\fR] \fB\-\fR Sets up, or updates the url of, the vcs-git remote, and (unless \fB-\fR was specified) runs git fetch on it. @@ -194,7 +194,7 @@ The output is left in .IP Note that by default sbuild does not build arch-independent packages. -You probably want to pass -A, to request those. +You probably want to pass \-A, to request those. .IP Tagging, signing and actually uploading should be left to dgit push. .TP @@ -206,12 +206,12 @@ binary changes files. The output is left in .IR package \fB_\fR version \fB_multi.changes\fR. -You should ensure that your dgit --build-products-dir setting matches -your pbuilder --buildresult. +You should ensure that your dgit \-\-build-products-dir setting matches +your pbuilder \-\-buildresult. -The \fIdebbuildopts\fP are passed to pbuilder using its --debbuildopts +The \fIdebbuildopts\fP are passed to pbuilder using its \-\-debbuildopts option. If you want to pass other options to pbuilder, use the -\fB--pbuilder:\fR dgit option as described below +\fB\-\-pbuilder:\fR dgit option as described below (remember that dgit options should appear between \fBdgit\fR and \fBpbuilder\fR). @@ -251,7 +251,7 @@ In more detail: dgit push checks that the current HEAD corresponds to the .dsc. It then pushes the HEAD to the suite's dgit-repos branch, adjusts the .changes to include any .origs which the archive lacks and exclude .origs which the archive has -(so -sa and -sd are not needed when building for dgit push), +(so \-sa and \-sd are not needed when building for dgit push), makes a signed git tag, edits the .dsc to contain the dgit metadata field, runs debsign to sign the upload (.dsc and .changes), pushes the signed tag, and finally uses dput to upload the .changes to the @@ -267,11 +267,11 @@ to prepare the branch for source package upload and push. .TP \fBdgit push-source\fR [\fIsuite\fP] -Without \fB-C\fR, builds a source package and dgit pushes it. Saying +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." -With \fB-C\fR, performs a dgit push, additionally ensuring that no +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] @@ -286,7 +286,7 @@ l l. 1. Clone on build host (dgit clone) 2. Edit code on build host (edit, git commit) 3. Build package on build host (dgit build) -4. Test package on build host or elsewhere (dpkg -i, test) +4. Test package on build host or elsewhere (dpkg \-i, test) 5. Upload by invoking dgit rpush on host with your GPG key. .TE @@ -390,7 +390,7 @@ dgit can make patches in some situations where git-debrebase fails, so dgit quilt-fixup can be useful in its own right. To always use dgit's own patch generator instead of git-debrebase make-patches, -pass --git-debrebase=true to dgit. +pass \-\-git-debrebase=true to dgit. See .B FORMAT 3.0 (QUILT) @@ -421,14 +421,14 @@ and specifying where to find that commit 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. +consider \-\-no-chase-dsc-distro +or \-\-force-import-dsc-with-dgit-field. There is only one sub-option: -.B --require-valid-signature +.B \-\-require-valid-signature causes dgit to insist that the signature on the .dsc is valid -(using the same criteria as dpkg-source -x). +(using the same criteria as dpkg-source \-x). Otherwise, dgit tries to verify the signature but the outcome is reported only as messages to stderr. @@ -468,7 +468,7 @@ 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 +Prints the \-i and \-I arguments which must be passed to dpkg-souce to cause it to exclude exactly the .git directory and nothing else. The separate arguments are unquoted, separated by spaces, @@ -495,18 +495,18 @@ See ACCESS CONFIGURATION, below. This function is primarily provided for the benefit of git-debrebase. .SH OPTIONS .TP -.BR --dry-run " | " -n +.BR \-\-dry-run " | " \-n Go through the motions, fetching all information needed, but do not actually update the output(s). For push, dgit does the required checks and leaves the new .dsc in a temporary file, but does not sign, tag, push or upload. .TP -.BR --damp-run " | " -L +.BR \-\-damp-run " | " \-L Go through many more of the motions: do everything that doesn't involve either signing things, or making changes on the public servers. .TP -.BI -k keyid +.BI \-k keyid Use .I keyid for signing the tag and the upload. The default comes from the @@ -568,7 +568,7 @@ and can avoid needing the build-dependencies. With .BR ,ignores or -.BR -wci , +.BR \-wci , untracked files covered by .gitignore are tolerated, so only files which show up as .B ? @@ -576,7 +576,7 @@ in git status (ie, ones you maybe forgot to git add) are treated as a problem. .TP -.BR --clean=none " | " -wn +.BR \-\-clean=none " | " \-wn Do not clean the tree, nor check that it is clean. Avoids running rules clean, and can avoid needing the build-dependencies. @@ -607,7 +607,7 @@ The rules clean target will only be run if it is needed: when dgit is going to build source or binary packages from your working tree, rather than from your git branch -(for example because of --include-dirty +(for example because of \-\-include-dirty or because the binary package build uses your working tree). In all cases, @@ -661,7 +661,7 @@ It is safer not to specify .IR previous-version , and usually it's not needed. Just say -.BR --overwrite , +.BR \-\-overwrite , unless you know what you are doing. This option is useful if you are the maintainer, and you have @@ -699,7 +699,7 @@ git history, so that your push is a fast forward from the archive. implying a split between the dgit view and the maintainer view, the pseudo-merge will appear only in the dgit view.) .TP -.BR --delayed =\fIdays\fR +.BR \-\-delayed =\fIdays\fR Upload to a DELAYED queue. .B WARNING: @@ -741,7 +741,7 @@ Also, it can mean that dgit fails to find necessary git commits. .TP -.BR --save-dgit-view= \fIbranch\fR|\fIref\fR +.BR \-\-save-dgit-view= \fIbranch\fR|\fIref\fR Specifies that when a split view quilt mode is in operation, and dgit calculates (or looks up in its cache) @@ -754,24 +754,24 @@ so don't specify a branch you want to keep. This option is effective only with the following operations: quilt-fixup; push; all builds. And it is only effective with ---[quilt=]gbp, ---[quilt=]dpm, ---quilt=unpatched. +\-\-[quilt=]gbp, +\-\-[quilt=]dpm, +\-\-quilt=unpatched. If ref does not start with refs/ it is taken to be a branch - i.e. refs/heads/ is prepended. -.B --dgit-view-save +.B \-\-dgit-view-save is a deprecated alias for ---save-dgit-view. +\-\-save-dgit-view. .TP -.BI --deliberately- something +.BI \-\-deliberately- something Declare that you are deliberately doing .IR something . This can be used to override safety catches, including safety catches which relate to distro-specific policies. -The use of --deliberately is declared and published in the signed tags +The use of \-\-deliberately is declared and published in the signed tags generated for you by dgit, so that the archive software can give effect to your intent, and @@ -902,16 +902,16 @@ for the dgit view. dgit quilt-fixup will merely do some checks, and cache the maintainer view. -.B If you have a branch like this it is essential to specify the appropriate --quilt= option! +.B If you have a branch like this it is essential to specify the appropriate \-\-quilt= option! This is because it is not always possible to tell: a patches-unapplied git branch of a package with one patch, for example, looks very like a patches-applied branch where the user has used git revert to undo the patch, expecting to actually revert it. However, if you fail to specify the right \-\-quilt option, and you aren't too lucky, dgit will notice the problem and stop, -with a useful hint. +with a useful hint. .TP -.BR -d "\fIdistro\fR | " --distro= \fIdistro\fR +.BR \-d "\fIdistro\fR | " \-\-distro= \fIdistro\fR Specifies that the suite to be operated on is part of distro .IR distro . This overrides the default value found from the git config option @@ -923,7 +923,7 @@ for accessing the archive and dgit-repos) used are If your suite is part of a distro that dgit already knows about, you can use this option to make dgit work even if your dgit doesn't know about the suite. For example, specifying -.B -ddebian +.B \-ddebian will work when the suite is an unknown suite in the Debian archive. To define a new distro it is necessary to define methods and URLs @@ -931,7 +931,7 @@ for fetching (and, for dgit push, altering) a variety of information both in the archive and in dgit-repos. How to set this up is not yet documented. .TP -.BI -C changesfile +.BI \-C changesfile Specifies the .changes file which is to be uploaded. By default dgit push looks for a single .changes file in the parent directory whose filename suggests it is for the right package and version. @@ -940,12 +940,12 @@ If the specified .I changesfile pathname contains slashes, the directory part is also used as the value for -.BR --build-products-dir ; +.BR \-\-build-products-dir ; otherwise, the changes file is expected in that directory (by default, in .BR .. ). .TP -.B --rm-old-changes +.B \-\-rm-old-changes When doing a build, delete any changes files matching .IB package _ version _*.changes before starting. This ensures that @@ -960,7 +960,7 @@ 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 +.BI \-\-build-products-dir= directory Specifies where to find and create tarballs, binary packages, source packages, .changes files, and so on. @@ -1069,26 +1069,26 @@ and cause lossage. For dpkg-buildpackage, dpkg-genchanges, mergechanges and sbuild, the option applies only when the program is invoked directly by dgit. Usually, for passing options to dpkg-genchanges, you should use -.BR --ch: \fIoption\fR. +.BR \-\-ch: \fIoption\fR. -Specifying --git is not effective for some lower-level read-only git +Specifying \-\-git is not effective for some lower-level read-only git operations performed by dgit, and also not when git is invoked by another program run by dgit. See notes below regarding ssh and dgit. -NB that --gpg:option is not supported (because debsign does not +NB that \-\-gpg:option is not supported (because debsign does not have that facility). But see -.B -k +.B \-k and the .B keyid distro config setting. .TP -.RI \fB--curl!:\fR option " | \fB--dput!:\fR" option " |..." +.RI \fB\-\-curl!:\fR option " | \fB\-\-dput!:\fR" option " |..." Specifies an option to remove from the command line for a program called by dgit, as for -\fB--\fR\fIprogram\fI\fB:\fR\fIoption\fR +\fB\-\-\fR\fIprogram\fI\fB:\fR\fIoption\fR (and the same caveats apply). Any options or arguments exactly identical to @@ -1099,11 +1099,11 @@ are removed. This can only be used to delete options which are always passed by default by dgit, or to undo a previous -\fB--\fR\fIprogram\fI\fB:\fR\fIoption\fR. +\fB\-\-\fR\fIprogram\fI\fB:\fR\fIoption\fR. It cannot be used to override option(s) dynamically decided on by dgit. .TP -.RI \fB--curl=\fR program " | \fB--dput=\fR" program " |..." +.RI \fB\-\-curl=\fR program " | \fB\-\-dput=\fR" program " |..." Specifies alternative programs to use instead of .BR curl , .BR dput , @@ -1138,8 +1138,8 @@ 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=). +itself as the EDITOR for dpkg-source \-\-commit; this is done using +argv[0], and is not affected by \-\-dgit=). .BR gbp-build 's value @@ -1172,25 +1172,25 @@ git config variables .BI dgit-distro. distro .ssh and .B .dgit.default.ssh -(which can in turn be overridden with -c). Also, when dgit is using +(which can in turn be overridden with \-c). Also, when dgit is using git to access dgit-repos, only git's idea of what ssh to use (eg, .BR GIT_SSH ) is relevant. .TP -.BI --existing-package= package +.BI \-\-existing-package= package dgit push needs to canonicalise the suite name. Sometimes, dgit lacks a way to ask the archive to do this without knowing the -name of an existing package. Without --new we can just use the -package we are trying to push. But with --new that will not work, so +name of an existing package. Without \-\-new we can just use the +package we are trying to push. But with \-\-new that will not work, so we guess .B dpkg or use the value of this option. This option is not needed with the default mechanisms for accessing the archive. .TP -.BR -h | --help +.BR \-h | \-\-help Print a usage summary. .TP -.BI --initiator-tempdir= directory +.BI \-\-initiator-tempdir= directory dgit rpush uses a temporary directory on the invoking (signing) host. This option causes dgit to use .I directory @@ -1199,7 +1199,7 @@ removed and recreated before dgit starts, rather than removed after dgit finishes. The directory specified must be an absolute pathname. .TP -.BI --force- something +.BI \-\-force- something Instructs dgit to try to proceed despite detecting what it thinks is going to be a fatal problem. .B This is probably not going to work. @@ -1207,45 +1207,45 @@ These options are provided as an escape hatch, in case dgit is confused. (They might also be useful for testing error cases.) .TP -.B --force-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, discarding the git history that the person who pushed that .dsc was working with. .TP -.B --force-uploading-binaries +.B \-\-force-uploading-binaries Carry on and upload binaries even though dgit thinks your distro does not permit that. .TP -.B --force-uploading-source-only +.B \-\-force-uploading-source-only Carry on and do a source-only upload, without any binaries, even though dgit thinks your distro does not permit that, or does not permit that in this situation. .TP -.B --force-unrepresentable +.B \-\-force-unrepresentable Carry on even if dgit thinks that your git tree contains changes (relative to your .orig tarballs) which dpkg-source is not able to represent. Your build or push will probably fail later. .TP -.B --force-changes-origs-exactly +.B \-\-force-changes-origs-exactly Use the set of .origs specified in your .changes, exactly, without regard to what is in the archive already. The archive may well reject your upload. .TP -.B --force-unsupported-source-format +.B \-\-force-unsupported-source-format Carry on despite dgit not understanding your source package format. dgit will probably mishandle it. .TP -.B --force-dsc-changes-mismatch +.B \-\-force-dsc-changes-mismatch Do not check whether .dsc and .changes match. The archive will probably reject your upload. .TP -.BR --force-import-gitapply-absurd " | " --force-import-gitapply-no-absurd +.BR \-\-force-import-gitapply-absurd " | " \-\-force-import-gitapply-no-absurd Force on or off the use of the absurd git-apply emulation when running gbp pq import when importing a package from a .dsc. @@ -1285,8 +1285,8 @@ for each 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. +One of the values for the command line \-\-clean= option; used if +\-\-clean is not specified. .TP .BR dgit-distro. \fIdistro\fR .clean-mode-newer Like .clean-mode, @@ -1295,8 +1295,8 @@ Setting both .clean-mode and .clean-mode-newer is useful to provide a single git config compatible with different dgit versions. .TP .BR dgit-distro. \fIdistro\fR .quilt-mode -One of the values for the command line --quilt= option; used if ---quilt is not specified. +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 @@ -1311,7 +1311,7 @@ git repository server. .TP .BI dgit-distro. distro .keyid See also -.BR -k . +.BR \-k . .TP .BI dgit-distro. distro .mirror " url" .TP @@ -1345,15 +1345,15 @@ True by default. Ignored for dgit setup-gitattributes, which does it anyway. Program to use instead of .IR cmd . Works like -.BR -- \fIcmd\fR = "... ." +.BR \-\- \fIcmd\fR = "... ." .TP .BI dgit-distro. distro .opts- cmd Extra options to pass to .IR cmd . Works like -.BR -- \fIcmd\fR : "... ." +.BR \-\- \fIcmd\fR : "... ." To pass several options, configure multiple values in git config -(with git config --add). The options for +(with git config \-\-add). The options for .BI dgit.default.opts- cmd and .BI dgit-distro. distro /push.opts- cmd @@ -1434,7 +1434,7 @@ if it contains any whitespace will be passed to the shell. GIT_SSH specifies just the program; no arguments can be specified, so dgit interprets it the same way as git does. See -also the --ssh= and --ssh: options. +also the \-\-ssh= and \-\-ssh: options. .TP .BR DEBEMAIL ", " DEBFULLNAME Default git user.email and user.name for new trees. See @@ -1463,10 +1463,10 @@ your current HEAD. Sadly this is necessary for packages in the `3.0 (quilt)' source format. This is ultimately due to what I consider design problems in quilt and dpkg-source. ---dry-run does not always work properly, as not doing some of the git +\-\-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. ---damp-run is likely to work much better. +\-\-damp-run is likely to work much better. .SH SEE ALSO \fBdgit\fP(7), \fBdgit-*\fP(7), |