@matheusbsbs / matheus-bagliano / commits / e3d457fb59
Fork 0

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>

Petr Baudis committed Nov 18, 2006 at 20:44 UTC e3d457fb59f71dd40d24c82f48625a24492907d4
2 files changed +16 -5
Documentation/glossary.txt
+7
@@ -282,6 +282,13 @@ SCM::
282 SHA1::
283 Synonym for object name.
284
285 +symref::
286 + Symbolic reference: instead of containing the SHA1 id itself, it
287 + is of the format 'ref: refs/some/thing' and when referenced, it
288 + recursively dereferences to this reference. 'HEAD' is a prime
289 + example of a symref. Symbolic references are manipulated with
290 + the gitlink:git-symbolic-ref[1] command.
291 +
292 topic branch::
293 A regular git branch that is used by a developer to
294 identify a conceptual line of development. Since branches
Documentation/repository-layout.txt
+9 -5
@@ -70,12 +70,16 @@ refs/tags/`name`::
70 object, or a tag object that points at a commit object).
71
72 HEAD::
73 - A symlink of the form `refs/heads/'name'` to point at
74 - the current branch, if exists. It does not mean much if
75 - the repository is not associated with any working tree
73 + A symref (see glossary) to the `refs/heads/` namespace
74 + describing the currently active branch. It does not mean
75 + much if the repository is not associated with any working tree
76 (i.e. a 'bare' repository), but a valid git repository
77 - *must* have such a symlink here. It is legal if the
78 - named branch 'name' does not (yet) exist.
77 + *must* have the HEAD file; some porcelains may use it to
78 + guess the designated "default" branch of the repository
79 + (usually 'master'). It is legal if the named branch
80 + 'name' does not (yet) exist. In some legacy setups, it is
81 + a symbolic link instead of a symref that points at the current
82 + branch.
83
84 branches::
85 A slightly deprecated way to store shorthands to be used