mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

glossary: improve description of SHA-1 related topics

Browse Source 
The name of the hash function is "SHA-1", not "SHA1".

Also to people who look up "object name" in the glossary,
the details of which hash function is applied on what to
compute "object name" is not important but the fact that the
name is meant to be an unique identifier for the contents
stored in the object is.

Signed-off-by: Thomas Ackermann <th.acker@arcor.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Thomas Ackermann 2013-04-15 19:47:50 +02:00 committed by Junio C Hamano
parent 79de45588c
commit 3ab501209b
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
Documentation/glossary-content.txt
View File

@ -153,7 +153,7 @@ to point at the new commit.
created. Configured via the `.git/info/grafts` file. created. Configured via the `.git/info/grafts` file.
[[def_hash]]hash:: [[def_hash]]hash::
In Git's context, synonym to <<def_object_name,object name>>. In Git's context, synonym for <<def_object_name,object name>>.
[[def_head]]head:: [[def_head]]head::
A <<def_ref,named reference>> to the <<def_commit,commit>> at the tip of a A <<def_ref,named reference>> to the <<def_commit,commit>> at the tip of a
@ -225,7 +225,7 @@ This commit is referred to as a "merge commit", or sometimes just a
[[def_object]]object:: [[def_object]]object::
The unit of storage in Git. It is uniquely identified by the The unit of storage in Git. It is uniquely identified by the
<<def_SHA1,SHA1>> of its contents. Consequently, an <<def_SHA1,SHA-1>> of its contents. Consequently, an
object can not be changed. object can not be changed.
[[def_object_database]]object database:: [[def_object_database]]object database::
@ -237,10 +237,9 @@ This commit is referred to as a "merge commit", or sometimes just a
Synonym for <<def_object_name,object name>>. Synonym for <<def_object_name,object name>>.
[[def_object_name]]object name:: [[def_object_name]]object name::
The unique identifier of an <<def_object,object>>. The <<def_hash,hash>> The unique identifier of an <<def_object,object>>. The
of the object's contents using the Secure Hash Algorithm object name is usually represented by a 40 character
1 and usually represented by the 40 character hexadecimal encoding of hexadecimal string. Also colloquially called <<def_SHA1,SHA-1>>.
the <<def_hash,hash>> of the object.
[[def_object_type]]object type:: [[def_object_type]]object type::
One of the identifiers "<<def_commit_object,commit>>", One of the identifiers "<<def_commit_object,commit>>",
@ -376,7 +375,7 @@ should not be combined with other pathspec.
to the result. to the result.
[[def_ref]]ref:: [[def_ref]]ref::
A 40-byte hex representation of a <<def_SHA1,SHA1>> or a name that A 40-byte hex representation of a <<def_SHA1,SHA-1>> or a name that
denotes a particular <<def_object,object>>. They may be stored in denotes a particular <<def_object,object>>. They may be stored in
a file under `$GIT_DIR/refs/` directory, or a file under `$GIT_DIR/refs/` directory, or
in the `$GIT_DIR/packed-refs` file. in the `$GIT_DIR/packed-refs` file.
@ -432,8 +431,9 @@ should not be combined with other pathspec.
[[def_SCM]]SCM:: [[def_SCM]]SCM::
Source code management (tool). Source code management (tool).
[[def_SHA1]]SHA1:: [[def_SHA1]]SHA-1::
Synonym for <<def_object_name,object name>>. "Secure Hash Algorithm 1"; a cryptographic hash function.
In the context of Git used as a synonym for <<def_object_name,object name>>.
[[def_shallow_repository]]shallow repository:: [[def_shallow_repository]]shallow repository::
A shallow <<def_repository,repository>> has an incomplete A shallow <<def_repository,repository>> has an incomplete
@ -447,7 +447,7 @@ should not be combined with other pathspec.
its history can be later deepened with linkgit:git-fetch[1]. its history can be later deepened with linkgit:git-fetch[1].
[[def_symref]]symref:: [[def_symref]]symref::
Symbolic reference: instead of containing the <<def_SHA1,SHA1>> Symbolic reference: instead of containing the <<def_SHA1,SHA-1>>
id itself, it is of the format 'ref: refs/some/thing' and when id itself, it is of the format 'ref: refs/some/thing' and when
referenced, it recursively dereferences to this reference. referenced, it recursively dereferences to this reference.
'<<def_HEAD,HEAD>>' is a prime example of a symref. Symbolic '<<def_HEAD,HEAD>>' is a prime example of a symref. Symbolic