@matheusbsbs / matheus-bagliano / commits / 428ddc5de6
Fork 0

Documentation: describe shallow repository

Signed-off-by: Junio C Hamano <junkio@cox.net>

Junio C Hamano committed Jan 17, 2007 at 10:53 UTC 428ddc5de64684ad37d20c563544f17993a4d58d
2 files changed +20
Documentation/glossary.txt
+12
@@ -286,6 +286,18 @@ SCM::
286 SHA1::
287 Synonym for object name.
288
289 +shallow repository::
290 + A shallow repository has an incomplete history some of
291 + whose commits have parents cauterized away (in other
292 + words, git is told to pretend that these commits do not
293 + have the parents, even though they are recorded in the
294 + commit object). This is sometimes useful when you are
295 + interested only in the recent history of a project even
296 + though the real history recorded in the upstream is
297 + much larger. A shallow repository is created by giving
298 + `--depth` option to gitlink:git-clone[1], and its
299 + history can be later deepened with gitlink:git-fetch[1].
300 +
301 symref::
302 Symbolic reference: instead of containing the SHA1 id itself, it
303 is of the format 'ref: refs/some/thing' and when referenced, it
Documentation/repository-layout.txt
+8
@@ -18,6 +18,8 @@ could have only commit objects without associated blobs and
18 trees this way, for example. A repository with this kind of
19 incomplete object store is not suitable to be published to the
20 outside world but sometimes useful for private repository.
21 +. You also could have an incomplete but locally usable repository
22 +by cloning shallowly. See gitlink:git-clone[1].
23 . You can be using `objects/info/alternates` mechanism, or
24 `$GIT_ALTERNATE_OBJECT_DIRECTORIES` mechanism to 'borrow'
25 objects from other object stores. A repository with this kind
@@ -162,3 +164,9 @@ logs/refs/heads/`name`::
164
165 logs/refs/tags/`name`::
166 Records all changes made to the tag named `name`.
167 +
168 +shallow::
169 + This is similar to `info/grafts` but is internally used
170 + and maintained by shallow clone mechanism. See `--depth`
171 + option to gitlink:git-clone[1] and gitlink:git-fetch[1].
172 +