X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Frepository-layout.txt;h=4c92e375fed4592f7190086dd40ef6dd1241d238;hb=27c1dbea3e3a23b3c4b3707dfc9a71c3279ae279;hp=0fdd36614d8db6f52d1bdc6f8bf2e5a667edeff0;hpb=1fcdd62adf81a172f45c7c6a58177212d500b9d9;p=git.git

diff --git a/Documentation/repository-layout.txt b/Documentation/repository-layout.txt
index 0fdd36614..4c92e375f 100644
--- a/Documentation/repository-layout.txt
+++ b/Documentation/repository-layout.txt
@@ -18,6 +18,8 @@ could have only commit objects without associated blobs and
 trees this way, for example.  A repository with this kind of
 incomplete object store is not suitable to be published to the
 outside world but sometimes useful for private repository.
+. You also could have an incomplete but locally usable repository
+by cloning shallowly.  See gitlink:git-clone[1].
 . You can be using `objects/info/alternates` mechanism, or
 `$GIT_ALTERNATE_OBJECT_DIRECTORIES` mechanism to 'borrow'
 objects from other object stores.  A repository with this kind
@@ -32,7 +34,7 @@ objects/[0-9a-f][0-9a-f]::
 	two letters from its object name to keep the number of
 	directory entries `objects` directory itself needs to
 	hold.  Objects found here are often called 'unpacked'
-	objects.
+	(or 'loose') objects.
 
 objects/pack::
 	Packs (files that store many object in compressed form,
@@ -80,6 +82,15 @@ refs/tags/`name`::
 	records any object name (not necessarily a commit
 	object, or a tag object that points at a commit object).
 
+refs/remotes/`name`::
+	records tip-of-the-tree commit objects of branches copied
+	from a remote repository.
+
+packed-refs::
+	records the same information as refs/heads/, refs/tags/,
+	and friends record in a more efficient way.  See
+	gitlink:git-pack-refs[1].
+
 HEAD::
 	A symref (see glossary) to the `refs/heads/` namespace
 	describing the currently active branch.  It does not mean
@@ -91,6 +102,12 @@ HEAD::
 	'name' does not (yet) exist.  In some legacy setups, it is
 	a symbolic link instead of a symref that points at the current
 	branch.
++
+HEAD can also record a specific commit directly, instead of
+being a symref to point at the current branch.  Such a state
+is often called 'detached HEAD', and almost all commands work
+identically as normal.  See gitlink:git-checkout[1] for
+details.
 
 branches::
 	A slightly deprecated way to store shorthands to be used
@@ -116,14 +133,14 @@ info::
 	in this directory.
 
 info/refs::
-	This file is to help dumb transports to discover what
-	refs are available in this repository.  Whenever you
-	create/delete a new branch or a new tag, `git
-	update-server-info` should be run to keep this file
-	up-to-date if the repository is published for dumb
-	transports.  The `git-receive-pack` command, which is
-	run on a remote repository when you `git push` into it,
-	runs `hooks/update` hook to help you achieve this.
+	This file helps dumb transports discover what refs are
+	available in this repository.  If the repository is
+	published for dumb transports, this file should be
+	regenerated by `git update-server-info` every time a tag
+	or branch is created or modified.  This is normally done
+	from the `hooks/update` hook, which is run by the
+	`git-receive-pack` command when you `git push` into the
+	repository.
 
 info/grafts::
 	This file records fake commit ancestry information, to
@@ -138,8 +155,7 @@ info/exclude::
 	exclude pattern list. `.gitignore` is the per-directory
 	ignore file.  `git status`, `git add`, `git rm` and `git
 	clean` look at it but the core git commands do not look
-	at it.  See also: gitlink:git-ls-files[1] `--exclude-from`
-	and `--exclude-per-directory`.
+	at it.  See also: gitlink:gitignore[5].
 
 remotes::
 	Stores shorthands to be used to give URL and default
@@ -156,3 +172,8 @@ logs/refs/heads/`name`::
 
 logs/refs/tags/`name`::
 	Records all changes made to the tag named `name`.
+
+shallow::
+	This is similar to `info/grafts` but is internally used
+	and maintained by shallow clone mechanism.  See `--depth`
+	option to gitlink:git-clone[1] and gitlink:git-fetch[1].