aboutsummaryrefslogtreecommitdiff
path: root/Documentation/repository-layout.txt
diff options
context:
space:
mode:
authorPetr Baudis <pasky@suse.cz>2006-11-18 20:44:08 +0100
committerJunio C Hamano <junkio@cox.net>2006-11-18 14:04:51 -0800
commite3d457fb59f71dd40d24c82f48625a24492907d4 (patch)
treee7cd4daeb0d11655d52238fee848f538df2d98d7 /Documentation/repository-layout.txt
parentfd931411c0635ca5e7968bd2981457056b49062b (diff)
downloadgit-e3d457fb59f71dd40d24c82f48625a24492907d4.tar.gz
git-e3d457fb59f71dd40d24c82f48625a24492907d4.tar.xz
Documentation: Define symref and update HEAD description
HEAD was still described as a symlink instead of a symref. Signed-off-by: Petr Baudis <pasky@suse.cz> Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation/repository-layout.txt')
-rw-r--r--Documentation/repository-layout.txt14
1 files changed, 9 insertions, 5 deletions
diff --git a/Documentation/repository-layout.txt b/Documentation/repository-layout.txt
index 275d18bb5..6d8c58ed2 100644
--- a/Documentation/repository-layout.txt
+++ b/Documentation/repository-layout.txt
@@ -70,12 +70,16 @@ refs/tags/`name`::
object, or a tag object that points at a commit object).
HEAD::
- A symlink of the form `refs/heads/'name'` to point at
- the current branch, if exists. It does not mean much if
- the repository is not associated with any working tree
+ A symref (see glossary) to the `refs/heads/` namespace
+ describing the currently active branch. It does not mean
+ much if the repository is not associated with any working tree
(i.e. a 'bare' repository), but a valid git repository
- *must* have such a symlink here. It is legal if the
- named branch 'name' does not (yet) exist.
+ *must* have the HEAD file; some porcelains may use it to
+ guess the designated "default" branch of the repository
+ (usually 'master'). It is legal if the named branch
+ 'name' does not (yet) exist. In some legacy setups, it is
+ a symbolic link instead of a symref that points at the current
+ branch.
branches::
A slightly deprecated way to store shorthands to be used