Do not spew diff output to terminal (by default). Print sensible message instead...

[dgit.git] / dgit.1

diff --git a/dgit.1 b/dgit.1
index 5c171ed78dd94dd34501b0a340e55dfdcca7e902..712f36dc80855d8b4e948f180fe4b85680eadbb8 100644 (file)
--- a/dgit.1
+++ b/dgit.1
@@ -167,6 +167,9 @@ build-host and build\-dir can be passed as separate
 arguments; this is assumed to be the case if the first argument
 contains no : (except perhaps on in [ ], to support IPv6 address
 literals).
+
+You will need similar enough versions of dgit on the build-host and
+the invocation host.
 .TP
 .B dgit quilt-fixup
 Looks to see if the tree is one which dpkg-source cannot properly
@@ -217,7 +220,7 @@ Do not clean the tree before building a source package.  If there are
 files which are not in git, a subsequent dgit push will fail.
 .TP
 .BR --clean=dpkg-source | -wd
-Use dpkg-buildpackage to do the build, so that the source package
+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
@@ -359,15 +362,30 @@ 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.
+
+If the specified
+.I changesfile
+pathname contains slashes, the directory part is also used as
+the value for
+.BR --build-products-dir ;
+otherwise, the changes file is expected in that directory (by
+default, in
+.BR .. ).
+.TP
+.BI --build-products-dir= directory
+Specifies where to find the built files to be uploaded.
+By default, dgit looks in the parent directory
+.BR .. ).
 .TP
 .BI --existing-package= package
-dgit push needs to canonicalise the suite name.  But currently
-there is no way to ask the archive to do this without knowing the
+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
 we guess
 .B dpkg
-or use the value of this option.
+or use the value of this option.  This option is not needed with the
+default mechanisms for accessing the archive.
 .TP
 .BR -h | --help
 Print a usage summary.
@@ -380,6 +398,9 @@ instead.  Furthermore, the specified directory will be emptied,
 removed and recreated before dgit starts, rather than removed
 after dgit finishes.  The directory specified must be an absolute
 pathname.
+.TP
+.BI --no-rm-on-error
+Do not delete the destination directory if clone fails.
 .SH WORKFLOW - SIMPLE
 It is always possible with dgit to clone or fetch a package, make
 changes in git (using git-commit) on the suite branch
@@ -646,10 +667,6 @@ We should be using some kind of vhost/vpath setup for the git repos on
 alioth, so that they can be moved later if and when this turns out to
 be a good idea.
 
-The method of canonicalising suite names is bizarre.  See the
-.B --existing-package
-option for one of the implications.
-
 dgit push should perhaps do `git push origin', or something similar,
 by default.