development/git
development/git
1
0
Fork 0
mirror of https://github.com/git/git synced 2024-09-12 21:04:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation: Define symref and update HEAD description

Browse source 
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>
This commit is contained in:
Petr Baudis 2006-11-18 20:44:08 +01:00 committed by Junio C Hamano
parent fd931411c0
commit e3d457fb59
2 changed files with 16 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
Documentation/glossary.txt
View file

@ -282,6 +282,13 @@ SCM::
SHA1:: SHA1::
Synonym for object name. Synonym for object name.
symref::
Symbolic reference: instead of containing the SHA1 id itself, it
is of the format 'ref: refs/some/thing' and when referenced, it
recursively dereferences to this reference. 'HEAD' is a prime
example of a symref. Symbolic references are manipulated with
the gitlink:git-symbolic-ref[1] command.
topic branch:: topic branch::
A regular git branch that is used by a developer to A regular git branch that is used by a developer to
identify a conceptual line of development. Since branches identify a conceptual line of development. Since branches

14
Documentation/repository-layout.txt
View file

@ -70,12 +70,16 @@ refs/tags/`name`::
object, or a tag object that points at a commit object). object, or a tag object that points at a commit object).
HEAD:: HEAD::
A symlink of the form `refs/heads/'name'` to point at A symref (see glossary) to the `refs/heads/` namespace
the current branch, if exists. It does not mean much if describing the currently active branch. It does not mean
the repository is not associated with any working tree much if the repository is not associated with any working tree
(i.e. a 'bare' repository), but a valid git repository (i.e. a 'bare' repository), but a valid git repository
*must* have such a symlink here. It is legal if the *must* have the HEAD file; some porcelains may use it to
named branch 'name' does not (yet) exist. 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:: branches::
A slightly deprecated way to store shorthands to be used A slightly deprecated way to store shorthands to be used