dgit: Always canonicalise suite rather earlier

[dgit.git] / dgit.1

diff --git a/dgit.1 b/dgit.1
index 9ebc7b1694070a5b1387705a6d1a6886912101db..9029f46e014b42cf147b66039d55949bb1f6a6ed 100644 (file)
--- a/dgit.1
+++ b/dgit.1
@@ -29,13 +29,21 @@ dgit \- git integration with the Debian archive
 .B dgit
 allows you to treats the Debian archive as if it were a git
 repository.  See \fBdgit\fP(7) for detailed information about the data
 .B dgit
 allows you to treats the Debian archive as if it were a git
 repository.  See \fBdgit\fP(7) for detailed information about the data

-model etc.
+model, common problems likely to arise with certain kinds of package,
+etc.

 
 

-The usual workflow is: 1. clone or fetch; 2. make and commit changes
-in git as desired; 3. run dgit build, dgit sbuild or dgit
-build-source, or generate the source and binary packages for upload
-some other way; 4. do pre-upload tests of the proposed upload; 5. run
-dgit push.
+The usual workflow is:
+.br
+1.     \fBdgit clone\fR or \fBfetch\fR;
+.br
+2.     make, do dev tests, and commit changes in git as desired;
+.br
+3.     build packages for upload, using e.g. \fBdgit sbuild\fR
+.br
+4.     do pre-upload tests of the proposed upload;
+.br
+5.     \fBdgit push\fR.
+.SH OPERATIONS

 .TP
 \fBdgit clone\fR \fIpackage\fP [\fIsuite\fP] [\fB./\fP\fIdir|\fB/\fP\fIdir\fR]
 Consults the archive and dgit-repos to construct the git view of
 .TP
 \fBdgit clone\fR \fIpackage\fP [\fIsuite\fP] [\fB./\fP\fIdir|\fB/\fP\fIdir\fR]
 Consults the archive and dgit-repos to construct the git view of


@@ -213,13 +221,13 @@ 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.
 .SH OPTIONS
 .TP
 as actually being used on the dgit git server, as a git tree.
 .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
 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.
 Go through many more of the motions: do everything that doesn't
 involve either signing things, or making changes on the public
 servers.


@@ -239,7 +247,7 @@ Specifies that we should process source package
 rather than looking in debian/control or debian/changelog.
 Valid with dgit fetch and dgit pull, only.
 .TP
 rather than looking in debian/control or debian/changelog.
 Valid with dgit fetch and dgit pull, only.
 .TP

-.BR --clean=git | -wg
+.BR --clean=git " | " -wg

 The source tree should be cleaned, before building a source package
 with one of the build options, using
 .BR "git clean -xdf" .
 The source tree should be cleaned, before building a source package
 with one of the build options, using
 .BR "git clean -xdf" .


@@ -253,17 +261,17 @@ from being run.
 the downside is simply that git clean may delete files you forgot to
 git add.
 .TP
 the downside is simply that git clean may delete files you forgot to
 git add.
 .TP

-.BR --clean=none | -wn
+.BR --clean=none " | " -wn

 Do not clean the tree before building a source package.  If there are
 files which are not in git, or if the build creates such files, a
 subsequent dgit push will fail.
 .TP
 Do not clean the tree before building a source package.  If there are
 files which are not in git, or if the build creates such files, a
 subsequent dgit push will fail.
 .TP

-.BR --clean=dpkg-source | -wd
+.BR --clean=dpkg-source " | " -wd

 Use dpkg-buildpackage to do the clean, so that the source package
 is cleaned by dpkg-source running the package's clean target.
 This is the default.  It requires the package's build dependencies.
 .TP
 Use dpkg-buildpackage to do the clean, so that the source package
 is cleaned by dpkg-source running the package's clean target.
 This is the default.  It requires the package's build dependencies.
 .TP

-.BR -N | --new
+.BR -N " | " --new

 The package may be new in this suite.  Without this, dgit will
 refuse to push.
 .TP
 The package may be new in this suite.  Without this, dgit will
 refuse to push.
 .TP


@@ -325,7 +333,7 @@ because the dgit git tree does not have a
 .B .pc
 directory.)
 .TP
 .B .pc
 directory.)
 .TP

-.BR --quilt=nocheck | --no-quilt-fixup
+.BR --quilt=nocheck " | " --no-quilt-fixup

 Do not check whether up 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.
 Do not check whether up 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.


@@ -360,7 +368,7 @@ Passed to dpkg-genchanges (eventually).
 Specifies a single additional option to pass, eventually, to
 dpkg-genchanges.
 .TP
 Specifies a single additional option to pass, eventually, to
 dpkg-genchanges.
 .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 ,
 Specifies alternative programs to use instead of
 .BR curl ,
 .BR dput ,


@@ -398,7 +406,7 @@ git to access dgit-repos, only git's idea of what ssh to use (eg,
 .BR GIT_SSH )
 is relevant.
 .TP
 .BR GIT_SSH )
 is relevant.
 .TP

-.RI \fB--curl:\fR option |\fB--dput:\fR option |...
+.RI \fB--curl:\fR option " | \fB--dput:\fR" option " |..."

 Specifies a single additional option to pass to
 .BR curl ,
 .BR dput ,
 Specifies a single additional option to pass to
 .BR curl ,
 .BR dput ,