[PATCH] change ent to tree in git-diff documentation

[PATCH] change ent to tree in git-diff documentation

[Matthias Lederhofer]

---
This is quite confusing for someone new to git who is not familiar
with the vocabulary used with git. I don't think a man page is the
right place for riddles :)
Additionaly I changed two times 'is' to 'are', I hope this is correct.

 Documentation/git-diff.txt |   18 +++++++++---------
 1 files changed, 9 insertions(+), 9 deletions(-)

83ace740fdf1e064168f8438a6ad863986cf4832
diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt
index 890931c..41d85cf 100644
--- a/Documentation/git-diff.txt
+++ b/Documentation/git-diff.txt
@@ -8,24 +8,24 @@ git-diff - Show changes between commits,
 
 SYNOPSIS
 --------
-'git-diff' [ --diff-options ] <ent>{0,2} [<path>...]
+'git-diff' [ --diff-options ] <tree-ish>{0,2} [<path>...]
 
 DESCRIPTION
 -----------
-Show changes between two ents, an ent and the working tree, an
-ent and the index file, or the index file and the working tree.
+Show changes between two trees, a tree and the working tree, a
+tree and the index file, or the index file and the working tree.
 The combination of what is compared with what is determined by
-the number of ents given to the command.
+the number of trees given to the command.
 
-* When no <ent> is given, the working tree and the index
-  file is compared, using `git-diff-files`.
+* When no <tree-ish> is given, the working tree and the index
+  file are compared, using `git-diff-files`.
 
-* When one <ent> is given, the working tree and the named
-  tree is compared, using `git-diff-index`.  The option
+* When one <tree-ish> is given, the working tree and the named
+  tree are compared, using `git-diff-index`.  The option
   `--cached` can be given to compare the index file and
   the named tree.
 
-* When two <ent>s are given, these two trees are compared
+* When two <tree-ish>s are given, these two trees are compared
   using `git-diff-tree`.
 
 OPTIONS
-- 
1.3.1.g9af0

[PATCH] change ent to tree in git-diff documentation

[Matthias Lederhofer]

---
I've sent this patch a while ago and did not get any feedback, so here
it is again.
This is quite confusing for someone new to git who is not familiar
with the vocabulary used with git. I don't think a man page is the
right place for riddles :)
Additionaly I changed two times 'is' to 'are', I hope this is correct.

 Documentation/git-diff.txt |   18 +++++++++---------
 1 files changed, 9 insertions(+), 9 deletions(-)

83ace740fdf1e064168f8438a6ad863986cf4832
diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt
index 890931c..41d85cf 100644
--- a/Documentation/git-diff.txt
+++ b/Documentation/git-diff.txt
@@ -8,24 +8,24 @@ git-diff - Show changes between commits,
 
 SYNOPSIS
 --------
-'git-diff' [ --diff-options ] <ent>{0,2} [<path>...]
+'git-diff' [ --diff-options ] <tree-ish>{0,2} [<path>...]
 
 DESCRIPTION
 -----------
-Show changes between two ents, an ent and the working tree, an
-ent and the index file, or the index file and the working tree.
+Show changes between two trees, a tree and the working tree, a
+tree and the index file, or the index file and the working tree.
 The combination of what is compared with what is determined by
-the number of ents given to the command.
+the number of trees given to the command.
 
-* When no <ent> is given, the working tree and the index
-  file is compared, using `git-diff-files`.
+* When no <tree-ish> is given, the working tree and the index
+  file are compared, using `git-diff-files`.
 
-* When one <ent> is given, the working tree and the named
-  tree is compared, using `git-diff-index`.  The option
+* When one <tree-ish> is given, the working tree and the named
+  tree are compared, using `git-diff-index`.  The option
   `--cached` can be given to compare the index file and
   the named tree.
 
-* When two <ent>s are given, these two trees are compared
+* When two <tree-ish>s are given, these two trees are compared
   using `git-diff-tree`.
 
 OPTIONS
-- 
1.3.1.g9af0

Re: [PATCH] change ent to tree in git-diff documentation

[Junio C Hamano]

Matthias Lederhofer <matled@gmx.net> writes:

> This is quite confusing for someone new to git who is not familiar
> with the vocabulary used with git. I don't think a man page is the
> right place for riddles :)
> Additionaly I changed two times 'is' to 'are', I hope this is correct.

I am not attached to <ent> at all, but I do not know if this is
worth it.  I suspect there are many other places you need to fix
to make things consistent, and I think the first thing that
should be touched is glossary.txt.

... goes "git grep -w ent", gets quite surprised and comes back ...

Oops.  I think you are right and I was wrong saying the above
four lines.  It is only git-diff.txt and glossay entry that
talks about <ent>.

Whoever coined <ent> (I do not remember anymore) do you mind
this in addition to Matthias's patch?

-- >8 --
Eradicate <ent>

Technical documentation is not a place for riddles.

Signed-off-by: Junio C Hamano <junkio@cox.net>

---
diff --git a/Documentation/glossary.txt b/Documentation/glossary.txt
index 116ddb7..14449ca 100644
--- a/Documentation/glossary.txt
+++ b/Documentation/glossary.txt
@@ -86,7 +86,7 @@ directory::
 ent::
 	Favorite synonym to "tree-ish" by some total geeks. See
 	`http://en.wikipedia.org/wiki/Ent_(Middle-earth)` for an in-depth
-	explanation.
+	explanation.  Avoid this term, not to confuse people.
 
 fast forward::
 	A fast-forward is a special type of merge where you have

Re: [PATCH] change ent to tree in git-diff documentation

[Johannes Schindelin]

Hi,

On Sun, 9 Jul 2006, Junio C Hamano wrote:

> Whoever coined <ent> (I do not remember anymore) do you mind
> this in addition to Matthias's patch?

AFAIR it was me. It was meant as a geek's joke from the beginning, and I 
even had the pleasure of Linus calling me a total geek.

I do not have any objections against removing it. (AKA Ack.)

Ciao,
Dscho