Skip to content

Commit 3ab5012

Browse files
tacker66gitster
authored andcommitted
glossary: improve description of SHA-1 related topics
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 79de455 commit 3ab5012

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

Documentation/glossary-content.txt

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ to point at the new commit.
153153
created. Configured via the `.git/info/grafts` file.
154154

155155
[[def_hash]]hash::
156-
In Git's context, synonym to <<def_object_name,object name>>.
156+
In Git's context, synonym for <<def_object_name,object name>>.
157157

158158
[[def_head]]head::
159159
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
225225

226226
[[def_object]]object::
227227
The unit of storage in Git. It is uniquely identified by the
228-
<<def_SHA1,SHA1>> of its contents. Consequently, an
228+
<<def_SHA1,SHA-1>> of its contents. Consequently, an
229229
object can not be changed.
230230

231231
[[def_object_database]]object database::
@@ -237,10 +237,9 @@ This commit is referred to as a "merge commit", or sometimes just a
237237
Synonym for <<def_object_name,object name>>.
238238

239239
[[def_object_name]]object name::
240-
The unique identifier of an <<def_object,object>>. The <<def_hash,hash>>
241-
of the object's contents using the Secure Hash Algorithm
242-
1 and usually represented by the 40 character hexadecimal encoding of
243-
the <<def_hash,hash>> of the object.
240+
The unique identifier of an <<def_object,object>>. The
241+
object name is usually represented by a 40 character
242+
hexadecimal string. Also colloquially called <<def_SHA1,SHA-1>>.
244243

245244
[[def_object_type]]object type::
246245
One of the identifiers "<<def_commit_object,commit>>",
@@ -376,7 +375,7 @@ should not be combined with other pathspec.
376375
to the result.
377376

378377
[[def_ref]]ref::
379-
A 40-byte hex representation of a <<def_SHA1,SHA1>> or a name that
378+
A 40-byte hex representation of a <<def_SHA1,SHA-1>> or a name that
380379
denotes a particular <<def_object,object>>. They may be stored in
381380
a file under `$GIT_DIR/refs/` directory, or
382381
in the `$GIT_DIR/packed-refs` file.
@@ -432,8 +431,9 @@ should not be combined with other pathspec.
432431
[[def_SCM]]SCM::
433432
Source code management (tool).
434433

435-
[[def_SHA1]]SHA1::
436-
Synonym for <<def_object_name,object name>>.
434+
[[def_SHA1]]SHA-1::
435+
"Secure Hash Algorithm 1"; a cryptographic hash function.
436+
In the context of Git used as a synonym for <<def_object_name,object name>>.
437437

438438
[[def_shallow_repository]]shallow repository::
439439
A shallow <<def_repository,repository>> has an incomplete
@@ -447,7 +447,7 @@ should not be combined with other pathspec.
447447
its history can be later deepened with linkgit:git-fetch[1].
448448

449449
[[def_symref]]symref::
450-
Symbolic reference: instead of containing the <<def_SHA1,SHA1>>
450+
Symbolic reference: instead of containing the <<def_SHA1,SHA-1>>
451451
id itself, it is of the format 'ref: refs/some/thing' and when
452452
referenced, it recursively dereferences to this reference.
453453
'<<def_HEAD,HEAD>>' is a prime example of a symref. Symbolic

0 commit comments

Comments
 (0)