git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: git@vger.kernel.org
Subject: [PATCH v1 0/3] War on "work tree"
Date: Tue, 11 Nov 2025 11:58:50 -0800	[thread overview]
Message-ID: <20251111195853.2511146-1-gitster@pobox.com> (raw)

There are "working tree", which is explained as

	The tree of actual checked out files.  The working tree normally
	contains the contents of the <<def_HEAD,HEAD>> commit's tree,
	plus any local changes that you have made but not yet committed.

and "worktree", which is explained as

	A repository can have zero (i.e. bare repository) or one or
	more worktrees attached to it. One "worktree" consists of a
	"working tree" and repository metadata, most of which are
	shared among other worktrees of a single repository, and
	some of which are maintained separately per worktree
	(e.g. the index, HEAD and pseudorefs like MERGE_HEAD,
	per-worktree refs and per-worktree configuration file).

in the glossary, but there are many documentation pages that talk
about "work tree".  Most of them were written before the worktree
mechanism was invented (i.e., back when contrib/workdir was the only
hacky mechanism to attach more than one directories to the same
repository) and they use "work tree" (two words) to mean what we
call "working tree" these days.

This patch series updates our documentation to use either "working
tree" or "worktree" as appropriate.

Junio C Hamano (3):
  notes doc: call NOTES_MERGE_WORKTREE a "worktree", not "work tree"
  Documentation: your checkout directory is "working tree" (part 1)
  Documentation: your checkout directory is "working tree" (part 2)

 Documentation/diff-format.adoc     |  2 +-
 Documentation/diff-options.adoc    |  2 +-
 Documentation/git-add.adoc         |  4 ++--
 Documentation/git-grep.adoc        |  2 +-
 Documentation/git-hash-object.adoc |  2 +-
 Documentation/git-notes.adoc       |  4 ++--
 Documentation/git-read-tree.adoc   | 16 ++++++++--------
 Documentation/git-rev-parse.adoc   |  4 ++--
 Documentation/git-rm.adoc          |  8 ++++----
 Documentation/git-stash.adoc       |  2 +-
 Documentation/git-status.adoc      | 14 +++++++-------
 Documentation/git-submodule.adoc   |  4 ++--
 Documentation/gitattributes.adoc   | 16 ++++++++--------
 Documentation/gitcli.adoc          | 12 ++++++------
 Documentation/gitmodules.adoc      |  2 +-
 Documentation/user-manual.adoc     |  8 ++++----
 16 files changed, 51 insertions(+), 51 deletions(-)

-- 
2.52.0-rc1-455-g30608eb744


             reply	other threads:[~2025-11-11 19:58 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-11 19:58 Junio C Hamano [this message]
2025-11-11 19:58 ` [PATCH v1 1/3] notes doc: call NOTES_MERGE_WORKTREE a "worktree", not "work tree" Junio C Hamano
2025-11-11 19:58 ` [PATCH v1 2/3] Documentation: your checkout directory is "working tree" (part 1) Junio C Hamano
2025-11-12  6:41   ` Patrick Steinhardt
2025-11-11 19:58 ` [PATCH v1 3/3] Documentation: your checkout directory is "working tree" (part 2) Junio C Hamano

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=20251111195853.2511146-1-gitster@pobox.com \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    /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).