git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Richard Hansen <rhansen@bbn.com>
To: git@vger.kernel.org, gitster@pobox.com
Cc: Richard Hansen <rhansen@bbn.com>
Subject: [PATCH 4/4] revisions.txt: fix and clarify <rev>^{<type>}
Date: Tue, 18 Jun 2013 22:09:40 -0400	[thread overview]
Message-ID: <1371607780-2966-5-git-send-email-rhansen@bbn.com> (raw)
In-Reply-To: <1371607780-2966-1-git-send-email-rhansen@bbn.com>

If possible, <rev> will be dereferenced even if it is not a tag type
(e.g., commit dereferenced to a tree).

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

diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt
index 09896a3..bf563cf 100644
--- a/Documentation/revisions.txt
+++ b/Documentation/revisions.txt
@@ -114,10 +114,14 @@ some output processing may assume ref names in UTF-8.
 
 '<rev>{caret}\{<type>\}', e.g. 'v0.99.8{caret}\{commit\}'::
   A suffix '{caret}' followed by an object type name enclosed in
-  brace pair means the object
-  could be a tag, and dereference the tag recursively until an
-  object of that type is found or the object cannot be
-  dereferenced anymore (in which case, barf).  '<rev>{caret}0'
+  brace pair means dereference the object at '<rev>' recursively until
+  an object of type '<type>' is found or the object cannot be
+  dereferenced anymore (in which case, barf).
+  For example, if '<rev>' is a committish, '<rev>{caret}\{commit\}'
+  specifies the corresponding commit object.
+  Similarly, if '<rev>' is a tree-ish, '<rev>{caret}\{tree\}'
+  specifies the corresponding tree object.
+  '<rev>{caret}0'
   is a short-hand for '<rev>{caret}\{commit\}'.
 +
 'rev{caret}\{object\}' can be used to make sure 'rev' names an
-- 
1.8.3.1

      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 ` [PATCH 3/4] glossary: more precise definition of tree-ish (a.k.a. treeish) Richard Hansen
2013-06-19  2:09 ` Richard Hansen [this message]

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-5-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).