git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Richard Hansen <rhansen@bbn.com>
To: git@vger.kernel.org, gitster@pobox.com
Cc: Richard Hansen <rhansen@bbn.com>
Subject: [PATCH v3 5/7] glossary: more precise definition of tree-ish (a.k.a. treeish)
Date: Wed,  4 Sep 2013 15:04:32 -0400	[thread overview]
Message-ID: <1378321474-7125-6-git-send-email-rhansen@bbn.com> (raw)
In-Reply-To: <1378321474-7125-1-git-send-email-rhansen@bbn.com>

A tree-ish isn't a ref.  Also, mention dereferencing, and that a
commit dereferences to a tree, to support gitrevisions(7) and
rev-parse's error messages.

Signed-off-by: Richard Hansen <rhansen@bbn.com>
---
 Documentation/glossary-content.txt | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)

diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
index 47e901e..3466ce9 100644
--- a/Documentation/glossary-content.txt
+++ b/Documentation/glossary-content.txt
@@ -499,9 +499,18 @@ should not be combined with other pathspec.
 	<<def_tree,tree>> is equivalent to a <<def_directory,directory>>.
 
 [[def_tree-ish]]tree-ish (also treeish)::
-	A <<def_ref,ref>> pointing to either a <<def_commit_object,commit
-	object>>, a <<def_tree_object,tree object>>, or a <<def_tag_object,tag
-	object>> pointing to a tag or commit or tree object.
+	A <<def_tree_object,tree object>> or an <<def_object,object>>
+	that can be recursively dereferenced to a tree object.
+	Dereferencing a <<def_commit_object,commit object>> yields the
+	tree object corresponding to the <<def_revision,revision>>'s
+	top <<def_directory,directory>>.
+	The following are all tree-ishes:
+	a <<def_commit-ish,commit-ish>>,
+	a tree object,
+	a <<def_tag_object,tag object>> that points to a tree object,
+	a tag object that points to a tag object that points to a tree
+	object,
+	etc.
 
 [[def_unmerged_index]]unmerged index::
 	An <<def_index,index>> which contains unmerged
-- 
1.8.4

  parent reply	other threads:[~2013-09-04 19:05 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-09-02  5:34 [PATCH v2 0/7] documentation cleanups for <rev>^{<type>} Richard Hansen
2013-09-02  5:34 ` [PATCH v2 1/7] glossary: mention 'treeish' as an alternative to 'tree-ish' Richard Hansen
2013-09-03 22:46   ` Junio C Hamano
2013-09-04 19:04     ` [PATCH v3 0/7] documentation cleanups for <rev>^{<type>} Richard Hansen
2013-09-04 19:04       ` [PATCH v3 1/7] glossary: mention 'treeish' as an alternative to 'tree-ish' Richard Hansen
2013-09-04 19:04       ` [PATCH v3 2/7] glossary: define commit-ish (a.k.a. committish) Richard Hansen
2013-09-04 19:04       ` [PATCH v3 3/7] use 'tree-ish' instead of 'treeish' Richard Hansen
2013-09-04 19:04       ` [PATCH v3 4/7] use 'commit-ish' instead of 'committish' Richard Hansen
2013-09-04 19:04       ` Richard Hansen [this message]
2013-09-04 19:04       ` [PATCH v3 6/7] revisions.txt: fix and clarify <rev>^{<type>} Richard Hansen
2013-09-04 19:04       ` [PATCH v3 7/7] glossary: fix and clarify the definition of 'ref' Richard Hansen
2013-09-04 22:27       ` [PATCH v3 0/7] documentation cleanups for <rev>^{<type>} Junio C Hamano
2013-09-02  5:34 ` [PATCH v2 2/7] glossary: define committish (a.k.a. commit-ish) Richard Hansen
2013-09-02  5:34 ` [PATCH v2 3/7] use 'treeish' instead of 'tree-ish' Richard Hansen
2013-09-02  5:34 ` [PATCH v2 4/7] use 'committish' instead of 'commit-ish' Richard Hansen
2013-09-02  5:34 ` [PATCH v2 5/7] glossary: more precise definition of treeish (a.k.a. tree-ish) Richard Hansen
2013-09-02  5:34 ` [PATCH v2 6/7] revisions.txt: fix and clarify <rev>^{<type>} Richard Hansen
2013-09-02  5:34 ` [PATCH v2 7/7] glossary: fix and clarify the definition of 'ref' Richard Hansen

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=1378321474-7125-6-git-send-email-rhansen@bbn.com \
    --to=rhansen@bbn.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /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).