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
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Reply via email to