From: Richard Hansen <rhansen@bbn.com>
To: git@vger.kernel.org, gitster@pobox.com
Cc: Richard Hansen <rhansen@bbn.com>
Subject: [PATCH 3/4] glossary: more precise definition of tree-ish (a.k.a. treeish)
Date: Tue, 18 Jun 2013 22:09:39 -0400 [thread overview]
Message-ID: <1371607780-2966-4-git-send-email-rhansen@bbn.com> (raw)
In-Reply-To: <1371607780-2966-1-git-send-email-rhansen@bbn.com>
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 | 16 +++++++++++++---
1 file changed, 13 insertions(+), 3 deletions(-)
diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
index a3cc003..9a50fe1 100644
--- a/Documentation/glossary-content.txt
+++ b/Documentation/glossary-content.txt
@@ -498,9 +498,19 @@ 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_ref,ref>> pointing to an <<def_object,object>> that
+ can be recursively dereferenced to a
+ <<def_tree_object,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_committish,committish>>,
+ a ref pointing to a tree object,
+ a ref pointing to a <<def_tag_object,tag object>> that points
+ to a tree object,
+ a ref pointing to 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.3.1
next prev parent reply other threads:[~2013-06-19 2:43 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-06-19 2:09 [PATCH 0/4] documentation cleanups for <rev>^{<type>} Richard Hansen
2013-06-19 2:09 ` [PATCH 1/4] glossary: add 'treeish' as a synonym for 'tree-ish' Richard Hansen
2013-06-19 17:09 ` Junio C Hamano
2013-06-19 19:12 ` Richard Hansen
2013-06-19 21:46 ` Junio C Hamano
2013-06-19 20:35 ` Richard Hansen
2013-06-19 2:09 ` [PATCH 2/4] glossary: define committish (a.k.a. commit-ish) Richard Hansen
2013-06-19 4:19 ` Ramkumar Ramachandra
2013-06-19 4:38 ` Richard Hansen
2013-06-19 5:56 ` Ramkumar Ramachandra
2013-06-19 15:31 ` Richard Hansen
2013-06-19 16:10 ` Richard Hansen
2013-06-19 6:19 ` Jonathan Nieder
2013-06-19 17:14 ` Junio C Hamano
2013-06-19 19:16 ` Richard Hansen
2013-06-19 21:05 ` Junio C Hamano
2013-06-19 22:23 ` Richard Hansen
2013-06-19 22:36 ` Junio C Hamano
2013-06-19 23:37 ` Richard Hansen
2013-06-20 3:25 ` Junio C Hamano
2013-06-20 10:55 ` Ramkumar Ramachandra
2013-06-20 10:37 ` Ramkumar Ramachandra
2013-06-19 2:09 ` Richard Hansen [this message]
2013-06-19 2:09 ` [PATCH 4/4] revisions.txt: fix and clarify <rev>^{<type>} 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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1371607780-2966-4-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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).