user-manual: start revising "internals" chapter
Minor revisions, cross-references. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
J. Bruce Fields committed
Apr 16, 2007 at 00:37 UTC
a536b08b491dbb7565fb6ce109dbcf1997f9ab7a
1 file changed
+20
-18
Documentation/user-manual.txt
+20
-18
@@ -2315,8 +2315,8 @@ options mentioned above.
2315
Git internals
2316
=============
2317
2318
-There are two object abstractions: the "object database", and the
2319
-"current directory cache" aka "index".
2318
+Git depends on two fundamental abstractions: the "object database", and
2319
+the "current directory cache" aka "index".
2320
2321
The Object Database
2322
-------------------
@@ -2331,22 +2331,23 @@ All objects have a statically determined "type" aka "tag", which is
2331
determined at object creation time, and which identifies the format of
2332
the object (i.e. how it is used, and how it can refer to other
2333
objects). There are currently four different object types: "blob",
2334
-"tree", "commit" and "tag".
2334
+"tree", "commit", and "tag".
2335
2336
-A "blob" object cannot refer to any other object, and is, like the type
2337
-implies, a pure storage object containing some user data. It is used to
2338
-actually store the file data, i.e. a blob object is associated with some
2339
-particular version of some file.
2336
+A <<def_blob_object,"blob" object>> cannot refer to any other object,
2337
+and is, as the name implies, a pure storage object containing some
2338
+user data. It is used to actually store the file data, i.e. a blob
2339
+object is associated with some particular version of some file.
2340
2341
-A "tree" object is an object that ties one or more "blob" objects into a
2342
-directory structure. In addition, a tree object can refer to other tree
2343
-objects, thus creating a directory hierarchy.
2341
+A <<def_tree_object,"tree" object>> is an object that ties one or more
2342
+"blob" objects into a directory structure. In addition, a tree object
2343
+can refer to other tree objects, thus creating a directory hierarchy.
2344
2345
-A "commit" object ties such directory hierarchies together into
2346
-a DAG of revisions - each "commit" is associated with exactly one tree
2347
-(the directory hierarchy at the time of the commit). In addition, a
2348
-"commit" refers to one or more "parent" commit objects that describe the
2349
-history of how we arrived at that directory hierarchy.
2345
+A <<def_commit_object,"commit" object>> ties such directory hierarchies
2346
+together into a <<def_DAG,directed acyclic graph>> of revisions - each
2347
+"commit" is associated with exactly one tree (the directory hierarchy at
2348
+the time of the commit). In addition, a "commit" refers to one or more
2349
+"parent" commit objects that describe the history of how we arrived at
2350
+that directory hierarchy.
2351
2352
As a special case, a commit object with no parents is called the "root"
2353
object, and is the point of an initial project commit. Each project
@@ -2356,9 +2357,10 @@ has two or more separate roots as its ultimate parents, that's probably
2357
just going to confuse people. So aim for the notion of "one root object
2358
per project", even if git itself does not enforce that.
2359
2359
-A "tag" object symbolically identifies and can be used to sign other
2360
-objects. It contains the identifier and type of another object, a
2361
-symbolic name (of course!) and, optionally, a signature.
2360
+A <<def_tag_object,"tag" object>> symbolically identifies and can be
2361
+used to sign other objects. It contains the identifier and type of
2362
+another object, a symbolic name (of course!) and, optionally, a
2363
+signature.
2364
2365
Regardless of object type, all objects share the following
2366
characteristics: they are all deflated with zlib, and have a header