chiark / gitweb /
Fix references in manpage to old Vcs-Dgit-Master field name.
[dgit.git] / dgit.1
diff --git a/dgit.1 b/dgit.1
index 1abb7ecdc11480d587611eafd5e5373e4bf4aac6..49ed4f8b1c99e91e68f66bbf242475be53d20293 100644 (file)
--- a/dgit.1
+++ b/dgit.1
@@ -82,22 +82,20 @@ into the current branch.
 .TP
 \fBdgit build\fR ...
 Runs
-.B git-buildpackage
+.B dpkg-buildpackage
 with some suitable options.  Options and argumments after build
-will be passed on to git-buildpackage.  It is not necessary to use
+will be passed on to dpkg-buildpackage.  It is not necessary to use
 dgit build when using dgit; it is OK to use any approach which ensures
 that the generated source package corresponds to the relevant git
 commit.
 
-.B NB
-that this function will be changed in the future to use
-dpkg-buildpackage directly.
-
 Tagging, signing and actually uploading should be left to dgit push.
 .TP
 \fBdgit build-source\fR ...
 Builds the source package, and a changes file for a prospective
-source-only upload.  The output is left in
+source-only upload, using
+.BR dpkg-source .
+The output is left in
 .IR package \fB_\fR version \fB.dsc\fR
 and
 .IR package \fB_\fR version \fB_source.changes\fR.
@@ -105,14 +103,23 @@ and
 Tagging, signing and actually uploading should be left to dgit push.
 .TP
 \fBdgit sbuild\fR ...
-Constructs the source package, and uses sbuild to do a binary
-build, and uses mergechanges to merge the source and binary
-changes files.  Options and argumments after sbuild will be passed on
-to sbuild.  Changes files matching
+Constructs the source package, uses
+.B  sbuild
+to do a binary build, and uses mergechanges to merge the source and
+binary changes files.  Options and argumments after sbuild will be
+passed on to sbuild.  Changes files matching
 .IB package _ version _*.changes
 in the parent directory will be removed; the output is left in
 .IR package \fB_\fR version \fB_multi.changes\fR.
 
+Tagging, signing and actually uploading should be left to dgit push.
+.TP
+\fBdgit git-build\fR ...
+Runs
+.B git-buildpackage
+with some suitable options.  Options and argumments after git-build
+will be passed on to git-buildpackage.
+
 Tagging, signing and actually uploading should be left to dgit push.
 .TP
 .B dgit push
@@ -225,7 +232,7 @@ dgit push can operate on any commit which is a descendant of the
 current dgit/suite tip in dgit-repos.
 
 Uploads made by dgit contain an additional field
-.B Vcs-Dgit-Master
+.B Dgit
 in the source package .dsc.  (This is added by dgit push.)
 This specifies a commit (an ancestor of the dgit/suite
 branch) whose tree is identical to the unpacked source upload.
@@ -335,6 +342,21 @@ This is the default.  It requires the package's build dependencies.
 The package may be new in this suite.  Without this, dgit will
 refuse to push.
 .TP
+.BR --ignore-dirty
+Do not complain if the working tree does not match your git HEAD.
+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.)
+
+This option may not work properly on `3.0 (quilt)' packages, as in
+that case dgit needs to use and perhaps commit parts of your working
+tree.
+.TP
+.BR --no-quilt-fixup
+Do not fix up source format `3.0 (quilt)' metadata.  If you use this
+option and the package did in fact need fixing up, dgit push will
+fail.
+.TP
 .BI -D
 Prints debugging information to stderr.  Repeating the option produces
 more output (currently, up to -DD is meaningfully different).
@@ -479,7 +501,7 @@ 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.
 
-Debian Policy needs to be updated to describe the new Vcs-Dgit-Master
+Debian Policy needs to be updated to describe the new Dgit .dsc
 field (and to specify that it is an RC bug for that field to refer
 to an unavailable commit).
 
@@ -543,5 +565,6 @@ sane way to find the path in the archive pool of the .dsc for a
 particular suite.  I'm assured that the archive layout is a
 `well known algorithm' by now.
 
---dry-run often does not work with fetch, even though this is a
-logically plausible request.  (It fails, instead.)
+--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.