chiark / gitweb /
Do not remove destination when clone fails because it already exists (!)
[dgit.git] / dgit.1
diff --git a/dgit.1 b/dgit.1
index 7e74d5b77f62fdfc2ad5782c3973e8b9b4907c62..6449ea34df2b19f983d9fcfa2c1d81d9dabc38b7 100644 (file)
--- a/dgit.1
+++ b/dgit.1
@@ -167,6 +167,10 @@ 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.  The build-host needs gnupg installed, with your
+public key in its keyring (but not your private key, obviously).
 .TP
 .B dgit quilt-fixup
 Looks to see if the tree is one which dpkg-source cannot properly
@@ -217,7 +221,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,6 +363,20 @@ 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.  Sometimes, dgit
@@ -381,6 +399,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
@@ -491,6 +512,10 @@ build and dgit push.
 To a user looking at the archive, changes pushed using dgit look like
 changes made in an NMU: in a `3.0 (quilt)' package the delta from the
 previous upload is recorded in a new patch constructed by dpkg-source.
+.SH READ-ONLY DISTROS
+Distros which do not maintain a set of dgit history git repositories
+can still be used in a read-only mode with dgit.  Currently Ubuntu
+is configured this way.
 .SH PACKAGE SOURCE FORMATS
 If you are not the maintainer, you do not need to worry about the
 source format of the package.  You can just make changes as you like