threads / patch / 41218

patchConsistent usage of working tree in the git-add help

Subject: [PATCH] Consistent usage of working tree in the git-add help

## tl;dr

3 messages between Jan 19, 2016 and Jan 21, 2016. Diffs are folded; open one to read it.

replies: 2people: 3as markdown or json

Lars Vogel· Jan 19, 2016, 18:53 UTC · lore

The usage of working directory is inconsistent in the git add help. Also http://git-scm.com/docs/giit-clone speaks only about working tree. Remaining entry found by "git grep -B1 '^directory' git-add.txt" really relates to a directory.

Signed-off-by: Lars Vogel <Lars.Vogel@vogella.com>
---
 Documentation/git-add.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Show changes to Documentation/git-add.txt +2 −2
diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt
index fe5282f..cfef77b 100644
--- a/Documentation/git-add.txt
+++ b/Documentation/git-add.txt
@@ -24,7 +24,7 @@ remove paths that do not exist in the working tree anymore.
 
 The "index" holds a snapshot of the content of the working tree, and it
 is this snapshot that is taken as the contents of the next commit.  Thus
-after making any changes to the working directory, and before running
+after making any changes to the working tree, and before running
 the commit command, you must use the `add` command to add any new or
 modified files to the index.
 
@@ -85,7 +85,7 @@ OPTIONS
 -p::
 --patch::
 	Interactively choose hunks of patch between the index and the
-	work tree and add them to the index. This gives the user a chance
+	working tree and add them to the index. This gives the user a chance
 	to review the difference before adding modified contents to the
 	index.
 +
-- 
2.7.0
Junio C Hamano· Jan 21, 2016, 00:24 UTC · re: Lars Vogel · lore

Re: [PATCH] Consistent usage of working tree in the git-add help

Lars Vogel <lars.vogel@gmail.com> writes:
Show 32 quoted lines
> The usage of working directory is inconsistent in the git add help.
> Also http://git-scm.com/docs/giit-clone speaks only about working tree.
> Remaining entry found by "git grep -B1 '^directory' git-add.txt" really
> relates to a directory.
>
> Signed-off-by: Lars Vogel <Lars.Vogel@vogella.com>
> ---
>  Documentation/git-add.txt | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt
> index fe5282f..cfef77b 100644
> --- a/Documentation/git-add.txt
> +++ b/Documentation/git-add.txt
> @@ -24,7 +24,7 @@ remove paths that do not exist in the working tree anymore.
>  
>  The "index" holds a snapshot of the content of the working tree, and it
>  is this snapshot that is taken as the contents of the next commit.  Thus
> -after making any changes to the working directory, and before running
> +after making any changes to the working tree, and before running
>  the commit command, you must use the `add` command to add any new or
>  modified files to the index.
>  
> @@ -85,7 +85,7 @@ OPTIONS
>  -p::
>  --patch::
>  	Interactively choose hunks of patch between the index and the
> -	work tree and add them to the index. This gives the user a chance
> +	working tree and add them to the index. This gives the user a chance
>  	to review the difference before adding modified contents to the
>  	index.
>  +

Thanks. While the first hunk looks to me a definite improvement, I am lukewarm about s/work tree/working tree/ change. Both terms are used fairly commonly in our documentation set. "Work tree" has ~70 hits vs ~350 for "working tree" (ignoring the case where these words are split across lines, i.e. "work/working" at the end of the line followed by a line that begins with "tree").

Lars Vogel· Jan 21, 2016, 09:56 UTC · re: Junio C Hamano · lore

Re: [PATCH] Consistent usage of working tree in the git-add help

Thanks Junio for the feedback. I send a new patch with only the first change.
On Thu, Jan 21, 2016 at 1:24 AM, Junio C Hamano <gitster@pobox.com> wrote:
Show 41 quoted lines
> Lars Vogel <lars.vogel@gmail.com> writes:
>
>> The usage of working directory is inconsistent in the git add help.
>> Also http://git-scm.com/docs/giit-clone speaks only about working tree.
>> Remaining entry found by "git grep -B1 '^directory' git-add.txt" really
>> relates to a directory.
>>
>> Signed-off-by: Lars Vogel <Lars.Vogel@vogella.com>
>> ---
>>  Documentation/git-add.txt | 4 ++--
>>  1 file changed, 2 insertions(+), 2 deletions(-)
>>
>> diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt
>> index fe5282f..cfef77b 100644
>> --- a/Documentation/git-add.txt
>> +++ b/Documentation/git-add.txt
>> @@ -24,7 +24,7 @@ remove paths that do not exist in the working tree anymore.
>>
>>  The "index" holds a snapshot of the content of the working tree, and it
>>  is this snapshot that is taken as the contents of the next commit.  Thus
>> -after making any changes to the working directory, and before running
>> +after making any changes to the working tree, and before running
>>  the commit command, you must use the `add` command to add any new or
>>  modified files to the index.
>>
>> @@ -85,7 +85,7 @@ OPTIONS
>>  -p::
>>  --patch::
>>       Interactively choose hunks of patch between the index and the
>> -     work tree and add them to the index. This gives the user a chance
>> +     working tree and add them to the index. This gives the user a chance
>>       to review the difference before adding modified contents to the
>>       index.
>>  +
>
> Thanks.  While the first hunk looks to me a definite improvement, I
> am lukewarm about s/work tree/working tree/ change.  Both terms are
> used fairly commonly in our documentation set.  "Work tree" has ~70
> hits vs ~350 for "working tree" (ignoring the case where these words
> are split across lines, i.e. "work/working" at the end of the line
> followed by a line that begins with "tree").
-- 
Eclipse Platform UI and e4 project co-lead
CEO vogella GmbH

Haindaalwisch 17a, 22395 Hamburg
Amtsgericht Hamburg: HRB 127058
Geschäftsführer: Lars Vogel, Jennifer Nerlich de Vogel
USt-IdNr.: DE284122352
Fax (040) 5247 6322, Email: lars.vogel@vogella.com, Web: http://www.vogella.com

← back to recent threads