undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

worktree: use 'worktree' over 'working tree'

Browse Source 
It is helpful to distinguish between a 'working tree' and a 'worktree'.
A worktree contains a working tree plus additional metadata. This
metadata includes per-worktree refs and worktree-specific config.

This is the fifth of multiple changes to git-worktree.txt, restricted to
the CONFIGURATION FILE section.

While here, clear up some language to improve readability.

Helped-by: Taylor Blau <me@ttaylorr.com>
Signed-off-by: Derrick Stolee <derrickstolee@github.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Derrick Stolee 2022-02-23 14:29:17 +00:00 committed by Junio C Hamano
parent a777d4c750
commit 7b215826f3
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Documentation/git-worktree.txt
View File

@ -284,13 +284,13 @@ which will handle refs correctly.
CONFIGURATION FILE CONFIGURATION FILE
------------------ ------------------
By default, the repository `config` file is shared across all working By default, the repository `config` file is shared across all worktrees.
trees. If the config variables `core.bare` or `core.worktree` are If the config variables `core.bare` or `core.worktree` are present in the
present in the common config file and `extensions.worktreeConfig` is common config file and `extensions.worktreeConfig` is disabled, then they
disabled, then they will be applied to the main working tree only. will be applied to the main worktree only.
In order to have configuration specific to working trees, you can turn In order to have worktree-specific configuration, you can turn on the
on the `worktreeConfig` extension, e.g.: `worktreeConfig` extension, e.g.:
------------ ------------
$ git config extensions.worktreeConfig true $ git config extensions.worktreeConfig true
@ -303,16 +303,16 @@ versions will refuse to access repositories with this extension.
Note that in this file, the exception for `core.bare` and `core.worktree` Note that in this file, the exception for `core.bare` and `core.worktree`
is gone. If they exist in `$GIT_DIR/config`, you must move is gone. If they exist in `$GIT_DIR/config`, you must move
them to the `config.worktree` of the main working tree. You may also them to the `config.worktree` of the main worktree. You may also take this
take this opportunity to review and move other configuration that you opportunity to review and move other configuration that you do not want to
do not want to share to all working trees: share to all worktrees:
- `core.worktree` should never be shared. - `core.worktree` should never be shared.
- `core.bare` should not be shared if the value is `core.bare=true`. - `core.bare` should not be shared if the value is `core.bare=true`.
- `core.sparseCheckout` is recommended per working tree, unless you - `core.sparseCheckout` should not be shared, unless you are sure you
are sure you always use sparse checkout for all working trees. always use sparse checkout for all worktrees.
See the documentation of `extensions.worktreeConfig` in See the documentation of `extensions.worktreeConfig` in
linkgit:git-config[1] for more details. linkgit:git-config[1] for more details.