kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity
Browse Source

Merge branch 'maint' 

* maint:
  Add a few more words to the glossary.
  Added definitions for a few words:
  Alphabetize the glossary.
maint
Junio C Hamano 19 years ago
parent
dcb3450fd8 7abd7117ec
commit
dd371b49f9
2 changed files with 242 additions and 169 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 409
      Documentation/glossary.txt
  2. 2
      Documentation/sort_glossary.pl

409
Documentation/glossary.txt
Unescape View File

@ -1,79 +1,57 @@
object:: alternate object database::
The unit of storage in git. It is uniquely identified by Via the alternates mechanism, a repository can inherit part of its
the SHA1 of its contents. Consequently, an object can not object database from another object database, which is called
be changed. "alternate".

object name::
The unique identifier of an object. The hash of the object's contents
using the Secure Hash Algorithm 1 and usually represented by the 40
character hexadecimal encoding of the hash of the object (possibly
followed by a white space).

SHA1::
Synonym for object name.

object identifier::
Synonym for object name.

hash::
In git's context, synonym to object name.


object database:: bare repository::
Stores a set of "objects", and an individual object is identified A bare repository is normally an appropriately named
by its object name. The objects usually live in `$GIT_DIR/objects/`. directory with a `.git` suffix that does not have a
locally checked-out copy of any of the files under revision
control. That is, all of the `git` administrative and
control files that would normally be present in the
hidden `.git` sub-directory are directly present in
the `repository.git` directory instead, and no other files
are present and checked out. Usually publishers of public
repositories make bare repositories available.


blob object:: blob object::
Untyped object, e.g. the contents of a file. Untyped object, e.g. the contents of a file.


tree object:: branch::
An object containing a list of file names and modes along with refs A non-cyclical graph of revisions, i.e. the complete history of
to the associated blob and/or tree objects. A tree is equivalent a particular revision, which is called the branch head. The
to a directory. branch heads are stored in `$GIT_DIR/refs/heads/`.

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).

DAG::
Directed acyclic graph. The commit objects form a directed acyclic
graph, because they have parents (directed), and the graph of commit
objects is acyclic (there is no chain which begins and ends with the
same object).

index::
A collection of files with stat information, whose contents are
stored as objects. The index is a stored version of your working
tree. Truth be told, it can also contain a second, and even a third
version of a working tree, which are used when merging.

index entry::
The information regarding a particular file, stored in the index.
An index entry can be unmerged, if a merge was started, but not
yet finished (i.e. if the index contains multiple versions of
that file).

unmerged index:
An index which contains unmerged index entries.


cache:: cache::
Obsolete for: index. Obsolete for: index.


working tree:: chain::
The set of files and directories currently being worked on, A list of objects, where each object in the list contains a
i.e. you can work in your working tree without using git at all. reference to its successor (for example, the successor of a commit

could be one of its parents).
directory::
The list you get with "ls" :-)


revision:: changeset::
A particular state of files and directories which was stored in BitKeeper/cvsps speak for "commit". Since git does not store
the object database. It is referenced by a commit object. changes, but states, it really does not make sense to use
the term "changesets" with git.


checkout:: checkout::
The action of updating the working tree to a revision which was The action of updating the working tree to a revision which was
stored in the object database. stored in the object database.


cherry-picking::
In SCM jargon, "cherry pick" means to choose a subset of
changes out of a series of changes (typically commits)
and record them as a new series of changes on top of
different codebase. In GIT, this is performed by
"git cherry-pick" command to extract the change
introduced by an existing commit and to record it based
on the tip of the current branch as a new commit.

clean::
A working tree is clean, if it corresponds to the revision
referenced by the current head. Also see "dirty".

commit:: commit::
As a verb: The action of storing the current state of the index in the As a verb: The action of storing the current state of the index in the
object database. The result is a revision. object database. The result is a revision.
@ -85,73 +63,90 @@ commit object::
tree object which corresponds to the top directory of the tree object which corresponds to the top directory of the
stored revision. stored revision.


parent:: core git::
A commit object contains a (possibly empty) list of the logical Fundamental data structures and utilities of git. Exposes only
predecessor(s) in the line of development, i.e. its parents. limited source code management tools.


changeset:: DAG::
BitKeeper/cvsps speak for "commit". Since git does not store Directed acyclic graph. The commit objects form a directed acyclic
changes, but states, it really does not make sense to use graph, because they have parents (directed), and the graph of commit
the term "changesets" with git. objects is acyclic (there is no chain which begins and ends with the
same object).


clean:: dircache::
A working tree is clean, if it corresponds to the revision You are *waaaaay* behind.
referenced by the current head.


dirty:: dirty::
A working tree is said to be dirty if it contains modifications A working tree is said to be dirty if it contains modifications
which have not been committed to the current branch. which have not been committed to the current branch.


head:: directory::
The top of a branch. It contains a ref to the corresponding The list you get with "ls" :-)
commit object.


branch:: ent::
A non-cyclical graph of revisions, i.e. the complete history of Favorite synonym to "tree-ish" by some total geeks. See
a particular revision, which is called the branch head. The `http://en.wikipedia.org/wiki/Ent_(Middle-earth)` for an in-depth
branch heads are stored in `$GIT_DIR/refs/heads/`. explanation.


master:: fast forward::
The default branch. Whenever you create a git repository, a branch A fast-forward is a special type of merge where you have
named "master" is created, and becomes the active branch. In most a revision and you are "merging" another branch's changes
cases, this contains the local development. that happen to be a descendant of what you have.
In such these cases, you do not make a new merge commit but
instead just update to his revision. This will happen
frequently on a tracking branch of a remote repository.


origin:: fetch::
The default upstream branch. Most projects have one upstream Fetching a branch means to get the branch's head ref from a
project which they track, and by default 'origin' is used for remote repository, to find out which objects are missing from
that purpose. New updates from upstream will be fetched into the local object database, and to get them, too.
this branch; you should never commit to it yourself.


ref:: file system::
A 40-byte hex representation of a SHA1 pointing to a particular Linus Torvalds originally designed git to be a user space file
object. These may be stored in `$GIT_DIR/refs/`. system, i.e. the infrastructure to hold files and directories.
That ensured the efficiency and speed of git.

git archive::
Synonym for repository (for arch people).

hash::
In git's context, synonym to object name.

head::
The top of a branch. It contains a ref to the corresponding
commit object.


head ref:: head ref::
A ref pointing to a head. Often, this is abbreviated to "head". A ref pointing to a head. Often, this is abbreviated to "head".
Head refs are stored in `$GIT_DIR/refs/heads/`. Head refs are stored in `$GIT_DIR/refs/heads/`.


tree-ish:: hook::
A ref pointing to either a commit object, a tree object, or a During the normal execution of several git commands,
tag object pointing to a tag or commit or tree object. call-outs are made to optional scripts that allow
a developer to add functionality or checking.
Typically, the hooks allow for a command to be pre-verified
and potentially aborted, and allow for a post-notification
after the operation is done.
The hook scripts are found in the `$GIT_DIR/hooks/` directory,
and are enabled by simply making them executable.


ent:: index::
Favorite synonym to "tree-ish" by some total geeks. See A collection of files with stat information, whose contents are
`http://en.wikipedia.org/wiki/Ent_(Middle-earth)` for an in-depth stored as objects. The index is a stored version of your working
explanation. tree. Truth be told, it can also contain a second, and even a third
version of a working tree, which are used when merging.


tag object:: index entry::
An object containing a ref pointing to another object, which can The information regarding a particular file, stored in the index.
contain a message just like a commit object. It can also An index entry can be unmerged, if a merge was started, but not
contain a (PGP) signature, in which case it is called a "signed yet finished (i.e. if the index contains multiple versions of
tag object". that file).


tag:: master::
A ref pointing to a tag or commit object. In contrast to a head, The default development branch. Whenever you create a git
a tag is not changed by a commit. Tags (not tag objects) are repository, a branch named "master" is created, and becomes
stored in `$GIT_DIR/refs/tags/`. A git tag has nothing to do with the active branch. In most cases, this contains the local
a Lisp tag (which is called object type in git's context). development, though that is purely conventional and not required.
A tag is most typically used to mark a particular point in the
commit ancestry chain.


merge:: merge::
To merge branches means to try to accumulate the changes since a To merge branches means to try to accumulate the changes since a
@ -159,55 +154,65 @@ merge::
merge uses heuristics to accomplish that. Evidently, an automatic merge uses heuristics to accomplish that. Evidently, an automatic
merge can fail. merge can fail.


octopus:: object::
To merge more than two branches. Also denotes an intelligent The unit of storage in git. It is uniquely identified by
predator. the SHA1 of its contents. Consequently, an object can not
be changed.


resolve:: object database::
The action of fixing up manually what a failed automatic merge Stores a set of "objects", and an individual object is identified
left behind. by its object name. The objects usually live in `$GIT_DIR/objects/`.


rewind:: object identifier::
To throw away part of the development, i.e. to assign the head to Synonym for object name.
an earlier revision.


rebase:: object name::
To clean a branch by starting from the head of the main line of The unique identifier of an object. The hash of the object's contents
development ("master"), and reapply the (possibly cherry-picked) using the Secure Hash Algorithm 1 and usually represented by the 40
changes from that branch. character hexadecimal encoding of the hash of the object (possibly
followed by a white space).


repository:: object type:
A collection of refs together with an object database containing One of the identifiers "commit","tree","tag" and "blob" describing
all objects, which are reachable from the refs, possibly accompanied the type of an object.
by meta data from one or more porcelains. A repository can
share an object database with other repositories.


git archive:: octopus::
Synonym for repository (for arch people). To merge more than two branches. Also denotes an intelligent
predator.


file system:: origin::
Linus Torvalds originally designed git to be a user space file The default upstream tracking branch. Most projects have at
system, i.e. the infrastructure to hold files and directories. least one upstream project which they track. By default
That ensured the efficiency and speed of git. 'origin' is used for that purpose. New upstream updates
will be fetched into this branch; you should never commit
to it yourself.


alternate object database:: pack::
Via the alternates mechanism, a repository can inherit part of its A set of objects which have been compressed into one file (to save
object database from another object database, which is called space or to transmit them efficiently).
"alternate".


reachable:: pack index::
An object is reachable from a ref/commit/tree/tag, if there is a The list of identifiers, and other information, of the objects in a
chain leading from the latter to the former. pack, to assist in efficiently accessing the contents of a pack.


chain:: parent::
A list of objects, where each object in the list contains a A commit object contains a (possibly empty) list of the logical
reference to its successor (for example, the successor of a commit predecessor(s) in the line of development, i.e. its parents.
could be one of its parents).


fetch:: pickaxe::
Fetching a branch means to get the branch's head ref from a The term pickaxe refers to an option to the diffcore routines
remote repository, to find out which objects are missing from that help select changes that add or delete a given text string.
the local object database, and to get them, too. With the --pickaxe-all option, it can be used to view the
full changeset that introduced or removed, say, a particular
line of text. See gitlink:git-diff[1].

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.


pull:: pull::
Pulling a branch means to fetch it and merge it. Pulling a branch means to fetch it and merge it.
@ -221,33 +226,101 @@ push::
the remote head ref. If the remote head is not an ancestor to the the remote head ref. If the remote head is not an ancestor to the
local head, the push fails. local head, the push fails.


pack:: reachable::
A set of objects which have been compressed into one file (to save An object is reachable from a ref/commit/tree/tag, if there is a
space or to transmit them efficiently). chain leading from the latter to the former.


pack index:: rebase::
The list of identifiers, and other information, of the objects in a To clean a branch by starting from the head of the main line of
pack, to assist in efficiently accessing the contents of a pack. development ("master"), and reapply the (possibly cherry-picked)
changes from that branch.


core git:: ref::
Fundamental data structures and utilities of git. Exposes only A 40-byte hex representation of a SHA1 or a name that denotes
limited source code management tools. a particular object. These may be stored in `$GIT_DIR/refs/`.

refspec::
A refspec is used by fetch and push to describe the mapping
between remote ref and local ref. They are combined with
a colon in the format <src>:<dst>, preceded by an optional
plus sign, +. For example:
`git fetch $URL refs/heads/master:refs/heads/origin`
means "grab the master branch head from the $URL and store
it as my origin branch head".
And `git push $URL refs/heads/master:refs/heads/to-upstream`
means "publish my master branch head as to-upstream master head
at $URL". See also gitlink:git-push[1]


plumbing:: repository::
Cute name for core git. A collection of refs together with an object database containing
all objects, which are reachable from the refs, possibly accompanied
by meta data from one or more porcelains. A repository can
share an object database with other repositories.


porcelain:: resolve::
Cute name for programs and program suites depending on core git, The action of fixing up manually what a failed automatic merge
presenting a high level access to core git. Porcelains expose left behind.
more of a SCM interface than the plumbing.


object type: revision::
One of the identifiers "commit","tree","tag" and "blob" describing A particular state of files and directories which was stored in
the type of an object. the object database. It is referenced by a commit object.

rewind::
To throw away part of the development, i.e. to assign the head to
an earlier revision.


SCM:: SCM::
Source code management (tool). Source code management (tool).


dircache:: SHA1::
You are *waaaaay* behind. Synonym for object name.

topic branch::
A regular git branch that is used by a developer to
identify a conceptual line of development. Since branches
are very easy and inexpensive, it is often desirable to
have several small branches that each contain very well
defined concepts or small incremental yet related changes.

tracking branch::
A regular git branch that is used to follow changes from
another repository. A tracking branch should not contain
direct modifications or have local commits made to it.
A tracking branch can usually be identified as the
right-hand-side ref in a Pull: refspec.

tree object::
An object containing a list of file names and modes along with refs
to the associated blob and/or tree objects. A tree is equivalent
to a directory.

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).

tree-ish::
A ref pointing to either a commit object, a tree object, or a
tag object pointing to a tag or commit or tree object.

tag object::
An object containing a ref pointing to another object, which can
contain a message just like a commit object. It can also
contain a (PGP) signature, in which case it is called a "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).
A tag is most typically used to mark a particular point in the
commit ancestry chain.

unmerged index:
An index which contains unmerged index entries.

working tree::
The set of files and directories currently being worked on,
i.e. you can work in your working tree without using git at all.



2
Documentation/sort_glossary.pl
Unescape View File

@ -48,7 +48,7 @@ This list is sorted alphabetically:
'; ';


@keys=sort {uc($a) cmp uc($b)} keys %terms; @keys=sort {uc($a) cmp uc($b)} keys %terms;
$pattern='(\b'.join('\b|\b',reverse @keys).'\b)'; $pattern='(\b(?<!link:git-)'.join('\b|\b(?<!link:git-)',reverse @keys).'\b)';
foreach $key (@keys) { foreach $key (@keys) {
$terms{$key}=~s/$pattern/sprintf "<<ref_".no_spaces($1).",$1>>";/eg; $terms{$key}=~s/$pattern/sprintf "<<ref_".no_spaces($1).",$1>>";/eg;
print '[[ref_'.no_spaces($key).']]'.$key."::\n" print '[[ref_'.no_spaces($key).']]'.$key."::\n"

Write Preview
Loading…
Cancel
Save