Glossary: Difference between revisions

From Software Heritage Wiki
Jump to navigation Jump to search
(Expand the glossary a bit)
No edit summary
Line 3: Line 3:
== C ==
== C ==
; Content
; Content
: a file stored in the archive, identified by its cryptographic hashes (SHA1, "git-like" SHA1, SHA256) and its size
: a (specific version of a) file stored in the archive, identified by its cryptographic hashes (SHA1, [https://git-scm.com/book/en/v2/Git-Internals-Git-Objects "git-like" SHA1], SHA256) and its size


; Cryptographic hash
; Cryptographic hash
: (also called Checksum, Digest) a fixed-size "summary" of a stream of bytes, that is easy to compute, and hard to reverse. ([https://en.wikipedia.org/wiki/Cryptographic_hash_function Cryptographic hash function Wikipedia article])
: a fixed-size "summary" of a stream of bytes that is easy to compute, and hard to reverse. ([https://en.wikipedia.org/wiki/Cryptographic_hash_function Cryptographic hash function Wikipedia article])
: also known as: Checksum, Digest


== D ==
== D ==


; Directory
; Directory
: a set of named pointers to files, directories and revisions
: a set of named pointers to contents (file entries), directories (directory entries) and revisions (revision entries)


== H ==
== H ==
Line 21: Line 22:


; Origin
; Origin
: (also called Data sources) a location from which a coherent set of sources has been obtained.
: a location from which a coherent set of sources has been obtained.
: Some examples of origins :
: Also known as: Data source
: Examples:
:
:
:* a [https://github.com/torvalds/linux/ git repository]
:* a [https://github.com/torvalds/linux/ Git repository]
:* a [https://www.kernel.org/pub/linux/kernel/v4.x/ directory containing tarballs]
:* a [https://www.kernel.org/pub/linux/kernel/v4.x/ directory containing tarballs]
:* the history of a Debian package on [http://snapshot.debian.org/package/linux/ snapshot.debian.org].
:* the history of a Debian package on [http://snapshot.debian.org/package/linux/ snapshot.debian.org].
Line 31: Line 33:


; Project
; Project
:
: an organized effort to develop a software product. Projects might be nested following organizational structures (sub-project, sub-sub-project), are associated to a number of human-meaningful metadata, and release software products via Origins.


== R ==
== R ==
Line 37: Line 39:
; Release
; Release
: a revision that has been marked by a project as noteworthy with a specific, usually mnemonic, name (for instance, a version number).
: a revision that has been marked by a project as noteworthy with a specific, usually mnemonic, name (for instance, a version number).
: Some examples of releases :
: Also known as: Tag (Git-specific terminology)
: Examples:
:
:
:* a git tag with its name
:* a Git tag with its name
:* a tarball with its name
:* a tarball with its name
:* a Debian source package with its version number.
:* a Debian source package with its version number.
Line 45: Line 48:
; Revision
; Revision
: a "point in time" snapshot in the development history of a project.
: a "point in time" snapshot in the development history of a project.
: Some examples of revisions :
: Also known as: Commit (VCS terminology)
: Examples:
:
:
:* a git commit
:* a Git commit


== S ==
== S ==
Line 57: Line 61:


; VCS
; VCS
: a Version Control System, like git, subversion or mercurial
: acronym for Version Control System
: Examples: Git, Subversion, Mercurial

Revision as of 18:58, 25 June 2016

This glossary contains the definition of common terms used in the Software Heritage project.

C

Content
a (specific version of a) file stored in the archive, identified by its cryptographic hashes (SHA1, "git-like" SHA1, SHA256) and its size
Cryptographic hash
a fixed-size "summary" of a stream of bytes that is easy to compute, and hard to reverse. (Cryptographic hash function Wikipedia article)
also known as: Checksum, Digest

D

Directory
a set of named pointers to contents (file entries), directories (directory entries) and revisions (revision entries)

H

Hash
see Cryptographic hash

O

Origin
a location from which a coherent set of sources has been obtained.
Also known as: Data source
Examples:

P

Project
an organized effort to develop a software product. Projects might be nested following organizational structures (sub-project, sub-sub-project), are associated to a number of human-meaningful metadata, and release software products via Origins.

R

Release
a revision that has been marked by a project as noteworthy with a specific, usually mnemonic, name (for instance, a version number).
Also known as: Tag (Git-specific terminology)
Examples:
  • a Git tag with its name
  • a tarball with its name
  • a Debian source package with its version number.
Revision
a "point in time" snapshot in the development history of a project.
Also known as: Commit (VCS terminology)
Examples:
  • a Git commit

S

SHA
(Secure Hash Algorithm) a family of Cryptographic hashes published by the NIST (SHA Wikipedia article)

V

VCS
acronym for Version Control System
Examples: Git, Subversion, Mercurial