From: Richard Hansen <rhansen@bbn.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH 2/4] glossary: define committish (a.k.a. commit-ish)
Date: Wed, 19 Jun 2013 19:37:03 -0400 [thread overview]
Message-ID: <51C2409F.1070801@bbn.com> (raw)
In-Reply-To: <7vwqppwwwj.fsf@alter.siamese.dyndns.org>
On 2013-06-19 18:36, Junio C Hamano wrote:
> Ahh. If you had quoted [...] a few exchanges ago I would have
> immediately understood what you were trying to say.
Sorry about that, my bad.
> In today's world (after packed-refs was introduced), probably
>
> A name that begins with refs/ (e.g. refs/heads/master) that
> can point at an object name.
>
> The namespace of refs is hierarchical and different
> subhierarchy is used for different purposes (e.g. the
> refs/heads/ hierarchy is used to represent local branches).
>
> is an appropriate rewrite of the above.
Some thoughts about the above definition:
* Aren't HEAD, FETCH_HEAD, ORIG_HEAD also refs?
* That definition excludes symrefs.
* It may be worthwhile to mention that refs are part of the
repository.
* Is a ref a name? Or is it the binding of a name to an object/ref?
How about:
ref
A binding of a name to an object or other ref (in which case it
is a symref). Refs are stored in the repository.
The ref namespace is hierarchical. Different subhierarchies
are used for different purposes (e.g. the refs/heads/ hierarchy
is used to represent local branches).
>
> If we also want to explain the implementation details of refs, then
> additionally at the end of the first paragraph, add:
>
> ... at an object name, by storing its 40-byte hex
> representation. They are implemented as either a file in
> $GIT_DIR/refs/ directory (called "loose refs") or an entry
> in $GIT_DIR/packed-refs file (called "packed refs"); when a
> loose ref exists, a packed ref of the same name is ignored.
It would be good to document this somewhere, but I'm not sure the
glossary is the right place for it. Maybe gitrepository-layout(5)?
-Richard
next prev parent reply other threads:[~2013-06-19 23:37 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 [this message]
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=51C2409F.1070801@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).