From: Jonathan Nieder <jrnieder@gmail.com>
To: Richard Hansen <rhansen@bbn.com>
Cc: git@vger.kernel.org, gitster@pobox.com
Subject: Re: [PATCH 2/4] glossary: define committish (a.k.a. commit-ish)
Date: Tue, 18 Jun 2013 23:19:39 -0700 [thread overview]
Message-ID: <20130619061938.GA2968@elie.Belkin> (raw)
In-Reply-To: <1371607780-2966-3-git-send-email-rhansen@bbn.com>
Hi,
Richard Hansen wrote:
> --- a/Documentation/glossary-content.txt
> +++ b/Documentation/glossary-content.txt
> @@ -82,6 +82,17 @@ to point at the new commit.
> to the top <<def_directory,directory>> of the stored
> revision.
>
> +[[def_committish]]committish (also commit-ish)::
> + A <<def_ref,ref>> pointing to an <<def_object,object>> that
> + can be recursively dereferenced to a
> + <<def_commit_object,commit object>>.
Usually I would expect that the string "4d1c565" is not a ref, but the
glossary contains a different definition ("A 40-byte hex
representation of a SHA-1 or ..."). I guess we need a shorter name
for "extended SHA-1 syntax" (as described in gitrevisions(7)) that is
a little less confusing.
Perhaps we can sidestep the issue by saying
A parameter pointing to an <<def_object,object>> that
can be recursively dereferenced to ...
since the most common use of "commitish" is in describing a command's
syntax. I'm tempted to go even further and just call that a "commit
parameter", explaining the more pedantic synonym here --- something
like
[[def_commitish]]commitish (also commit-ish)::
A commandline parameter to a command that requires a
<<def_commit,commit>>.
+
The following are all commitishes: an expression (see
linkgit:gitrevisions[7]) directly representing a commit object,
an expression naming a tag that points to a commit object, a
tag that points to a tag that points to a commit, etc.
Thanks,
Jonathan
next prev parent reply other threads:[~2013-06-19 6:19 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 [this message]
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 ` [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=20130619061938.GA2968@elie.Belkin \
--to=jrnieder@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=rhansen@bbn.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).