[PATCH] Documentation: read-tree consistent usage of working tree

[PATCH] Documentation: read-tree consistent usage of working tree

[Lars Vogel]

http://git-scm.com/docs/git-clone speaks only about working tree, the
usage of "working directory" for working tree is confusing. Working
directory describes the current directory while working tree describes
all files and sub directories.

Signed-off-by: Lars Vogel <Lars.Vogel@vogella.com>
---
 Documentation/git-read-tree.txt | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt
index fa1d557..21daee9 100644
--- a/Documentation/git-read-tree.txt
+++ b/Documentation/git-read-tree.txt
@@ -378,15 +378,15 @@ have finished your work-in-progress), attempt the merge again.
 Sparse checkout
 ---------------
 
-"Sparse checkout" allows populating the working directory sparsely.
+"Sparse checkout" allows populating the working tree sparsely.
 It uses the skip-worktree bit (see linkgit:git-update-index[1]) to tell
-Git whether a file in the working directory is worth looking at.
+Git whether a file in the working tree is worth looking at.
 
 'git read-tree' and other merge-based commands ('git merge', 'git
 checkout'...) can help maintaining the skip-worktree bitmap and working
 directory update. `$GIT_DIR/info/sparse-checkout` is used to
 define the skip-worktree reference bitmap. When 'git read-tree' needs
-to update the working directory, it resets the skip-worktree bit in the index
+to update the working tree, it resets the skip-worktree bit in the index
 based on this file, which uses the same syntax as .gitignore files.
 If an entry matches a pattern in this file, skip-worktree will not be
 set on that entry. Otherwise, skip-worktree will be set.
@@ -404,7 +404,7 @@ negate patterns. For example, to remove the file `unwanted`:
 !unwanted
 ----------------
 
-Another tricky thing is fully repopulating the working directory when you
+Another tricky thing is fully repopulating the working tree when you
 no longer want sparse checkout. You cannot just disable "sparse
 checkout" because skip-worktree bits are still in the index and your working
 directory is still sparsely populated. You should re-populate the working
-- 
2.5.0

Re: [PATCH] Documentation: read-tree consistent usage of working tree

[Junio C Hamano]

Lars Vogel <lars.vogel@vogella.com> writes:

> http://git-scm.com/docs/git-clone speaks only about working tree, the
> usage of "working directory" for working tree is confusing. Working
> directory describes the current directory while working tree describes
> all files and sub directories.

Actually I think the $cwd is the "Current working directory"; the
phrase "Working directory" alone does not specifically refer to $cwd.

Being consistent to call the checked out file hierarchy "working tree"
is probably a good idea nevertheless.

> Signed-off-by: Lars Vogel <Lars.Vogel@vogella.com>
> ---

If you apply this patch and then run

    $ git grep -B1 '^directory' Documentation/git-read-tree.txt

you would notice that the patch has missed a few more.

Also

    $ git grep 'work tree' Documentation/git-read-tree.txt

has a handful of hits.

Perhaps try again?

Thanks.

[PATCH] Documentation: read-tree consistent usage of working tree

[Lars Vogel]

http://git-scm.com/docs/git-clone speaks only about working tree, the
usage of "working directory" for working tree is confusing. Working tree
describes the current directory.

Signed-off-by: Lars Vogel <Lars.Vogel@vogella.com>
---
 Documentation/git-read-tree.txt | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt
index fa1d557..21daee9 100644
--- a/Documentation/git-read-tree.txt
+++ b/Documentation/git-read-tree.txt
@@ -378,15 +378,15 @@ have finished your work-in-progress), attempt the merge again.
 Sparse checkout
 ---------------
 
-"Sparse checkout" allows populating the working directory sparsely.
+"Sparse checkout" allows populating the working tree sparsely.
 It uses the skip-worktree bit (see linkgit:git-update-index[1]) to tell
-Git whether a file in the working directory is worth looking at.
+Git whether a file in the working tree is worth looking at.
 
 'git read-tree' and other merge-based commands ('git merge', 'git
 checkout'...) can help maintaining the skip-worktree bitmap and working
 directory update. `$GIT_DIR/info/sparse-checkout` is used to
 define the skip-worktree reference bitmap. When 'git read-tree' needs
-to update the working directory, it resets the skip-worktree bit in the index
+to update the working tree, it resets the skip-worktree bit in the index
 based on this file, which uses the same syntax as .gitignore files.
 If an entry matches a pattern in this file, skip-worktree will not be
 set on that entry. Otherwise, skip-worktree will be set.
@@ -404,7 +404,7 @@ negate patterns. For example, to remove the file `unwanted`:
 !unwanted
 ----------------
 
-Another tricky thing is fully repopulating the working directory when you
+Another tricky thing is fully repopulating the working tree when you
 no longer want sparse checkout. You cannot just disable "sparse
 checkout" because skip-worktree bits are still in the index and your working
 directory is still sparsely populated. You should re-populate the working
-- 
2.1.4