chiark / gitweb /
dgit(1): Cover more cases of --overwrite and --deliberately
[dgit.git] / dgit.1
diff --git a/dgit.1 b/dgit.1
index cd0419ee3092310107fea215b6e2d2ed8a8ea1b6..9de679dbe10a881353e0bede6d1205dc27f99dcc 100644 (file)
--- a/dgit.1
+++ b/dgit.1
@@ -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.
 
@@ -448,7 +448,7 @@ and dgit actually imports the dsc
 dgit will make a pseudomerge
 so that the result is necessarily fast forward
 from the existing branch.
-Otherwise, if the branch already exists,
+Otherwise, if \fIbranch\fR already exists,
 dgit will stop with an error message.
 
 If
@@ -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,
@@ -631,7 +631,8 @@ This could perhaps be used to detect bugs in your rules clean target.
 .TP
 .BR -N " | " --new
 The package is or may be new in this suite.  Without this, dgit will
-refuse to push.  It may (for Debian, will) be unable to access the git
+refuse to push.
+It may (for Debian, will) be unable to access the git
 history for any packages which have been newly pushed and have not yet
 been published.
 .TP
@@ -642,6 +643,18 @@ include the changes from your working tree.
 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.)
+
+Note that this does
+.BR not
+prevent dgit from cleaning your tree, so if the changes in your
+working tree are in the form of untracked files, those might still be
+deleted, especially with --clean=git.
+If you want to include untracked files in the build, you can
+use --clean=none or --clean=dpkg-source[-d]
+in addition to --include-dirty.
+Note that this
+combination can fail if the untracked files are under
+\fIdebian/patches/\fR.
 .TP
 .BR --ignore-dirty
 Deprecated alias for --include-dirty.
@@ -661,12 +674,13 @@ 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
 incorporated NMU changes into your own git workflow in a way that
 doesn't make your branch a fast forward from the NMU.
+It can also be useful when an intermediate upload was not done with dgit.
 
 This option is also usually necessary
 the first time a package is pushed with dgit push
@@ -695,11 +709,11 @@ 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 ,
+.BR gbp ", " dpm ", " unpatched " or " baredebian *,
 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,8 +755,8 @@ Also,
 it can mean that
 dgit fails to find necessary git commits.
 .TP
-.BR --save-dgit-view= \fIbranch\fR|\fIref\fR
-Specifies that when a split view quilt mode is in operation,
+.BR \-\-save-dgit-view= \fIbranch\fR|\fIref\fR
+Specifies that when split view is in operation,
 and dgit calculates
 (or looks up in its cache)
 a dgit view corresponding to your HEAD,
@@ -753,25 +767,22 @@ 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.
+And it is only effective when split view is actually in operation.
 
 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
@@ -781,12 +792,18 @@ The meanings of
 understood in the context of Debian are discussed below:
 .TP
 .BR --deliberately-not-fast-forward
-Declare that you are deliberately rewinding history.  When pushing to
-Debian, use this when you are making a renewed upload of an entirely
+Declare that you are deliberately rewinding history.
+This could be because your branch is not fast forward from the
+dgit server history,
+or not fast forward from a locally-synthesised dsc import.
+
+When pushing to Debian,
+use this only 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.
+from NEW because of problems with copyright or redistributibility;
+or, exceptionally, for the very first upload with dgit.
 
-In split view quilt modes,
+When split view is in operation,
 this also prevents the construction by dgit of a pseudomerge
 to make the dgit view fast forwarding.
 Normally only one of
@@ -826,7 +843,7 @@ with as ancestor a patches-applied branch.
 .BR --quilt=auto
 When fixing up source format `3.0 (quilt)' metadata, prefer to
 generate a linear patch stack
-(as with --quilt=auto)
+(as with --quilt=linear)
 but if that doesn't seem possible,
 try to generate a single squashed patch for all the changes made in git
 (as with --quilt=smash).
@@ -856,13 +873,17 @@ Do not check whether source format `3.0 (quilt)' metadata needs
 fixing up.  If you use this option and the metadata did in fact need
 fixing up, dgit push will fail.
 .TP
-.BR -- [ quilt= ] gbp " | " -- [ quilt= ] dpm " | " --quilt=unapplied
+.BR -- [ quilt= ] gbp " | " -- [ quilt= ] dpm " | " --quilt=unapplied " | " -- [ quilt= ] baredebian [ +git | +tarball ]
 Tell dgit that you are using a nearly-dgit-compatible git branch,
 aka a
 .BR "maintainer view" ,
 and
 do not want your branch changed by dgit.
 
+These quilt modes are known as
+.BR "splitting quilt modes" .
+See --split-view, below.
+
 .B --gbp
 (short for
 .BR --quilt=gbp )
@@ -884,7 +905,32 @@ specifies that your HEAD is a patches-unapplied git branch (and
 that any changes to upstream .gitignore files are represented as
 patches in debian/patches).
 
-With --quilt=gbp|dpm|unapplied,
+.B --quilt=baredebian
+(or its alias
+.BR --quilt=baredebian+git )
+specifies that your HEAD contains only a debian/ directory,
+with any changes to upstream files represented as
+patches in debian/patches.
+The upstream source must be available in git,
+by default, in a suitably named git tag;
+see --upstream-commitish.
+In this mode, dgit cannot check that
+all edited upstream files are properly represented as patches:
+dgit relies on
+debian/patches being correct.
+
+.B --quilt=baredebian+tarball
+is like --quilt=baredebian,
+but is used when there is no appropriate upstream git history.
+To construct the dgit view,
+dgit will import your orig tarballs' contents into git.
+In this mode, dgit cannot check that
+the upstream parts of your upload correspond to what you intend:
+dgit relies on
+the right orig tarball(s) existing, and
+debian/patches being correct.
+
+With --quilt=gbp|dpm|unapplied|baredebian*,
 dgit push (or precursors like quilt-fixup and build) will automatically
 generate a conversion of your git branch into the right form.
 dgit push will push the
@@ -902,16 +948,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 +969,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 +977,43 @@ 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
+.BR \-\-split-view=auto | always | never
+Controls whether dgit operates a split view,
+separating your own branch (as Debian maintainer)
+from that shown to users of dgit clone and dgit fetch.
+
+When split view is in operation
+dgit will not make or merge any commits onto your own branch.
+Specifically, only the dgit view will contain
+dgit's pseudomerges,
+which bring into the git history previous uploads made with dgit push,
+and any commits in debian/patches required
+to make a correct `3.0 (quilt)' source package.
+
+.B auto
+is the default, and splits the view only when needed:
+i.e., when you are working with a `3.0 (quilt)' source package
+and a splitting quilt mode:
+\-\-[quilt=]gbp, dpm, unpatched or baredebian*.
+
+.B always
+splits the view regardless of the source format and the quilt mode.
+
+.B never
+will cause dgit to fail if split view is needed.
+
+When split view is in operation, the dgit view is visible
+in your local git clone,
+but only in refs specific to dgit:
+notably
+.BI remotes/dgit/dgit/ suite
+and
+.BR archive/ \fIdistro\fR / \fIversion\fR.
+
+Note that split view does not affect dgit fetch,
+and is not compatible with dgit pull.
+.TP
+.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 +1022,20 @@ 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
+.BI \-\-upstream-commitish= upstream
+For use with --quilt=baredebian only.
+Specifies the commit containing the upstream source.
+This commit must be identical to your .orig tarball.
+The default is to look for one of the git tags
+.IB U " v" U " upstream/" U
+(in that order), where U is the upstream version.
+.TP
+.B \-\-rm-old-changes
 When doing a build, delete any changes files matching
 .IB package _ version _*.changes
 before starting.  This ensures that
@@ -960,7 +1050,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.
 
@@ -983,19 +1073,14 @@ Do not delete the destination directory if clone fails.
 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.
+.BR archive/debian/ \fIversion\fR).
+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.)
+Do not generate a DEP-14 tag, except when split view is in operation.
 .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.
+.BI --always-dep14tag
+Obsolete alias for --dep14tag, retained for compatibility.
 .TP
 .BI -D
 Prints debugging information to stderr.  Repeating the option produces
@@ -1069,26 +1154,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 +1184,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 +1223,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 +1257,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 +1284,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,49 +1292,62 @@ 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-reusing-version
+Carry on even though this involves reusing a version number
+of a previous push or upload.
+It is normally best to give different versions different numbers.
+Some servers (including, usually, the Debian server)
+will reject attempts to reuse or replace already-pushed versions.
+.TP
+.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.
 See Debian bug #841867.
+.TP
+.BR \-\-for\-push
+Override the dgit-distro.distro.readonly configuration setting,
+to specify that we have read/write access
+and should use the corresponding git and achieve access approach
+even if the operation is a read-only one.
 .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
@@ -1275,6 +1373,10 @@ may be a glob pattern.
 .TP
 .BI dgit.default.distro " distro"
 The default distro for an unknown suite.
+
+This is only used if no
+.BI /usr/share/distro-info/ somedistro .csv
+mentions the specified suite.
 .TP
 .BI dgit.default.default-suite " suite"
 The default suite (eg for clone).
@@ -1285,8 +1387,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 +1397,10 @@ 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 .split-view
 .TP
 .BR dgit-distro. \fIdistro\fR .rm-old-changes
 Boolean, used if neither \-\-rm-old-changes nor \-\-no-rm-old-changes
@@ -1311,7 +1415,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 +1449,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
@@ -1392,7 +1496,7 @@ or when pushing and
 .TP
 .BI dgit-distro. distro .git-create " " ssh-cmd | true
 .TP
-.BR dgit-distro. \fIdistro\fR .archive-query " " ftpmasterapi: " | " madison: "\fIdistro\fR | " dummycat: "\fI/path\fR  | " sshpsql: \fIuser\fR @ \fIhost\fR : \fIdbname\fR
+.BR dgit-distro. \fIdistro\fR .archive-query " " ftpmasterapi: " | " madison: "\fIdistro\fR | " dummycat: "\fI/path\fR  | " sshpsql: \fIuser\fR @ \fIhost\fR : \fIdbname\fR " " | " aptget:"
 .TP
 .BR dgit-distro. \fIdistro\fR .archive-query- ( url | tls-key | curl-ca-args )
 .TP
@@ -1402,7 +1506,7 @@ or when pushing and
 .TP
 .BI dgit-distro. distro .dgit-tag-format
 .TP
-.BR dgit-distro. \fIdistro\fR .dep14tag " " want | no | always
+.BR dgit-distro. \fIdistro\fR .dep14tag " " want | no [| always ]
 .TP
 .BI dgit-distro. distro .ssh
 .TP
@@ -1434,13 +1538,13 @@ 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
 .BR "dgit setup-new-tree" .
 .TP
-.BR gpg ", " dpkg- "..., " debsign ", " git ", " curl ", " dput ", " LWP::UserAgent
+.BR gpg ", " dpkg- "..., " debsign ", " git ", [" lib ] curl ", " dput
 and other subprograms and modules used by dgit are affected by various
 environment variables.  Consult the documentation for those programs
 for details.
@@ -1463,10 +1567,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),