From: Derrick Stolee <derrickstolee@github.com>
To: Philip Oakley <philipoakley@iee.email>,
Derrick Stolee via GitGitGadget <gitgitgadget@gmail.com>,
git@vger.kernel.org
Cc: "Elijah Newren [ ]" <newren@gmail.com>,
"Jean-Noël AVILA [ ]" <jn.avila@free.fr>
Subject: Re: [PATCH 05/11] worktree: use 'worktree' over 'working tree'
Date: Thu, 24 Feb 2022 10:53:41 -0500 [thread overview]
Message-ID: <545f0248-89ad-3194-02ae-2f1a47f949db@github.com> (raw)
In-Reply-To: <d9394947-f545-2dd9-b788-38fd7202243d@iee.email>
On 2/24/2022 9:33 AM, Philip Oakley wrote:
> On 20/02/2022 17:54, Derrick Stolee via GitGitGadget wrote:
>> From: Derrick Stolee <derrickstolee@github.com>
>>
>> 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.
> Doesn't this need a clear call-out in the text to highlight the
> distinction, so that it is obvious at first glance to the casual reader?
>
> I'd ended up with something like:
> - worktree
> A directory whose files and sub-directories are (selectively) under
> Git revision management.
> - working tree
> The working tree comprises Git revision management meta-data for the
> worktree,
> and the worktree itself.
> The meta-data may be independently located away from the worktree's
> data.
>
> The key feature is to have a layout structure that shows the distinction.
See below where I mention that the first paragraph points out this
distinction. Your use of bullets makes it even more clear, and I think
that would be more valuable if this wasn't the very first thing in the
document.
> Or are we trying to remove all references to "working tree"? Or have I
> misunderstood?
...
>> A git repository can support multiple working trees, allowing you to check
> Are we removing the above "working trees" phrases as well?
This one is important to keep. The worktree feature is how Git manages
multiple working trees.
The reason for switching most of the other references is because the
discussion applies specifically to worktrees, not working trees.
>> out more than one branch at a time. With `git worktree add` a new working
>> -tree is associated with the repository. This new working tree is called a
>> -"linked working tree" as opposed to the "main working tree" prepared by
>> -linkgit:git-init[1] or linkgit:git-clone[1].
>> -A repository has one main working tree (if it's not a
>> -bare repository) and zero or more linked working trees. When you are done
>> -with a linked working tree, remove it with `git worktree remove`.
>> +tree is associated with the repository, along with additional metadata
>> +that differentiates that working tree from others in the same repository.
>> +The working tree, along with this metada, is called a "worktree".
This first paragraph is all about the distinction between working tree
and worktree, so it hopefully handles the concerns you had above.
Thanks,
-Stolee
next prev parent reply other threads:[~2022-02-24 15:53 UTC|newest]
Thread overview: 63+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-02-20 17:54 [PATCH 00/11] Updates to worktree code and docs Derrick Stolee via GitGitGadget
2022-02-20 17:54 ` [PATCH 01/11] worktree: combine two translatable messages Derrick Stolee via GitGitGadget
2022-02-20 20:22 ` Junio C Hamano
2022-02-20 20:29 ` Derrick Stolee
2022-02-20 17:54 ` [PATCH 02/11] worktree: extract copy_filtered_worktree_config() Derrick Stolee via GitGitGadget
2022-02-20 20:26 ` Junio C Hamano
2022-02-20 17:54 ` [PATCH 03/11] worktree: extract copy_sparse_checkout() Derrick Stolee via GitGitGadget
2022-02-20 17:54 ` [PATCH 04/11] worktree: extract checkout_worktree() Derrick Stolee via GitGitGadget
2022-02-20 21:59 ` Taylor Blau
2022-02-20 17:54 ` [PATCH 05/11] worktree: use 'worktree' over 'working tree' Derrick Stolee via GitGitGadget
2022-02-20 20:42 ` Junio C Hamano
2022-02-20 20:48 ` Derrick Stolee
2022-02-24 14:33 ` Philip Oakley
2022-02-24 15:53 ` Derrick Stolee [this message]
2022-03-03 15:41 ` Philip Oakley
2022-02-20 17:54 ` [PATCH 06/11] " Derrick Stolee via GitGitGadget
2022-02-20 17:54 ` [PATCH 07/11] " Derrick Stolee via GitGitGadget
2022-02-20 17:54 ` [PATCH 08/11] " Derrick Stolee via GitGitGadget
2022-02-20 22:29 ` Taylor Blau
2022-02-20 17:54 ` [PATCH 09/11] " Derrick Stolee via GitGitGadget
2022-02-20 22:31 ` Taylor Blau
2022-02-21 2:26 ` Derrick Stolee
2022-02-20 17:54 ` [PATCH 10/11] " Derrick Stolee via GitGitGadget
2022-02-20 17:54 ` [PATCH 11/11] " Derrick Stolee via GitGitGadget
2022-02-20 22:37 ` Taylor Blau
2022-02-21 2:11 ` Derrick Stolee
2022-02-20 22:38 ` [PATCH 00/11] Updates to worktree code and docs Taylor Blau
2022-02-20 22:41 ` Taylor Blau
2022-02-22 0:17 ` [PATCH v2 " Derrick Stolee via GitGitGadget
2022-02-22 0:17 ` [PATCH v2 01/11] worktree: combine two translatable messages Derrick Stolee via GitGitGadget
2022-02-22 0:17 ` [PATCH v2 02/11] worktree: extract copy_filtered_worktree_config() Derrick Stolee via GitGitGadget
2022-02-22 0:17 ` [PATCH v2 03/11] worktree: extract copy_sparse_checkout() Derrick Stolee via GitGitGadget
2022-02-22 0:17 ` [PATCH v2 04/11] worktree: extract checkout_worktree() Derrick Stolee via GitGitGadget
2022-02-22 0:17 ` [PATCH v2 05/11] worktree: use 'worktree' over 'working tree' Derrick Stolee via GitGitGadget
2022-02-22 7:22 ` Junio C Hamano
2022-02-23 6:47 ` Elijah Newren
2022-02-22 0:17 ` [PATCH v2 06/11] " Derrick Stolee via GitGitGadget
2022-02-22 7:22 ` Junio C Hamano
2022-02-22 14:06 ` Derrick Stolee
2022-02-22 0:17 ` [PATCH v2 07/11] " Derrick Stolee via GitGitGadget
2022-02-22 0:17 ` [PATCH v2 08/11] " Derrick Stolee via GitGitGadget
2022-02-22 19:49 ` Taylor Blau
2022-02-22 21:24 ` Derrick Stolee
2022-02-23 0:05 ` Taylor Blau
2022-02-22 0:17 ` [PATCH v2 09/11] " Derrick Stolee via GitGitGadget
2022-02-22 0:17 ` [PATCH v2 10/11] " Derrick Stolee via GitGitGadget
2022-02-22 0:18 ` [PATCH v2 11/11] " Derrick Stolee via GitGitGadget
2022-02-22 19:50 ` [PATCH v2 00/11] Updates to worktree code and docs Taylor Blau
2022-02-23 20:24 ` Junio C Hamano
2022-02-23 6:51 ` Elijah Newren
2022-02-23 14:26 ` Derrick Stolee
2022-02-23 14:29 ` [PATCH v3 " Derrick Stolee via GitGitGadget
2022-02-23 14:29 ` [PATCH v3 01/11] worktree: combine two translatable messages Derrick Stolee via GitGitGadget
2022-02-23 14:29 ` [PATCH v3 02/11] worktree: extract copy_filtered_worktree_config() Derrick Stolee via GitGitGadget
2022-02-23 14:29 ` [PATCH v3 03/11] worktree: extract copy_sparse_checkout() Derrick Stolee via GitGitGadget
2022-02-23 14:29 ` [PATCH v3 04/11] worktree: extract checkout_worktree() Derrick Stolee via GitGitGadget
2022-02-23 14:29 ` [PATCH v3 05/11] worktree: use 'worktree' over 'working tree' Derrick Stolee via GitGitGadget
2022-02-23 14:29 ` [PATCH v3 06/11] " Derrick Stolee via GitGitGadget
2022-02-23 14:29 ` [PATCH v3 07/11] " Derrick Stolee via GitGitGadget
2022-02-23 14:29 ` [PATCH v3 08/11] " Derrick Stolee via GitGitGadget
2022-02-23 14:29 ` [PATCH v3 09/11] " Derrick Stolee via GitGitGadget
2022-02-23 14:29 ` [PATCH v3 10/11] " Derrick Stolee via GitGitGadget
2022-02-23 14:29 ` [PATCH v3 11/11] " Derrick Stolee via GitGitGadget
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=545f0248-89ad-3194-02ae-2f1a47f949db@github.com \
--to=derrickstolee@github.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=jn.avila@free.fr \
--cc=newren@gmail.com \
--cc=philipoakley@iee.email \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).