git-debpush: Check upstream source is identical in the upstream tag

[dgit.git] / dgit.1

diff --git a/dgit.1 b/dgit.1
index dca6ff0b06d35688d62589d2a1fe924df38f790c..f099ed0f373327816bb64662ee023e5be05acb40 100644 (file)
--- a/dgit.1
+++ b/dgit.1
@@ -642,6 +642,18 @@ include the changes from your working tree.
 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.)
+
+Note that this does
+.BR not
+prevent dgit from cleaning your tree, so if the changes in your
+working tree are in the form of untracked files, those might still be
+deleted, especially with --clean=git.
+If you want to include untracked files in the build, you can
+use --clean=none or --clean=dpkg-source[-d]
+in addition to --include-dirty.
+Note that this
+combination can fail if the untracked files are under
+\fIdebian/patches/\fR.
 .TP
 .BR --ignore-dirty
 Deprecated alias for --include-dirty.
@@ -695,7 +707,7 @@ of git merge -s ours) to stitch the archive's version into your own
 git history, so that your push is a fast forward from the archive.
 
 (In quilt mode
-.BR gbp ", " dpm " or " unpatched ,
+.BR gbp ", " dpm ", " unpatched " or " baredebian *,
 implying a split between the dgit view and the
 maintainer view, the pseudo-merge will appear only in the dgit view.)
 .TP
@@ -823,7 +835,7 @@ with as ancestor a patches-applied branch.
 .BR --quilt=auto
 When fixing up source format `3.0 (quilt)' metadata, prefer to
 generate a linear patch stack
-(as with --quilt=auto)
+(as with --quilt=linear)
 but if that doesn't seem possible,
 try to generate a single squashed patch for all the changes made in git
 (as with --quilt=smash).
@@ -853,7 +865,7 @@ Do not check whether 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.
 .TP
-.BR -- [ quilt= ] gbp " | " -- [ quilt= ] dpm " | " --quilt=unapplied
+.BR -- [ quilt= ] gbp " | " -- [ quilt= ] dpm " | " --quilt=unapplied " | " -- [ quilt= ] baredebian [ +git | +tarball ]
 Tell dgit that you are using a nearly-dgit-compatible git branch,
 aka a
 .BR "maintainer view" ,
@@ -885,7 +897,32 @@ specifies that your HEAD is a patches-unapplied git branch (and
 that any changes to upstream .gitignore files are represented as
 patches in debian/patches).
 
-With --quilt=gbp|dpm|unapplied,
+.B --quilt=baredebian
+(or its alias
+.BR --quilt=baredebian+git )
+specifies that your HEAD contains only a debian/ directory,
+with any changes to upstream files represented as
+patches in debian/patches.
+The upstream source must be available in git,
+by default, in a suitably named git tag;
+see --upstream-commitish.
+In this mode, dgit cannot check that
+all edited upstream files are properly represented as patches:
+dgit relies on
+debian/patches being correct.
+
+.B --quilt=baredebian+tarball
+is like --quilt=baredebian,
+but is used when there is no appropriate upstream git history.
+To construct the dgit view,
+dgit will import your orig tarballs' contents into git.
+In this mode, dgit cannot check that
+the upstream parts of your upload correspond to what you intend:
+dgit relies on
+the right orig tarball(s) existing, and
+debian/patches being correct.
+
+With --quilt=gbp|dpm|unapplied|baredebian*,
 dgit push (or precursors like quilt-fixup and build) will automatically
 generate a conversion of your git branch into the right form.
 dgit push will push the
@@ -949,7 +986,7 @@ to make a correct `3.0 (quilt)' source package.
 is the default, and splits the view only when needed:
 i.e., when you are working with a `3.0 (quilt)' source package
 and a splitting quilt mode:
-\-\-[quilt=]gbp, dpm or unpatched.
+\-\-[quilt=]gbp, dpm, unpatched or baredebian*.
 
 .B always
 splits the view regardless of the source format and the quilt mode.
@@ -958,7 +995,7 @@ splits the view regardless of the source format and the quilt mode.
 will cause dgit to fail if split view is needed.
 
 When split view is in operation, the dgit view is visible
-in your git tree,
+in your local git clone,
 but only in refs specific to dgit:
 notably
 .BI remotes/dgit/dgit/ suite
@@ -982,6 +1019,14 @@ otherwise, the changes file is expected in that directory (by
 default, in
 .BR .. ).
 .TP
+.BI \-\-upstream-commitish= upstream
+For use with --quilt=baredebian only.
+Specifies the commit containing the upstream source.
+This commit must be identical to your .orig tarball.
+The default is to look for one of the git tags
+.IB U " v" U " upstream/" U
+(in that order), where U is the upstream version.
+.TP
 .B \-\-rm-old-changes
 When doing a build, delete any changes files matching
 .IB package _ version _*.changes
@@ -1426,7 +1471,7 @@ or when pushing and
 .TP
 .BI dgit-distro. distro .git-create " " ssh-cmd | true
 .TP
-.BR dgit-distro. \fIdistro\fR .archive-query " " ftpmasterapi: " | " madison: "\fIdistro\fR | " dummycat: "\fI/path\fR  | " sshpsql: \fIuser\fR @ \fIhost\fR : \fIdbname\fR
+.BR dgit-distro. \fIdistro\fR .archive-query " " ftpmasterapi: " | " madison: "\fIdistro\fR | " dummycat: "\fI/path\fR  | " sshpsql: \fIuser\fR @ \fIhost\fR : \fIdbname\fR " " | " aptget:"
 .TP
 .BR dgit-distro. \fIdistro\fR .archive-query- ( url | tls-key | curl-ca-args )
 .TP