Documentation/git-checkout.txt: document 70c9ac2 behavior

crorvick · gitster · commit 00bb4378c788 · 2012-12-18T11:07:44.000-08:00
Document the behavior implemented in 70c9ac2 (DWIM "git checkout frotz" to "git checkout -b frotz origin/frotz"). Signed-off-by: Chris Rorvick <chris@rorvick.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
@@ -28,6 +28,14 @@ branch.
 	working tree are kept, so that they can be committed to the
 	<branch>.
 +
+If <branch> is not found but there does exist a tracking branch in
+exactly one remote (call it <remote>) with a matching name, treat as
+equivalent to
++
+------------
+$ git checkout -b <branch> --track <remote>/<branch>
+------------
++
 You could omit <branch>, in which case the command degenerates to
 "check out the current branch", which is a glorified no-op with a
 rather expensive side-effects to show only the tracking information,
