better debug

[dgit.git] / dgit.1

diff --git a/dgit.1 b/dgit.1
index d2cc128cec7cec012e7ec1f9b973f1fd3635728d..3b588d00b3cb9540f4a12b13b324cee643320a5d 100644 (file)
--- a/dgit.1
+++ b/dgit.1
@@ -4,29 +4,30 @@ dgit \- git integration with the Debian archive
 .
 .SH SYNOPSIS
 .B dgit
 .
 .SH SYNOPSIS
 .B dgit

-[\fIdgit\-options\fP] \fBclone\fP [\fIdgit\-options\fP]
-\fIpackage\fP [\fIsuite\fP] [\fB./\fP\fIdest-dir|\fB/\fP\fIdest-dir]
+[\fIdgit\-opts\fP] \fBclone\fP [\fIdgit\-opts\fP]
+\fIpackage\fP [\fIsuite\fP] [\fB./\fP\fIdir|\fB/\fP\fIdir]

 .br
 .B dgit
 .br
 .B dgit

-[\fIdgit\-options\fP] \fBfetch\fP|\fBpull\fP [\fIdgit\-options\fP]
+[\fIdgit\-opts\fP] \fBfetch\fP|\fBpull\fP [\fIdgit\-opts\fP]

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

-[\fIdgit\-options\fP] \fBbuild\fP
-[\fIgit\-buildpackage\-options\fP|\fIdpkg\-buildpackage\-options\fp]
+[\fIdgit\-opts\fP] \fBbuild\fP
+[\fIgit\-buildpackage\-opts\fP|\fIdpkg\-buildpackage\-opts\fp]

 .br
 .B dgit
 .br
 .B dgit

-[\fIdgit\-options\fP] \fBpush\fP [\fIdgit\-options\fP]
+[\fIdgit\-opts\fP] \fBpush\fP [\fIdgit\-opts\fP]

 [\fIsuite\fP]
 .SH DESCRIPTION
 .B dgit
 treats the Debian archive as a version control system, and
 bidirectionally gateways between the archive and git.  The git view of
 the package can contain the usual upstream git history, and will be
 [\fIsuite\fP]
 .SH DESCRIPTION
 .B dgit
 treats the Debian archive as a version control system, and
 bidirectionally gateways between the archive and git.  The git view of
 the package can contain the usual upstream git history, and will be

-augmented by commits representing uploads done without using dgit.
-This git history is stored in a canonical location
+augmented by commits representing uploads done by other developers not
+using dgit.  This git history is stored in a canonical location known
+as

 .B dgit-repos
 .B dgit-repos

-which lives outside the Debian archive.
+which lives outside the Debian archive (currently, on Alioth).

 
 .B dgit clone
 and
 
 .B dgit clone
 and


@@ -64,7 +65,7 @@ plain git.
 The
 .B dgit-repos
 repository for each package contains one ref per suite named
 The
 .B dgit-repos
 repository for each package contains one ref per suite named

-\fBdrefs/git/\fR\fIsuite\fR.  These should be pushed to only by
+\fBrefs/dgit/\fR\fIsuite\fR.  These should be pushed to only by

 dgit.  They are fast forwarding.  Each push on this branch
 corresponds to an upload (or attempted upload).
 
 dgit.  They are fast forwarding.  Each push on this branch
 corresponds to an upload (or attempted upload).
 


@@ -115,7 +116,8 @@ rather than looking in debian/control.  Valid with dgit fetch
 and dgit pull, only.
 .TP
 .BI -D
 and dgit pull, only.
 .TP
 .BI -D

-Spew debugging information to stderr.
+Prints debugging information to stderr.  Repeating the option produces
+more output (currently, up to -DD is meaningfully different).

 .TP
 .BI -c name = value
 Specifies a git configuration option.  dgit itself is also controlled
 .TP
 .BI -c name = value
 Specifies a git configuration option.  dgit itself is also controlled


@@ -177,6 +179,10 @@ dgit assumes knowledge of the archive layout.  There appears to be no
 sane way to find the path in the archive pool of the .dsc for a
 particular suite.
 
 sane way to find the path in the archive pool of the .dsc for a
 particular suite.
 

+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-Git-Master
 field (and to specify that it is an RC bug for that field to refer
 to an unavailable commit).
 Debian Policy needs to be updated to describe the new Vcs-Git-Master
 field (and to specify that it is an RC bug for that field to refer
 to an unavailable commit).