J. Bruce Fields wrote:
On Sun, Sep 09, 2007 at 11:01:57PM +0200, Andreas Ericsson wrote:
J. Bruce Fields wrote:
+
+A git project normally consists of a working directory with a ".git"
+subdirectory at the top level. The .git directory contains, among other
+things, a compressed object database representing the complete history
+of the project, a set of pointers into that history ("refs")
... into that history ("refs" - branches and tags)
That would provide some context which the reader would otherwise have to
wait five paragraphs for. But it doesn't sound quite right to me; for
one thing, branch heads and tags are a subset of refs, whereas the above
suggests the two are equivalent.
We could try something like
"a set of named pointers into that history (called "refs", which
include tags and branches)"
But I'm aiming for maximum compression here, and that seems a little
ungainly for a single element of such a list. Hm, maybe it's
unnecessary to introduce the term "refs" at this point:
"a set of named pointers into that history (including tags and
branch heads)"
Maybe "pointers" isn't quite the right word. A little less jargon-y:
"a set of names for points in that history (including tags and
branch heads)"
"a set of referencing pointers in that history (including tags and branch
heads)".
That would sort of hint at refs, but leave the full explanation to later.
But what else are "refs" but branch heads and tags, except the few protected
words in $GIT_DIR such as MERGE_HEAD, ORIG_HEAD, FETCH_HEAD, and HEAD?
A revision is a rev (or 'commit-ish'), so a ref is a rev but not the other
way around. There is no pointer named HEAD^, but it's still a valid rev.
Apart from that, seems like a stellar patch-series. I cannot enough express my
gratitude for using a project where there's a competent and active doc-writer.
Now I just need to figure out how to find and employ someone like you ;-)
--
Andreas Ericsson andreas.ericsson@xxxxxx
OP5 AB www.op5.se
Tel: +46 8-230225 Fax: +46 8-230231
-
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
