diff --git a/Documentation/config/checkout.txt b/Documentation/config/checkout.txt index 6b646813ab..e3684a5459 100644 --- a/Documentation/config/checkout.txt +++ b/Documentation/config/checkout.txt @@ -1,18 +1,18 @@ checkout.defaultRemote:: - When you run 'git checkout ' - or 'git switch ' and only have one + When you run `git checkout ` + or `git switch ` and only have one remote, it may implicitly fall back on checking out and - tracking e.g. 'origin/'. This stops working as soon - as you have more than one remote with a '' + tracking e.g. `origin/`. This stops working as soon + as you have more than one remote with a `` 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 ' -or 'git switch ' -will checkout the '' branch on another remote, -and by linkgit:git-worktree[1] when 'git worktree add' refers to a +linkgit:git-checkout[1] when `git checkout ` +or `git switch ` +will checkout the `` 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.