Re: [PATCH 11/12] documentation: replace Discussion section by link to user-manual chapter

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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)"

I dunno.

--b.
-
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

[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux