chiark / gitweb /
install manpage
[dgit.git] / dgit.1
diff --git a/dgit.1 b/dgit.1
index 6394a16..d2cc128 100644 (file)
--- a/dgit.1
+++ b/dgit.1
@@ -33,7 +33,9 @@ and
 .B dgit fetch
 consult the archive and dgit-repos and fetch and/or construct the
 git view of the history.  With clone, the destination directory (by
-default, the package name in the current directory) will be created.
+default, the package name in the current directory) will be created,
+and the new directory's `origin' remote will be set up to point to
+the package's dgit-repos tree.
 
 .B dgit build
 runs
@@ -46,7 +48,7 @@ the generated source package corresponds to the relevant git commit.
 Tagging and signing should be left to dgit push.
 
 .B dgit push
-does an "upload", pushing the current HEAD to the archive (as a source
+does an `upload', pushing the current HEAD to the archive (as a source
 package) and to dgit-repos (as git commits).  This also involves
 making a signed git tag, and signing the files to be uploaded to the
 archive.
@@ -54,13 +56,22 @@ archive.
 You may use any suitable git workflow with dgit, provided you
 satisfy dgit's requirements:
 
+dgit maintains what looks a bit like a remote called
+.BR dgit ,
+with one branch per suite.  This remote cannot be used with
+plain git.
+
 The
 .B dgit-repos
-repository for each package contains one branch per suite named
-\fBdgit/\fR\fIsuite\fR.  These should be pushed to only by
+repository for each package contains one ref per suite named
+\fBdrefs/git/\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).
 
+However, it is perfectly fine to have other branches in dgit-repos;
+normally the dgit-repos repo for the package will be accessible via
+the remote name `origin'.
+
 dgit push can operate on any commit which is a descendant of the
 current dgit/suite tip in dgit-repos.
 
@@ -84,9 +95,7 @@ the remote tracking branch for dgit/suite.
 .TP
 .BR --dry-run | -n
 Go through the motions, fetching all information needed, but do not
-actually update the output(s).  For fetch and pull, dgit determines
-which git commit corresponds to the archive but does not update
-remotes/dgit/dgit/suite or do any merge.  For push, dgit does
+actually update the output(s).  For push, dgit does
 the required checks and leaves the new .dsc in a temporary file,
 but does not sign, tag, push or upload.
 .TP
@@ -98,6 +107,13 @@ for signing the tag and the upload.
 .BR --no-sign
 does not sign tags or uploads (meaningful only with push).
 .TP
+.TP
+.BI -p package
+Specifies that we should process source package
+.I package
+rather than looking in debian/control.  Valid with dgit fetch
+and dgit pull, only.
+.TP
 .BI -D
 Spew debugging information to stderr.
 .TP
@@ -117,14 +133,43 @@ debsign.  Use repeatedly if multiple additional options are required.
 Specifies the .changes file which is to be uploaded.  By default
 dgit push looks for single .changes file in the parent directory whose
 filename suggests they it is for the right package and version.
+.SH CONFIGURATION
+dgit looks at the following git config keys to control its behaviour.
+You may set them with git-config (either in system-global or per-tree
+configuration), or provide
+.BI -c key = value
+on the dgit command line.
+.TP
+.BI dgit-suite. suite .distro
+.TP
+.BI dgit.default.distro
+.TP
+.BI dgit.default.username
+.TP
+.BI dgit-distro. distro .git-url
+.TP
+.BI dgit-distro. distro .git-host
+.TP
+.BI dgit-distro. distro .git-proto
+.TP
+.BI dgit-distro. distro .git-path
+.TP
+.BI dgit-distro. distro .git-check
+.TP
+.BI dgit-distro. distro .git-create
+.TP
+.BI dgit-distro. distro .upload-host
+.TP
+.BI dgit-distro. distro .mirror
+.TP
+.BI dgit-distro. distro .archive-query
+.TP
+.BI dgit-distro. distro .ssh
+.TP
+.BR dgit.default. *
+for each
+.BR dgit-distro. \fIdistro\fR . *
 .SH BUGS
-dgit currently only works with Format 1.0 packages.
-
-dgit is not nearly configurable enough.  The locations for dgit-repos
-(on alioth) and for the Debian archive are currently hardcoded.
-There is not yet any support for suites which are in different
-distributions to Debian.
-
 dgit will only work with packages in main. The madison http query API
 does not give the component.
 
@@ -132,6 +177,13 @@ 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.
 
+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).
+
+dgit push should perhaps do `git push origin', or something similar,
+by default.
+
 The mechanism for checking for and creating per-package repos on
 alioth is a hideous bodge.  One consequence is that dgit currently
 only works for people with push access.
@@ -140,14 +192,14 @@ Debian Maintainers are currently not able to push, as there is not
 currently any mechanism for determining and honouring the archive's
 ideas about access control.  Currently only DDs can push.
 
-dgit's representation of Format 3.0 (quilt) source packages (even if
+dgit's representation of format `3.0 (quilt)' source packages (even if
 they were supported) would not represent the patch stack.  Currently
 the patch series representation cannot round trip through the archive.
 Ideally dgit would represent a quilty package with an origin commit of
 some kind followed by the patch stack as a series of commits followed
 by a pseudo-merge (to make the branch fast-forwarding).  This would
-also mean a new "dgit rebase-prep" command or some such to turn such a
-fast-forwarding branch back into a rebasing patch stack, and a "force"
+also mean a new `dgit rebase-prep' command or some such to turn such a
+fast-forwarding branch back into a rebasing patch stack, and a `force'
 option to dgit push (perhaps enabled automatically) which will make
 the required pseudo-merge.
 
@@ -158,3 +210,6 @@ The error messages are often unhelpfully terse and tend to refer to
 line numbers in dgit.
 
 The option parser requires values to be cuddled to the option name.
+
+--dry-run often does not work with fetch, even though this is a
+logically plausible request.  (It fails, instead.)