git-debrebase: merge: Comment about laundry of merge of unstitched

[dgit.git] / dgit.1

diff --git a/dgit.1 b/dgit.1
index 2976e136305c57a7d03006817d420b0a01b3e56e..a21f212dc94382ae528a028254122585a7b15937 100644 (file)
--- a/dgit.1
+++ b/dgit.1
@@ -199,11 +199,12 @@ You probably want to pass -A, to request those.
 Tagging, signing and actually uploading should be left to dgit push.
 .TP
 \fBdgit pbuilder\fR [\fIdebbuildopts\fP]
-Like \fBdgit sbuild\fR, but uses
-.B pbuilder
-instead of
-.BR sbuild ,
-and builds arch-independent packages by default.
+Constructs the source package, uses
+.B  pbuilder
+to do a binary build, and uses mergechanges to merge the source and
+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.
@@ -211,7 +212,7 @@ your pbuilder --buildresult.
 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
-(recalling that dgit options should appear between \fBdgit\fR and
+(remember that dgit options should appear between \fBdgit\fR and
 \fBpbuilder\fR).
 
 You should ensure that in your pbuilderrc you do
@@ -470,6 +471,26 @@ to cause it to exclude exactly the .git diredcory
 and nothing else.
 The separate arguments are unquoted, separated by spaces,
 and do not contain spaces.
+.TP
+.B dgit print-unapplied-treeish
+Constructs a tree-ish approximating the patches-unapplied state
+of your 3.0 (quilt) package,
+and prints the git object name to stdout.
+This requires appropriate .orig tarballs.
+This tree object is identical to your .origs
+as regards upstream files.
+The contents of the debian subdirectory is not interesting
+and should not be inspected;
+except that debian/patches will be identical to your HEAD.
+
+To make this operate off-line,
+the access configuration key
+which is used to determine the build-products-dir
+is the uncanonicalised version of the suite name from the changelog,
+or (of course) dgit.default.build-products-dir.
+See ACCESS CONFIGURATION, below.
+
+This function is primarily provided for the benefit of git-debrebase.
 .SH OPTIONS
 .TP
 .BR --dry-run " | " -n
@@ -660,7 +681,7 @@ Also,
 it can mean that
 dgit fails to find necessary git commits.
 .TP
-.BR --dgit-view-save= \fIbranch\fR|\fIref\fR
+.BR --save-dgit-view= \fIbranch\fR|\fIref\fR
 Specifies that when a split view quilt mode is in operation,
 and dgit calculates
 (or looks up in its cache)
@@ -680,6 +701,10 @@ And it is only effective with
 If ref does not start with refs/
 it is taken to to be a branch -
 i.e. refs/heads/ is prepended.
+
+.B --dgit-view-save
+is a deprecated alias for
+--save-dgit-view.
 .TP
 .BI --deliberately- something
 Declare that you are deliberately doing
@@ -876,14 +901,20 @@ Note that \fBdgit push-source\fR will always find the right .changes,
 regardless of this option.
 .TP
 .BI --build-products-dir= directory
-Specifies where to find the built files to be uploaded.
-By default, dgit looks in the parent directory
+Specifies where to find and create tarballs, binry packages,
+source packages, .changes files, and so on.
+
+By default, dgit uses the parent directory
 .RB ( .. ).
 
-Also see the
+Changing this setting may necessitate
+moving .orig tarballs to the new directory,
+so it is probably best to
+use the
 .BI dgit.default.build-products-dir
-configuration option
-(which this command line option overrides).
+configuration setting
+(see CONFIGURATION, below)
+which this command line option overrides).
 .TP
 .BI --no-rm-on-error
 Do not delete the destination directory if clone fails.