Skip to content

Commit 7b21582

Browse files
derrickstoleegitster
authored andcommitted
worktree: use 'worktree' over 'working tree'
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 <[email protected]> Signed-off-by: Derrick Stolee <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent a777d4c commit 7b21582

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

Documentation/git-worktree.txt

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -284,13 +284,13 @@ which will handle refs correctly.
284284

285285
CONFIGURATION FILE
286286
------------------
287-
By default, the repository `config` file is shared across all working
288-
trees. If the config variables `core.bare` or `core.worktree` are
289-
present in the common config file and `extensions.worktreeConfig` is
290-
disabled, then they will be applied to the main working tree only.
287+
By default, the repository `config` file is shared across all worktrees.
288+
If the config variables `core.bare` or `core.worktree` are present in the
289+
common config file and `extensions.worktreeConfig` is disabled, then they
290+
will be applied to the main worktree only.
291291

292-
In order to have configuration specific to working trees, you can turn
293-
on the `worktreeConfig` extension, e.g.:
292+
In order to have worktree-specific configuration, you can turn on the
293+
`worktreeConfig` extension, e.g.:
294294

295295
------------
296296
$ git config extensions.worktreeConfig true
@@ -303,16 +303,16 @@ versions will refuse to access repositories with this extension.
303303

304304
Note that in this file, the exception for `core.bare` and `core.worktree`
305305
is gone. If they exist in `$GIT_DIR/config`, you must move
306-
them to the `config.worktree` of the main working tree. You may also
307-
take this opportunity to review and move other configuration that you
308-
do not want to share to all working trees:
306+
them to the `config.worktree` of the main worktree. You may also take this
307+
opportunity to review and move other configuration that you do not want to
308+
share to all worktrees:
309309

310310
- `core.worktree` should never be shared.
311311

312312
- `core.bare` should not be shared if the value is `core.bare=true`.
313313

314-
- `core.sparseCheckout` is recommended per working tree, unless you
315-
are sure you always use sparse checkout for all working trees.
314+
- `core.sparseCheckout` should not be shared, unless you are sure you
315+
always use sparse checkout for all worktrees.
316316

317317
See the documentation of `extensions.worktreeConfig` in
318318
linkgit:git-config[1] for more details.

0 commit comments

Comments
 (0)