git-debrebase: sort out report, and walk, allegedly

[dgit.git] / dgit.1

diff --git a/dgit.1 b/dgit.1
index e5b4bb050b6145a30a72299733622b768677c125..6d46b20a4c7887158a567a89f90a82db53176e0a 100644 (file)
--- a/dgit.1
+++ b/dgit.1
@@ -17,7 +17,7 @@ dgit \- git integration with the Debian archive
 [\fIbuild\-opts\fp]
 .br
 .B dgit
 [\fIbuild\-opts\fp]
 .br
 .B dgit

-[\fIdgit\-opts\fP] \fBpush\fP [\fIdgit\-opts\fP]
+[\fIdgit\-opts\fP] \fBpush\fP|\fBpush-source\fP [\fIdgit\-opts\fP]

 [\fIsuite\fP]
 .br
 .B dgit
 [\fIsuite\fP]
 .br
 .B dgit


@@ -30,6 +30,10 @@ dgit \- git integration with the Debian archive
 .B dgit
 allows you to treat the Debian archive as if it were a git
 repository.
 .B dgit
 allows you to treat the Debian archive as if it were a git
 repository.

+Conversely,
+it allows Debian to publish the source of its packages
+as git branches, in a format which is directly useable
+by ordinary people.

 
 This is the command line reference.
 Please read the tutorial(s):
 
 This is the command line reference.
 Please read the tutorial(s):


@@ -123,7 +127,8 @@ The output is left in
 and
 .IR package \fB_\fR version \fB_source.changes\fR.
 
 and
 .IR package \fB_\fR version \fB_source.changes\fR.
 

-Tagging, signing and actually uploading should be left to dgit push.
+Tagging, signing and actually uploading should be left to dgit
+push-source, or dgit push.

 .TP
 .B dgit clean
 Cleans the current working tree (according to the --clean= option in
 .TP
 .B dgit clean
 Cleans the current working tree (according to the --clean= option in


@@ -181,6 +186,14 @@ dgit push always uses the package, suite and version specified in the
 debian/changelog and the .dsc, which must agree.  If the command line
 specifies a suite then that must match too.
 .TP
 debian/changelog and the .dsc, which must agree.  If the command line
 specifies a suite then that must match too.
 .TP

+\fBdgit push-source\fR [\fIsuite\fP]
+Without \fB-C\fR, builds a source package and dgit pushes it.  Saying
+\fBdgit push-source\fR is like saying "update the source code in the
+archive to match my git HEAD, and let the autobuilders do the rest."
+
+With \fB-C\fR, performs a dgit push, additionally ensuring that no
+binary packages are uploaded.
+.TP

 \fBdgit rpush\fR \fIbuild-host\fR\fB:\fR\fIbuild-dir\fR [\fIpush args...\fR]
 Pushes the contents of the specified directory on a remote machine.
 This is like running dgit push on build-host with build-dir as the
 \fBdgit rpush\fR \fIbuild-host\fR\fB:\fR\fIbuild-dir\fR [\fIpush args...\fR]
 Pushes the contents of the specified directory on a remote machine.
 This is like running dgit push on build-host with build-dir as the


@@ -343,6 +356,13 @@ as actually being used on the dgit git server, as a git tree.
 Prints the url used by dgit clone-dgit-repos-server.
 This is hopefully suitable for use as a git remote url.
 It may not be useable in a browser.
 Prints the url used by dgit clone-dgit-repos-server.
 This is hopefully suitable for use as a git remote url.
 It may not be useable in a browser.

+.TP
+.BI "dgit print-dpkg-source-ignores"
+Prints the -i and -I arguments which must be passed to dpkg-souce
+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.

 .SH OPTIONS
 .TP
 .BR --dry-run " | " -n
 .SH OPTIONS
 .TP
 .BR --dry-run " | " -n


@@ -554,6 +574,17 @@ Declare that you are deliberately rewinding history.  When pushing to
 Debian, use this when you are making a renewed upload of an entirely
 new source package whose previous version was not accepted for release
 from NEW because of problems with copyright or redistributibility.
 Debian, use this when you are making a renewed upload of an entirely
 new source package whose previous version was not accepted for release
 from NEW because of problems with copyright or redistributibility.

+
+In split view quilt modes,
+this also prevents the construction by dgit of a pseudomerge
+to make the dgit view fast forwarding.
+Normally only one of
+--overwrite (which creates a suitable pseudomerge)
+and
+--deliberately-not-fast-forward
+(which suppresses the pseudomerge and the fast forward checks)
+should be needed;
+--overwrite is usually better.

 .TP
 .BR --deliberately-include-questionable-history
 Declare that you are deliberately including, in the git history of
 .TP
 .BR --deliberately-include-questionable-history
 Declare that you are deliberately including, in the git history of


@@ -714,6 +745,9 @@ The default is not to remove, but
 .B \-\-no-rm-old-changes
 can be used to override a previous \-\-rm-old-changes
 or the .rm-old-changes configuration setting.
 .B \-\-no-rm-old-changes
 can be used to override a previous \-\-rm-old-changes
 or the .rm-old-changes configuration setting.

+
+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.
 .TP
 .BI --build-products-dir= directory
 Specifies where to find the built files to be uploaded.