Hi,
long, long time. Here´s my first stab at the glossary, attached the
alphabetically sorted, asciidoc marked up txt file (Comments?
Suggestions? Pizzas?):
object::
The unit of storage in GIT. It is uniquely identified by
the SHA1 of its contents. Consequently, an object can not
be changed.
SHA1::
A 20-byte sequence (or 41-byte file containing the hex
representation and a newline). It is calculated from the
contents of an object by the Secure Hash Algorithm 1.
object database::
Stores a set of "objects", and an individial object is identified
by its SHA1 (its ref). The objects are either stored as single
files, or live inside of packs.
object name::
Synonym for SHA1.
blob object::
Untyped object, i.e. the contents of a file.
tree object::
An object containing a list of blob and/or tree objects.
(A tree usually corresponds to a directory without
subdirectories).
tree::
Either a working tree, or a tree object together with the
dependent blob and tree objects (i.e. a stored representation
of a working tree).
cache::
A collection of files whose contents are stored as objects.
The cache is a stored version of your working tree. Well, can
also contain a second, and even a third version of a working
tree, which are used when merging.
cache entry::
The information regarding a particular file, stored in the index.
A cache entry can be unmerged, if a merge was started, but not
yet finished (i.e. if the cache contains multiple versions of
that file).
index::
Contains information about the cache contents, in particular
timestamps and mode flags ("stat information") for the files
stored in the cache. An unmerged index is an index which contains
unmerged cache entries.
working tree::
The set of files and directories currently being worked on.
Think "ls -laR"
directory::
The list you get with "ls" :-)
checkout::
The action of updating the working tree to a revision which was
stored in the object database.
revision::
A particular state of files and directories which was stored in
the object database. It is referenced by a commit object.
commit::
The action of storing the current state of the cache in the
object database. The result is a revision.
commit object::
An object which contains the information about a particular
revision, such as parents, committer, author, date and the
tree object which corresponds to the top directory of the
stored revision.
changeset::
BitKeeper/cvsps speak for "commit". Since git does not store
changes, but states, it really does not make sense to use
the term "changesets" with git.
ent::
Favorite synonym to "tree-ish" by some total geeks.
clean::
A working tree is clean, if it corresponds to the revision
referenced by the current head.
dirty::
A working tree is said to be dirty if it contains modifications
which have not been committed to the current branch.
head::
The top of a branch. It contains a ref to the corresponding
commit object.
branch::
A non-cyclical graph of revisions, i.e. the complete history of
a particular revision, which does not (yet) have children, which
is called the branch head. The branch heads are stored in
$GIT_DIR/refs/heads/.
ref::
A 40-byte hex representation of a SHA1 pointing to a particular
object. These are stored in $GIT_DIR/refs/.
head ref::
A ref pointing to a head. Often, this is abbreviated to "head".
Head refs are stored in $GIT_DIR/refs/heads/.
tree-ish::
A ref pointing to either a commit object, a tree object, or a
tag object pointing to a commit or tree object.
tag object::
An object containing a ref pointing to another object. It can
contain a (PGP) signature, in which case it is called "signed
tag object".
tag::
A ref pointing to a tag or commit object. In contrast to a head,
a tag is not changed by a commit. Tags (not tag objects) are
stored in $GIT_DIR/refs/tags/. A git tag has nothing to do with
a Lisp tag (which is called object type in git's context).
merge::
To merge branches means to try to accumulate the changes since a
common ancestor and apply them to the first branch. An automatic
merge uses heuristics to accomplish that. Evidently, an automatic
merge can fail.
resolve::
The action of fixing up manually what a failed automatic merge
left behind.
repository::
A collection of refs together with an object database containing
all objects, which are reachable from the refs. A repository can
share an object database with other repositories.
alternate object database::
Via the alternates mechanism, a repository can inherit part of its
object database from another object database, which is called
"alternate".
reachable::
An object is reachable from a ref/commit/tree/tag, if there is a
chain leading from the latter to the former.
chain::
A list of objects, where each object in the list contains a
reference to its successor (for example, the successor of a commit
could be one of its parents).
parent::
A commit object contains a (possibly empty) list of the logical
predecessor(s) in the line of development, i.e. its parents.
fetch::
Fetching a branch means to get the branch's head ref from a
remote repository, to find out which objects are missing from
the local object database, and to get them, too.
pull::
Pulling a branch means to fetch it and merge it.
push::
Pushing a branch means to get the branch's head ref from a remote
repository, find out if it is an ancestor to the branch's local
head ref is a direct, and in that case, putting all objects, which
are reachable from the local head ref, and which are missing from
the remote repository, into the remote object database, and updating
the remote head ref. If the remote head is not an ancestor to the
local head, the push fails.
pack::
A set of objects which have been compressed into one file (to save
space or to transmit them efficiently).
pack index::
Contains offsets into a pack, so the pack can be used instead of
the unpacked objects.
plumbing::
Cute name for core git.
porcelain::
Cute name for programs and program suites depending on core git,
presenting a high level access to core git. Porcelains expose
more of a SCM interface than the plumbing.
object type:
One of the identifiers "commit","tree","tag" and "blob" describing
the type of an object.
SCM::
Source code management (tool).
dircache::
You are *waaaaay* behind.
GIT Glossary
============
Aug 2005
[[ref_SCM]]SCM::
Source code management (tool).
[[ref_SHA1]]SHA1::
A 20-byte sequence (or 41-byte file containing the hex representation
and a newline). It is calculated from the contents of an
<<ref_object,object>> by the Secure Hash Algorithm 1.
[[ref_alternate_object_database]]alternate object database::
Via the alternates mechanism, a <<ref_repository,repository>> can
inherit part of its <<ref_object_database,object database>> from another
<<ref_object_database,object database>>, which is called "alternate".
[[ref_blob_object]]blob object::
Untyped <<ref_object,object>>, i.e. the contents of a file.
[[ref_branch]]branch::
A non-cyclical graph of revisions, i.e. the complete history of a
particular <<ref_revision,revision>>, which does not (yet) have
children, which is called the <<ref_branch,branch>> <<ref_head,head>>.
The <<ref_branch,branch>> heads are stored in $GIT_DIR/refs/heads/.
[[ref_cache]]cache::
A collection of files whose contents are stored as objects. The
<<ref_cache,cache>> is a stored version of your
<<ref_working_tree,working tree>>. Well, can also contain a second, and
even a third version of a working <<ref_tree,tree>>, which are used when
merging.
[[ref_cache_entry]]cache entry::
The information regarding a particular file, stored in the
<<ref_index,index>>. A <<ref_cache_entry,cache entry>> can be unmerged,
if a <<ref_merge,merge>> was started, but not yet finished (i.e. if the
<<ref_cache,cache>> contains multiple versions of that file).
[[ref_chain]]chain::
A list of objects, where each <<ref_object,object>> in the list contains
a reference to its successor (for example, the successor of a
<<ref_commit,commit>> could be one of its parents).
[[ref_changeset]]changeset::
BitKeeper/cvsps speak for "<<ref_commit,commit>>". Since git does not
store changes, but states, it really does not make sense to use the term
"changesets" with git.
[[ref_checkout]]checkout::
The action of updating the <<ref_working_tree,working tree>> to a
<<ref_revision,revision>> which was stored in the
<<ref_object_database,object database>>.
[[ref_clean]]clean::
A <<ref_working_tree,working tree>> is <<ref_clean,clean>>, if it
corresponds to the <<ref_revision,revision>> referenced by the current
<<ref_head,head>>.
[[ref_commit]]commit::
The action of storing the current state of the <<ref_cache,cache>> in
the <<ref_object_database,object database>>. The result is a
<<ref_revision,revision>>.
[[ref_commit_object]]commit object::
An <<ref_object,object>> which contains the information about a
particular <<ref_revision,revision>>, such as parents, committer,
author, date and the <<ref_tree_object,tree object>> which corresponds
to the top <<ref_directory,directory>> of the stored
<<ref_revision,revision>>.
[[ref_dircache]]dircache::
You are *waaaaay* behind.
[[ref_directory]]directory::
The list you get with "ls" :-)
[[ref_dirty]]dirty::
A <<ref_working_tree,working tree>> is said to be <<ref_dirty,dirty>> if
it contains modifications which have not been committed to the current
<<ref_branch,branch>>.
[[ref_ent]]ent::
Favorite synonym to "<<ref_tree-ish,tree-ish>>" by some total geeks.
[[ref_fetch]]fetch::
Fetching a <<ref_branch,branch>> means to get the
<<ref_branch,branch>>'s <<ref_head_ref,head ref>> from a remote
<<ref_repository,repository>>, to find out which objects are missing
from the local <<ref_object_database,object database>>, and to get them,
too.
[[ref_head]]head::
The top of a <<ref_branch,branch>>. It contains a <<ref_ref,ref>> to the
corresponding <<ref_commit_object,commit object>>.
[[ref_head_ref]]head ref::
A <<ref_ref,ref>> pointing to a <<ref_head,head>>. Often, this is
abbreviated to "<<ref_head,head>>". Head refs are stored in
$GIT_DIR/refs/heads/.
[[ref_index]]index::
Contains information about the <<ref_cache,cache>> contents, in
particular timestamps and mode flags ("stat information") for the files
stored in the <<ref_cache,cache>>. An unmerged <<ref_index,index>> is an
<<ref_index,index>> which contains unmerged <<ref_cache,cache>> entries.
[[ref_merge]]merge::
To <<ref_merge,merge>> branches means to try to accumulate the changes
since a common ancestor and apply them to the first
<<ref_branch,branch>>. An automatic <<ref_merge,merge>> uses heuristics
to accomplish that. Evidently, an automatic <<ref_merge,merge>> can
fail.
[[ref_object]]object::
The unit of storage in GIT. It is uniquely identified by the
<<ref_SHA1,SHA1>> of its contents. Consequently, an
<<ref_object,object>> can not be changed.
[[ref_object_database]]object database::
Stores a set of "objects", and an individial <<ref_object,object>> is
identified by its <<ref_SHA1,SHA1>> (its <<ref_ref,ref>>). The objects
are either stored as single files, or live inside of packs.
[[ref_object_name]]object name::
Synonym for <<ref_SHA1,SHA1>>.
[[ref_pack]]pack::
A set of objects which have been compressed into one file (to save space
or to transmit them efficiently).
[[ref_pack_index]]pack index::
Contains offsets into a <<ref_pack,pack>>, so the <<ref_pack,pack>> can
be used instead of the unpacked objects.
[[ref_parent]]parent::
A <<ref_commit_object,commit object>> contains a (possibly empty) list
of the logical predecessor(s) in the line of development, i.e. its
parents.
[[ref_plumbing]]plumbing::
Cute name for core git.
[[ref_porcelain]]porcelain::
Cute name for programs and program suites depending on core git,
presenting a high level access to core git. Porcelains expose more of a
<<ref_SCM,SCM>> interface than the <<ref_plumbing,plumbing>>.
[[ref_pull]]pull::
Pulling a <<ref_branch,branch>> means to <<ref_fetch,fetch>> it and
<<ref_merge,merge>> it.
[[ref_push]]push::
Pushing a <<ref_branch,branch>> means to get the <<ref_branch,branch>>'s
<<ref_head_ref,head ref>> from a remote <<ref_repository,repository>>,
find out if it is an ancestor to the <<ref_branch,branch>>'s local
<<ref_head_ref,head ref>> is a direct, and in that case, putting all
objects, which are <<ref_reachable,reachable>> from the local
<<ref_head_ref,head ref>>, and which are missing from the remote
<<ref_repository,repository>>, into the remote
<<ref_object_database,object database>>, and updating the remote
<<ref_head_ref,head ref>>. If the remote <<ref_head,head>> is not an
ancestor to the local <<ref_head,head>>, the <<ref_push,push>> fails.
[[ref_reachable]]reachable::
An <<ref_object,object>> is <<ref_reachable,reachable>> from a
<<ref_ref,ref>>/<<ref_commit,commit>>/<<ref_tree,tree>>/<<ref_tag,tag>>,
if there is a <<ref_chain,chain>> leading from the latter to the former.
[[ref_ref]]ref::
A 40-byte hex representation of a <<ref_SHA1,SHA1>> pointing to a
particular <<ref_object,object>>. These are stored in $GIT_DIR/refs/.
[[ref_repository]]repository::
A collection of refs together with an <<ref_object_database,object
database>> containing all objects, which are <<ref_reachable,reachable>>
from the refs. A <<ref_repository,repository>> can share an
<<ref_object_database,object database>> with other repositories.
[[ref_resolve]]resolve::
The action of fixing up manually what a failed automatic
<<ref_merge,merge>> left behind.
[[ref_revision]]revision::
A particular state of files and directories which was stored in the
<<ref_object_database,object database>>. It is referenced by a
<<ref_commit_object,commit object>>.
[[ref_tag]]tag::
A <<ref_ref,ref>> pointing to a <<ref_tag,tag>> or
<<ref_commit_object,commit object>>. In contrast to a <<ref_head,head>>,
a <<ref_tag,tag>> is not changed by a <<ref_commit,commit>>. Tags (not
<<ref_tag,tag>> objects) are stored in $GIT_DIR/refs/tags/. A git
<<ref_tag,tag>> has nothing to do with a Lisp <<ref_tag,tag>> (which is
called <<ref_object,object>> type in git's context).
[[ref_tag_object]]tag object::
An <<ref_object,object>> containing a <<ref_ref,ref>> pointing to
another <<ref_object,object>>. It can contain a (PGP) signature, in
which case it is called "signed <<ref_tag_object,tag object>>".
[[ref_tree]]tree::
Either a <<ref_working_tree,working tree>>, or a <<ref_tree_object,tree
object>> together with the dependent blob and <<ref_tree,tree>> objects
(i.e. a stored representation of a <<ref_working_tree,working tree>>).
[[ref_tree_object]]tree object::
An <<ref_object,object>> containing a list of blob and/or
<<ref_tree,tree>> objects. (A <<ref_tree,tree>> usually corresponds to a
<<ref_directory,directory>> without subdirectories).
[[ref_tree-ish]]tree-ish::
A <<ref_ref,ref>> pointing to either a <<ref_commit_object,commit
object>>, a <<ref_tree_object,tree object>>, or a <<ref_tag_object,tag
object>> pointing to a <<ref_commit,commit>> or <<ref_tree_object,tree
object>>.
[[ref_working_tree]]working tree::
The set of files and directories currently being worked on. Think "ls
-laR"
