Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@xxxxxxxxx> --- Documentation/checkout-config.txt | 23 +++++++++++++++++++++++ Documentation/config.txt | 24 +----------------------- 2 files changed, 24 insertions(+), 23 deletions(-) create mode 100644 Documentation/checkout-config.txt diff --git a/Documentation/checkout-config.txt b/Documentation/checkout-config.txt new file mode 100644 index 0000000000..c4118fa196 --- /dev/null +++ b/Documentation/checkout-config.txt @@ -0,0 +1,23 @@ +checkout.defaultRemote:: + When you run 'git checkout <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-checkout[1] when 'git checkout +<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. + +checkout.optimizeNewBranch:: + Optimizes the performance of "git checkout -b <new_branch>" when + using sparse-checkout. When set to true, git will not update the + repo based on the current sparse-checkout settings. This means it + will not update the skip-worktree bit in the index nor add/remove + files in the working directory to reflect the current sparse checkout + settings nor will it show the local changes. diff --git a/Documentation/config.txt b/Documentation/config.txt index 407fd390a2..8d890cc22a 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -305,29 +305,7 @@ include::branch-config.txt[] include::browser-config.txt[] -checkout.defaultRemote:: - When you run 'git checkout <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-checkout[1] when 'git checkout -<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. - -checkout.optimizeNewBranch:: - Optimizes the performance of "git checkout -b <new_branch>" when - using sparse-checkout. When set to true, git will not update the - repo based on the current sparse-checkout settings. This means it - will not update the skip-worktree bit in the index nor add/remove - files in the working directory to reflect the current sparse checkout - settings nor will it show the local changes. +include::checkout-config.txt[] clean.requireForce:: A boolean to make git-clean do nothing unless given -f, -- 2.19.1.647.g708186aaf9
