dgit(1): Document as-yet-unwritten `dgit checkout'

[dgit.git] / dgit.1

diff --git a/dgit.1 b/dgit.1
index ae084163d4ea687a8b3780cec94cbfb5dd6ca08b..d5ef9303923240dbc745e0f2fad5cf06b081281d 100644 (file)
--- a/dgit.1
+++ b/dgit.1
@@ -109,6 +109,22 @@ branch
 .BI remotes/dgit/dgit/ suite
 into the current branch.
 .TP
+\fBdgit checkout\fR \fIsuite\fR
+Checks out the local branch
+.BR dgit/ \fIsuite\fR.
+
+If the branch does not exist,
+dgit checkout creates it,
+and sets it up the same way as dgit clone would.
+In that case, if
+the archive remote tracking branch does not exist,
+dgit checkout will do a dgit fetch first.
+
+NB: dgit checkout will only do a fetch if it has to.
+If you already have the suite branch,
+and want to merge your branch with updates from the archive,
+use dgit pull.
+.TP
 \fBdgit build\fR ...
 Runs
 .B dpkg-buildpackage