[thirdparty/git.git] / Documentation / config / checkout.txt

checkout.defaultRemote::
	When you run 'git checkout <something>'
	or 'git switch <something>' and only have one
	remote, it may implicitly fall back on checking out and
	tracking e.g. 'origin/<something>'. This stops working as soon
	as you have more than one remote with a '<something>'
	reference. This setting allows for setting the name of a
	preferred remote that should always win when it comes to
	disambiguation. The typical use-case is to set this to
	`origin`.
+
Currently this is used by linkgit:git-switch[1] and
linkgit:git-checkout[1] when 'git checkout <something>'
or 'git switch <something>'
will checkout the '<something>' branch on another remote,
and by linkgit:git-worktree[1] when 'git worktree add' refers to a
remote branch. This setting might be used for other checkout-like
commands or functionality in the future.
Commit	Line	Data
9140b410	1	checkout.defaultRemote::
d787d311 NTND	2	When you run 'git checkout <something>'
d787d311 NTND	3	or 'git switch <something>' and only have one
9140b410 NTND	4	remote, it may implicitly fall back on checking out and
	5	tracking e.g. 'origin/<something>'. This stops working as soon
	6	as you have more than one remote with a '<something>'
	7	reference. This setting allows for setting the name of a
	8	preferred remote that should always win when it comes to
	9	disambiguation. The typical use-case is to set this to
	10	`origin`.
	11	+
d787d311 NTND	12	Currently this is used by linkgit:git-switch[1] and
	13	linkgit:git-checkout[1] when 'git checkout <something>'
	14	or 'git switch <something>'
	15	will checkout the '<something>' branch on another remote,
9140b410 NTND	16	and by linkgit:git-worktree[1] when 'git worktree add' refers to a
	17	remote branch. This setting might be used for other checkout-like
	18	commands or functionality in the future.