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 <me@ttaylorr.com> Signed-off-by: Derrick Stolee <derrickstolee@github.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Derrick Stolee committed
Feb 23, 2022 at 14:29 UTC
7b215826f32f9fd0dc58703f012326dba6006e34
1 file changed
+11
-11
Documentation/git-worktree.txt
+11
-11
@@ -284,13 +284,13 @@ which will handle refs correctly.
284
285
CONFIGURATION FILE
286
------------------
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.
291
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.:
294
295
------------
296
$ git config extensions.worktreeConfig true
@@ -303,16 +303,16 @@ versions will refuse to access repositories with this extension.
303
304
Note that in this file, the exception for `core.bare` and `core.worktree`
305
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:
309
310
- `core.worktree` should never be shared.
311
312
- `core.bare` should not be shared if the value is `core.bare=true`.
313
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.
316
317
See the documentation of `extensions.worktreeConfig` in
318
linkgit:git-config[1] for more details.