From: Federico Mena Quintero <federico@novell.com>
Date: Tue, 2 Oct 2007 23:32:32 +0000 (-0500)
Subject: Say when --track is useful in the git-checkout docs.
X-Git-Tag: v1.5.3.4~10
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/ac150747d7cc62d53daf9f7c128a0fa88a399f44?ds=inline

Say when --track is useful in the git-checkout docs.

The documentation used to say what the option does, but it
didn't mention a use case.

Signed-off-by: Federico Mena Quintero <federico@gnu.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---

diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
index 734928bf96..2e58481ed6 100644
--- a/Documentation/git-checkout.txt
+++ b/Documentation/git-checkout.txt
@@ -50,7 +50,9 @@ OPTIONS
 --track::
 	When -b is given and a branch is created off a remote branch,
 	set up configuration so that git-pull will automatically
-	retrieve data from the remote branch.  Set the
+	retrieve data from the remote branch.  Use this if you always
+	pull from the same remote branch into the new branch, or if you
+	don't want to use "git pull <repository> <refspec>" explicitly.  Set the
 	branch.autosetupmerge configuration variable to true if you
 	want git-checkout and git-branch to always behave as if
 	'--track' were given.