</div>\r
<div id="preamble">\r
<div class="sectionbody">\r
-<p>This list is sorted alphabetically:</p>\r
<dl>\r
<dt>\r
-<a id="ref_alternate_object_database"></a>alternate object database\r
+<a id="def_alternate_object_database"></a>alternate object database\r
</dt>\r
<dd>\r
<p>\r
- Via the alternates mechanism, a <a href="#ref_repository">repository</a> can\r
- inherit part of its <a href="#ref_object_database">object database</a> from another\r
- <a href="#ref_object_database">object database</a>, which is called "alternate".\r
+ Via the alternates mechanism, a <a href="#def_repository">repository</a> can\r
+ inherit part of its <a href="#def_object_database">object database</a> from another\r
+ <a href="#def_object_database">object database</a>, which is called "alternate".\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_bare_repository"></a>bare repository\r
+<a id="def_bare_repository"></a>bare repository\r
</dt>\r
<dd>\r
<p>\r
- A <a href="#ref_bare_repository">bare repository</a> is normally an appropriately\r
- named <a href="#ref_directory">directory</a> with a <tt>.git</tt> suffix that does not\r
+ A <a href="#def_bare_repository">bare repository</a> is normally an appropriately\r
+ named <a href="#def_directory">directory</a> with a <tt>.git</tt> suffix that does not\r
have a locally checked-out copy of any of the files under\r
- <a href="#ref_revision">revision</a> control. That is, all of the <tt>git</tt>\r
+ <a href="#def_revision">revision</a> control. That is, all of the <tt>git</tt>\r
administrative and control files that would normally be present in the\r
hidden <tt>.git</tt> sub-directory are directly present in the\r
- <tt><a href="#ref_repository">repository</a>.git</tt> <a href="#ref_directory">directory</a> instead,\r
+ <tt>repository.git</tt> directory instead,\r
and no other files are present and checked out. Usually publishers of\r
public repositories make bare repositories available.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_blob_object"></a>blob object\r
+<a id="def_blob_object"></a>blob object\r
</dt>\r
<dd>\r
<p>\r
- Untyped <a href="#ref_object">object</a>, e.g. the contents of a file.\r
+ Untyped <a href="#def_object">object</a>, e.g. the contents of a file.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_branch"></a>branch\r
+<a id="def_branch"></a>branch\r
</dt>\r
<dd>\r
<p>\r
A non-cyclical graph of revisions, i.e. the complete history of a\r
- particular <a href="#ref_revision">revision</a>, which is called the\r
- <a href="#ref_branch">branch</a> <a href="#ref_head">head</a>. The <a href="#ref_branch">branch</a> heads\r
+ particular <a href="#def_revision">revision</a>, which is called the\r
+ branch <a href="#def_head">head</a>. The heads\r
are stored in <tt>$GIT_DIR/refs/heads/</tt>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_cache"></a>cache\r
+<a id="def_cache"></a>cache\r
</dt>\r
<dd>\r
<p>\r
- Obsolete for: <a href="#ref_index">index</a>.\r
+ Obsolete for: <a href="#def_index">index</a>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_chain"></a>chain\r
+<a id="def_chain"></a>chain\r
</dt>\r
<dd>\r
<p>\r
- A list of objects, where each <a href="#ref_object">object</a> in the list contains\r
+ A list of objects, where each <a href="#def_object">object</a> in the list contains\r
a reference to its successor (for example, the successor of a\r
- <a href="#ref_commit">commit</a> could be one of its parents).\r
+ <a href="#def_commit">commit</a> could be one of its parents).\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_changeset"></a>changeset\r
+<a id="def_changeset"></a>changeset\r
</dt>\r
<dd>\r
<p>\r
- BitKeeper/cvsps speak for "<a href="#ref_commit">commit</a>". Since git does not\r
+ BitKeeper/cvsps speak for "<a href="#def_commit">commit</a>". Since git does not\r
store changes, but states, it really does not make sense to use the term\r
"changesets" with git.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_checkout"></a>checkout\r
+<a id="def_checkout"></a>checkout\r
</dt>\r
<dd>\r
<p>\r
- The action of updating the <a href="#ref_working_tree">working tree</a> to a\r
- <a href="#ref_revision">revision</a> which was stored in the\r
- <a href="#ref_object_database">object database</a>.\r
+ The action of updating the <a href="#def_working_tree">working tree</a> to a\r
+ <a href="#def_revision">revision</a> which was stored in the\r
+ <a href="#def_object_database">object database</a>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_cherry-picking"></a>cherry-picking\r
+<a id="def_cherry-picking"></a>cherry-picking\r
</dt>\r
<dd>\r
<p>\r
- In <a href="#ref_SCM">SCM</a> jargon, "cherry pick" means to choose a subset of\r
+ In <a href="#def_SCM">SCM</a> jargon, "cherry pick" means to choose a subset of\r
changes out of a series of changes (typically commits) and record them\r
as a new series of changes on top of different codebase. In GIT, this is\r
performed by "git cherry-pick" command to extract the change introduced\r
- by an existing <a href="#ref_commit">commit</a> and to record it based on the tip\r
- of the current <a href="#ref_branch">branch</a> as a new <a href="#ref_commit">commit</a>.\r
+ by an existing <a href="#def_commit">commit</a> and to record it based on the tip\r
+ of the current <a href="#def_branch">branch</a> as a new <a href="#def_commit">commit</a>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_clean"></a>clean\r
+<a id="def_clean"></a>clean\r
</dt>\r
<dd>\r
<p>\r
- A <a href="#ref_working_tree">working tree</a> is <a href="#ref_clean">clean</a>, if it\r
- corresponds to the <a href="#ref_revision">revision</a> referenced by the current\r
- <a href="#ref_head">head</a>. Also see "<a href="#ref_dirty">dirty</a>".\r
+ A <a href="#def_working_tree">working tree</a> is <a href="#def_clean">clean</a>, if it\r
+ corresponds to the <a href="#def_revision">revision</a> referenced by the current\r
+ <a href="#def_head">head</a>. Also see "<a href="#def_dirty">dirty</a>".\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_commit"></a>commit\r
+<a id="def_commit"></a>commit\r
</dt>\r
<dd>\r
<p>\r
As a verb: The action of storing the current state of the\r
- <a href="#ref_index">index</a> in the <a href="#ref_object_database">object database</a>. The\r
- result is a <a href="#ref_revision">revision</a>. As a noun: Short hand for\r
- <a href="#ref_commit_object">commit object</a>.\r
+ <a href="#def_index">index</a> in the <a href="#def_object_database">object database</a>. The\r
+ result is a <a href="#def_revision">revision</a>. As a noun: Short hand for\r
+ <a href="#def_commit_object">commit object</a>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_commit_object"></a>commit object\r
+<a id="def_commit_object"></a>commit object\r
</dt>\r
<dd>\r
<p>\r
- An <a href="#ref_object">object</a> which contains the information about a\r
- particular <a href="#ref_revision">revision</a>, such as parents, committer,\r
- author, date and the <a href="#ref_tree_object">tree object</a> which corresponds\r
- to the top <a href="#ref_directory">directory</a> of the stored\r
- <a href="#ref_revision">revision</a>.\r
+ An <a href="#def_object">object</a> which contains the information about a\r
+ particular <a href="#def_revision">revision</a>, such as parents, committer,\r
+ author, date and the <a href="#def_tree_object">tree object</a> which corresponds\r
+ to the top <a href="#def_directory">directory</a> of the stored\r
+ <a href="#def_revision">revision</a>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_core_git"></a>core git\r
+<a id="def_core_git"></a>core git\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_DAG"></a>DAG\r
+<a id="def_DAG"></a>DAG\r
</dt>\r
<dd>\r
<p>\r
- Directed acyclic graph. The <a href="#ref_commit">commit</a> objects form a\r
+ Directed acyclic graph. The <a href="#def_commit">commit</a> objects form a\r
directed acyclic graph, because they have parents (directed), and the\r
- graph of <a href="#ref_commit">commit</a> objects is acyclic (there is no\r
- <a href="#ref_chain">chain</a> which begins and ends with the same\r
- <a href="#ref_object">object</a>).\r
+ graph of <a href="#def_commit">commit</a> objects is acyclic (there is no\r
+ <a href="#def_chain">chain</a> which begins and ends with the same\r
+ <a href="#def_object">object</a>).\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_dangling_object"></a>dangling object\r
+<a id="def_dangling_object"></a>dangling object\r
</dt>\r
<dd>\r
<p>\r
- An <a href="#ref_unreachable_object">unreachable object</a> which is not\r
- <a href="#ref_reachable">reachable</a> even from other unreachable objects; a\r
- <a href="#ref_dangling_object">dangling object</a> has no references to it from any\r
- reference or <a href="#ref_object">object</a> in the <a href="#ref_repository">repository</a>.\r
+ An <a href="#def_unreachable_object">unreachable object</a> which is not\r
+ <a href="#def_reachable">reachable</a> even from other unreachable objects; a\r
+ <a href="#def_dangling_object">dangling object</a> has no references to it from any\r
+ reference or <a href="#def_object">object</a> in the <a href="#def_repository">repository</a>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_dircache"></a>dircache\r
+<a id="def_dircache"></a>dircache\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_directory"></a>directory\r
+<a id="def_directory"></a>directory\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_dirty"></a>dirty\r
+<a id="def_dirty"></a>dirty\r
</dt>\r
<dd>\r
<p>\r
- A <a href="#ref_working_tree">working tree</a> is said to be <a href="#ref_dirty">dirty</a> if\r
+ A <a href="#def_working_tree">working tree</a> is said to be <a href="#def_dirty">dirty</a> if\r
it contains modifications which have not been committed to the current\r
- <a href="#ref_branch">branch</a>.\r
+ <a href="#def_branch">branch</a>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_ent"></a>ent\r
+<a id="def_ent"></a>ent\r
</dt>\r
<dd>\r
<p>\r
- Favorite synonym to "<a href="#ref_tree-ish">tree-ish</a>" by some total geeks. See\r
+ Favorite synonym to "<a href="#def_tree-ish">tree-ish</a>" by some total geeks. See\r
<tt>http://en.wikipedia.org/wiki/Ent_(Middle-earth)</tt> for an in-depth\r
explanation. Avoid this term, not to confuse people.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_fast_forward"></a>fast forward\r
+<a id="def_fast_forward"></a>fast forward\r
</dt>\r
<dd>\r
<p>\r
- A fast-forward is a special type of <a href="#ref_merge">merge</a> where you have a\r
- <a href="#ref_revision">revision</a> and you are "merging" another\r
- <a href="#ref_branch">branch</a>'s changes that happen to be a descendant of what\r
- you have. In such these cases, you do not make a new <a href="#ref_merge">merge</a>\r
- <a href="#ref_commit">commit</a> but instead just update to his\r
- <a href="#ref_revision">revision</a>. This will happen frequently on a\r
- <a href="#ref_tracking_branch">tracking branch</a> of a remote\r
- <a href="#ref_repository">repository</a>.\r
+ A fast-forward is a special type of <a href="#def_merge">merge</a> where you have a\r
+ <a href="#def_revision">revision</a> and you are "merging" another\r
+ <a href="#def_branch">branch</a>'s changes that happen to be a descendant of what\r
+ you have. In such these cases, you do not make a new <a href="#def_merge">merge</a>\r
+ <a href="#def_commit">commit</a> but instead just update to his\r
+ <a href="#def_revision">revision</a>. This will happen frequently on a\r
+ <a href="#def_tracking_branch">tracking branch</a> of a remote\r
+ <a href="#def_repository">repository</a>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_fetch"></a>fetch\r
+<a id="def_fetch"></a>fetch\r
</dt>\r
<dd>\r
<p>\r
- Fetching a <a href="#ref_branch">branch</a> means to get the\r
- <a href="#ref_branch">branch</a>'s <a href="#ref_head_ref">head ref</a> from a remote\r
- <a href="#ref_repository">repository</a>, to find out which objects are missing\r
- from the local <a href="#ref_object_database">object database</a>, and to get them,\r
+ Fetching a <a href="#def_branch">branch</a> means to get the\r
+ <a href="#def_branch">branch</a>'s <a href="#def_head_ref">head ref</a> from a remote\r
+ <a href="#def_repository">repository</a>, to find out which objects are missing\r
+ from the local <a href="#def_object_database">object database</a>, and to get them,\r
too.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_file_system"></a>file system\r
+<a id="def_file_system"></a>file system\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_git_archive"></a>git archive\r
+<a id="def_git_archive"></a>git archive\r
</dt>\r
<dd>\r
<p>\r
- Synonym for <a href="#ref_repository">repository</a> (for arch people).\r
+ Synonym for <a href="#def_repository">repository</a> (for arch people).\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_grafts"></a>grafts\r
+<a id="def_grafts"></a>grafts\r
</dt>\r
<dd>\r
<p>\r
Grafts enables two otherwise different lines of development to be joined\r
together by recording fake ancestry information for commits. This way\r
- you can make git pretend the set of parents a <a href="#ref_commit">commit</a> has\r
- is different from what was recorded when the <a href="#ref_commit">commit</a> was\r
- created. Configured via the <tt>.git/info/<a href="#ref_grafts">grafts</a></tt> file.\r
+ you can make git pretend the set of parents a <a href="#def_commit">commit</a> has\r
+ is different from what was recorded when the <a href="#def_commit">commit</a> was\r
+ created. Configured via the <tt>.git/info/grafts</tt> file.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_hash"></a>hash\r
+<a id="def_hash"></a>hash\r
</dt>\r
<dd>\r
<p>\r
- In git's context, synonym to <a href="#ref_object_name">object name</a>.\r
+ In git's context, synonym to <a href="#def_object_name">object name</a>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_head"></a>head\r
+<a id="def_head"></a>head\r
</dt>\r
<dd>\r
<p>\r
- The top of a <a href="#ref_branch">branch</a>. It contains a <a href="#ref_ref">ref</a> to the\r
- corresponding <a href="#ref_commit_object">commit object</a>.\r
+ The top of a <a href="#def_branch">branch</a>. It contains a <a href="#def_ref">ref</a> to the\r
+ corresponding <a href="#def_commit_object">commit object</a>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_head_ref"></a>head ref\r
+<a id="def_head_ref"></a>head ref\r
</dt>\r
<dd>\r
<p>\r
- A <a href="#ref_ref">ref</a> pointing to a <a href="#ref_head">head</a>. Often, this is\r
- abbreviated to "<a href="#ref_head">head</a>". Head refs are stored in\r
+ A <a href="#def_ref">ref</a> pointing to a <a href="#def_head">head</a>. Often, this is\r
+ abbreviated to "<a href="#def_head">head</a>". Head refs are stored in\r
<tt>$GIT_DIR/refs/heads/</tt>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_hook"></a>hook\r
+<a id="def_hook"></a>hook\r
</dt>\r
<dd>\r
<p>\r
to optional scripts that allow a developer to add functionality or\r
checking. Typically, the hooks allow for a command to be pre-verified\r
and potentially aborted, and allow for a post-notification after the\r
- operation is done. The <a href="#ref_hook">hook</a> scripts are found in the\r
- <tt>$GIT_DIR/hooks/</tt> <a href="#ref_directory">directory</a>, and are enabled by simply\r
+ operation is done. The <a href="#def_hook">hook</a> scripts are found in the\r
+ <tt>$GIT_DIR/hooks/</tt> <a href="#def_directory">directory</a>, and are enabled by simply\r
making them executable.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_index"></a>index\r
+<a id="def_index"></a>index\r
</dt>\r
<dd>\r
<p>\r
A collection of files with stat information, whose contents are stored\r
- as objects. The <a href="#ref_index">index</a> is a stored version of your working\r
- <a href="#ref_tree">tree</a>. Truth be told, it can also contain a second, and even\r
- a third version of a <a href="#ref_working_tree">working tree</a>, which are used\r
+ as objects. The <a href="#def_index">index</a> is a stored version of your working\r
+ <a href="#def_tree">tree</a>. Truth be told, it can also contain a second, and even\r
+ a third version of a <a href="#def_working_tree">working tree</a>, which are used\r
when merging.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_index_entry"></a>index entry\r
+<a id="def_index_entry"></a>index entry\r
</dt>\r
<dd>\r
<p>\r
The information regarding a particular file, stored in the\r
- <a href="#ref_index">index</a>. An <a href="#ref_index_entry">index entry</a> can be unmerged,\r
- if a <a href="#ref_merge">merge</a> was started, but not yet finished (i.e. if the\r
- <a href="#ref_index">index</a> contains multiple versions of that file).\r
+ <a href="#def_index">index</a>. An <a href="#def_index_entry">index entry</a> can be unmerged,\r
+ if a <a href="#def_merge">merge</a> was started, but not yet finished (i.e. if the\r
+ <a href="#def_index">index</a> contains multiple versions of that file).\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_master"></a>master\r
+<a id="def_master"></a>master\r
</dt>\r
<dd>\r
<p>\r
- The default development <a href="#ref_branch">branch</a>. Whenever you create a git\r
- <a href="#ref_repository">repository</a>, a <a href="#ref_branch">branch</a> named\r
- "<a href="#ref_master">master</a>" is created, and becomes the active\r
- <a href="#ref_branch">branch</a>. In most cases, this contains the local\r
+ The default development <a href="#def_branch">branch</a>. Whenever you create a git\r
+ <a href="#def_repository">repository</a>, a <a href="#def_branch">branch</a> named\r
+ "<a href="#def_master">master</a>" is created, and becomes the active\r
+ <a href="#def_branch">branch</a>. In most cases, this contains the local\r
development, though that is purely conventional and not required.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_merge"></a>merge\r
+<a id="def_merge"></a>merge\r
</dt>\r
<dd>\r
<p>\r
- To <a href="#ref_merge">merge</a> branches means to try to accumulate the changes\r
+ To <a href="#def_merge">merge</a> branches means to try to accumulate the changes\r
since a common ancestor and apply them to the first\r
- <a href="#ref_branch">branch</a>. An automatic <a href="#ref_merge">merge</a> uses heuristics\r
- to accomplish that. Evidently, an automatic <a href="#ref_merge">merge</a> can\r
+ <a href="#def_branch">branch</a>. An automatic <a href="#def_merge">merge</a> uses heuristics\r
+ to accomplish that. Evidently, an automatic <a href="#def_merge">merge</a> can\r
fail.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_object"></a>object\r
+<a id="def_object"></a>object\r
</dt>\r
<dd>\r
<p>\r
The unit of storage in git. It is uniquely identified by the\r
- <a href="#ref_SHA1">SHA1</a> of its contents. Consequently, an\r
- <a href="#ref_object">object</a> can not be changed.\r
+ <a href="#def_SHA1">SHA1</a> of its contents. Consequently, an\r
+ <a href="#def_object">object</a> can not be changed.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_object_database"></a>object database\r
+<a id="def_object_database"></a>object database\r
</dt>\r
<dd>\r
<p>\r
- Stores a set of "objects", and an individual <a href="#ref_object">object</a> is\r
- identified by its <a href="#ref_object_name">object name</a>. The objects usually\r
+ Stores a set of "objects", and an individual <a href="#def_object">object</a> is\r
+ identified by its <a href="#def_object_name">object name</a>. The objects usually\r
live in <tt>$GIT_DIR/objects/</tt>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_object_identifier"></a>object identifier\r
+<a id="def_object_identifier"></a>object identifier\r
</dt>\r
<dd>\r
<p>\r
- Synonym for <a href="#ref_object_name">object name</a>.\r
+ Synonym for <a href="#def_object_name">object name</a>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_object_name"></a>object name\r
+<a id="def_object_name"></a>object name\r
</dt>\r
<dd>\r
<p>\r
- The unique identifier of an <a href="#ref_object">object</a>. The <a href="#ref_hash">hash</a>\r
- of the <a href="#ref_object">object</a>'s contents using the Secure Hash Algorithm\r
+ The unique identifier of an <a href="#def_object">object</a>. The <a href="#def_hash">hash</a>\r
+ of the <a href="#def_object">object</a>'s contents using the Secure Hash Algorithm\r
1 and usually represented by the 40 character hexadecimal encoding of\r
- the <a href="#ref_hash">hash</a> of the <a href="#ref_object">object</a> (possibly followed by\r
+ the <a href="#def_hash">hash</a> of the <a href="#def_object">object</a> (possibly followed by\r
a white space).\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_object_type"></a>object type\r
+<a id="def_object_type"></a>object type\r
</dt>\r
<dd>\r
<p>\r
One of the identifiers\r
- "<a href="#ref_commit">commit</a>","<a href="#ref_tree">tree</a>","<a href="#ref_tag">tag</a>" and "blob"\r
- describing the type of an <a href="#ref_object">object</a>.\r
+ "<a href="#def_commit">commit</a>","<a href="#def_tree">tree</a>","<a href="#def_tag">tag</a>" or "<a href="#def_blob_object">blob</a>"\r
+ describing the type of an <a href="#def_object">object</a>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_octopus"></a>octopus\r
+<a id="def_octopus"></a>octopus\r
</dt>\r
<dd>\r
<p>\r
- To <a href="#ref_merge">merge</a> more than two branches. Also denotes an\r
+ To <a href="#def_merge">merge</a> more than two branches. Also denotes an\r
intelligent predator.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_origin"></a>origin\r
+<a id="def_origin"></a>origin\r
</dt>\r
<dd>\r
<p>\r
- The default upstream <a href="#ref_repository">repository</a>. Most projects have\r
+ The default upstream <a href="#def_repository">repository</a>. Most projects have\r
at least one upstream project which they track. By default\r
- <em><a href="#ref_origin">origin</a></em> is used for that purpose. New upstream updates\r
+ <em><a href="#def_origin">origin</a></em> is used for that purpose. New upstream updates\r
will be fetched into remote tracking branches named\r
- <a href="#ref_origin">origin</a>/name-of-upstream-branch, which you can see using\r
- "git <a href="#ref_branch">branch</a> -r".\r
+ origin/name-of-upstream-branch, which you can see using\r
+ "git <a href="#def_branch">branch</a> -r".\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_pack"></a>pack\r
+<a id="def_pack"></a>pack\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_pack_index"></a>pack index\r
+<a id="def_pack_index"></a>pack index\r
</dt>\r
<dd>\r
<p>\r
The list of identifiers, and other information, of the objects in a\r
- <a href="#ref_pack">pack</a>, to assist in efficiently accessing the contents of a\r
- <a href="#ref_pack">pack</a>.\r
+ <a href="#def_pack">pack</a>, to assist in efficiently accessing the contents of a\r
+ <a href="#def_pack">pack</a>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_parent"></a>parent\r
+<a id="def_parent"></a>parent\r
</dt>\r
<dd>\r
<p>\r
- A <a href="#ref_commit_object">commit object</a> contains a (possibly empty) list\r
+ A <a href="#def_commit_object">commit object</a> contains a (possibly empty) list\r
of the logical predecessor(s) in the line of development, i.e. its\r
parents.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_pickaxe"></a>pickaxe\r
+<a id="def_pickaxe"></a>pickaxe\r
</dt>\r
<dd>\r
<p>\r
- The term <a href="#ref_pickaxe">pickaxe</a> refers to an option to the diffcore\r
+ The term <a href="#def_pickaxe">pickaxe</a> refers to an option to the diffcore\r
routines that help select changes that add or delete a given text\r
string. With the —pickaxe-all option, it can be used to view the full\r
- <a href="#ref_changeset">changeset</a> that introduced or removed, say, a\r
+ <a href="#def_changeset">changeset</a> that introduced or removed, say, a\r
particular line of text. See <a href="git-diff.html">git-diff(1)</a>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_plumbing"></a>plumbing\r
+<a id="def_plumbing"></a>plumbing\r
</dt>\r
<dd>\r
<p>\r
- Cute name for <a href="#ref_core_git">core git</a>.\r
+ Cute name for <a href="#def_core_git">core git</a>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_porcelain"></a>porcelain\r
+<a id="def_porcelain"></a>porcelain\r
</dt>\r
<dd>\r
<p>\r
Cute name for programs and program suites depending on\r
- <a href="#ref_core_git">core git</a>, presenting a high level access to\r
- <a href="#ref_core_git">core git</a>. Porcelains expose more of a <a href="#ref_SCM">SCM</a>\r
- interface than the <a href="#ref_plumbing">plumbing</a>.\r
+ <a href="#def_core_git">core git</a>, presenting a high level access to\r
+ <a href="#def_core_git">core git</a>. Porcelains expose more of a <a href="#def_SCM">SCM</a>\r
+ interface than the <a href="#def_plumbing">plumbing</a>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_pull"></a>pull\r
+<a id="def_pull"></a>pull\r
</dt>\r
<dd>\r
<p>\r
- Pulling a <a href="#ref_branch">branch</a> means to <a href="#ref_fetch">fetch</a> it and\r
- <a href="#ref_merge">merge</a> it.\r
+ Pulling a <a href="#def_branch">branch</a> means to <a href="#def_fetch">fetch</a> it and\r
+ <a href="#def_merge">merge</a> it.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_push"></a>push\r
+<a id="def_push"></a>push\r
</dt>\r
<dd>\r
<p>\r
- Pushing a <a href="#ref_branch">branch</a> means to get the <a href="#ref_branch">branch</a>'s\r
- <a href="#ref_head_ref">head ref</a> from a remote <a href="#ref_repository">repository</a>,\r
- find out if it is an ancestor to the <a href="#ref_branch">branch</a>'s local\r
- <a href="#ref_head_ref">head ref</a> is a direct, and in that case, putting all\r
- objects, which are <a href="#ref_reachable">reachable</a> from the local\r
- <a href="#ref_head_ref">head ref</a>, and which are missing from the remote\r
- <a href="#ref_repository">repository</a>, into the remote\r
- <a href="#ref_object_database">object database</a>, and updating the remote\r
- <a href="#ref_head_ref">head ref</a>. If the remote <a href="#ref_head">head</a> is not an\r
- ancestor to the local <a href="#ref_head">head</a>, the <a href="#ref_push">push</a> fails.\r
+ Pushing a <a href="#def_branch">branch</a> means to get the <a href="#def_branch">branch</a>'s\r
+ <a href="#def_head_ref">head ref</a> from a remote <a href="#def_repository">repository</a>,\r
+ find out if it is an ancestor to the <a href="#def_branch">branch</a>'s local\r
+ <a href="#def_head_ref">head ref</a> is a direct, and in that case, putting all\r
+ objects, which are <a href="#def_reachable">reachable</a> from the local\r
+ <a href="#def_head_ref">head ref</a>, and which are missing from the remote\r
+ <a href="#def_repository">repository</a>, into the remote\r
+ <a href="#def_object_database">object database</a>, and updating the remote\r
+ <a href="#def_head_ref">head ref</a>. If the remote <a href="#def_head">head</a> is not an\r
+ ancestor to the local <a href="#def_head">head</a>, the <a href="#def_push">push</a> fails.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_reachable"></a>reachable\r
+<a id="def_reachable"></a>reachable\r
</dt>\r
<dd>\r
<p>\r
- All of the ancestors of a given <a href="#ref_commit">commit</a> are said to be\r
- <a href="#ref_reachable">reachable</a> from that <a href="#ref_commit">commit</a>. More\r
- generally, one <a href="#ref_object">object</a> is <a href="#ref_reachable">reachable</a> from\r
- another if we can reach the one from the other by a <a href="#ref_chain">chain</a>\r
- that follows tags to whatever they <a href="#ref_tag">tag</a>, commits to their\r
- parents or trees, and trees to the trees or blobs that they contain.\r
+ All of the ancestors of a given <a href="#def_commit">commit</a> are said to be\r
+ <a href="#def_reachable">reachable</a> from that <a href="#def_commit">commit</a>. More\r
+ generally, one <a href="#def_object">object</a> is <a href="#def_reachable">reachable</a> from\r
+ another if we can reach the one from the other by a <a href="#def_chain">chain</a>\r
+ that follows <a href="#def_tag">tags</a> to whatever they tag,\r
+ <a href="#def_commit_object">commits</a> to their parents or trees, and\r
+ <a href="#def_tree_object">trees</a> to the trees or <a href="#def_blob_object">blobs</a>\r
+ that they contain.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_rebase"></a>rebase\r
+<a id="def_rebase"></a>rebase\r
</dt>\r
<dd>\r
<p>\r
- To <a href="#ref_clean">clean</a> a <a href="#ref_branch">branch</a> by starting from the\r
- <a href="#ref_head">head</a> of the main line of development\r
- ("<a href="#ref_master">master</a>"), and reapply the (possibly cherry-picked)\r
- changes from that <a href="#ref_branch">branch</a>.\r
+ To reapply a series of changes from a <a href="#def_branch">branch</a> to a\r
+ different base, and reset the <a href="#def_head">head</a> of that branch\r
+ to the result.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_ref"></a>ref\r
+<a id="def_ref"></a>ref\r
</dt>\r
<dd>\r
<p>\r
- A 40-byte hex representation of a <a href="#ref_SHA1">SHA1</a> or a name that\r
- denotes a particular <a href="#ref_object">object</a>. These may be stored in\r
+ A 40-byte hex representation of a <a href="#def_SHA1">SHA1</a> or a name that\r
+ denotes a particular <a href="#def_object">object</a>. These may be stored in\r
<tt>$GIT_DIR/refs/</tt>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_refspec"></a>refspec\r
+<a id="def_refspec"></a>refspec\r
</dt>\r
<dd>\r
<p>\r
- A <a href="#ref_refspec">refspec</a> is used by <a href="#ref_fetch">fetch</a> and\r
- <a href="#ref_push">push</a> to describe the mapping between remote <a href="#ref_ref">ref</a>\r
- and local <a href="#ref_ref">ref</a>. They are combined with a colon in the format\r
+ A <a href="#def_refspec">refspec</a> is used by <a href="#def_fetch">fetch</a> and\r
+ <a href="#def_push">push</a> to describe the mapping between remote <a href="#def_ref">ref</a>\r
+ and local <a href="#def_ref">ref</a>. They are combined with a colon in the format\r
<src>:<dst>, preceded by an optional plus sign, +. For example: <tt>git\r
- <a href="#ref_fetch">fetch</a> $URL\r
- refs/heads/<a href="#ref_master">master</a>:refs/heads/<a href="#ref_origin">origin</a></tt> means\r
- "grab the <a href="#ref_master">master</a> <a href="#ref_branch">branch</a> <a href="#ref_head">head</a>\r
- from the $URL and store it as my <a href="#ref_origin">origin</a>\r
- <a href="#ref_branch">branch</a> <a href="#ref_head">head</a>". And <tt>git <a href="#ref_push">push</a>\r
- $URL refs/heads/<a href="#ref_master">master</a>:refs/heads/to-upstream</tt> means\r
- "publish my <a href="#ref_master">master</a> <a href="#ref_branch">branch</a>\r
- <a href="#ref_head">head</a> as to-upstream <a href="#ref_branch">branch</a> at $URL". See\r
+ fetch $URL refs/heads/master:refs/heads/origin</tt> means\r
+ "grab the master <a href="#def_branch">branch</a> <a href="#def_head">head</a>\r
+ from the $URL and store it as my origin\r
+ <a href="#def_branch">branch</a> <a href="#def_head">head</a>". And <tt>git <a href="#def_push">push</a>\r
+ $URL refs/heads/master:refs/heads/to-upstream</tt> means\r
+ "publish my master <a href="#def_branch">branch</a>\r
+ <a href="#def_head">head</a> as to-upstream <a href="#def_branch">branch</a> at $URL". See\r
also <a href="git-push.html">git-push(1)</a>\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_repository"></a>repository\r
+<a id="def_repository"></a>repository\r
</dt>\r
<dd>\r
<p>\r
- A collection of refs together with an <a href="#ref_object_database">object database</a> containing all objects, which are <a href="#ref_reachable">reachable</a>\r
+ A collection of refs together with an <a href="#def_object_database">object database</a> containing all objects which are <a href="#def_reachable">reachable</a>\r
from the refs, possibly accompanied by meta data from one or more\r
- porcelains. A <a href="#ref_repository">repository</a> can share an\r
- <a href="#ref_object_database">object database</a> with other repositories.\r
+ porcelains. A <a href="#def_repository">repository</a> can share an\r
+ <a href="#def_object_database">object database</a> with other repositories.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_resolve"></a>resolve\r
+<a id="def_resolve"></a>resolve\r
</dt>\r
<dd>\r
<p>\r
The action of fixing up manually what a failed automatic\r
- <a href="#ref_merge">merge</a> left behind.\r
+ <a href="#def_merge">merge</a> left behind.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_revision"></a>revision\r
+<a id="def_revision"></a>revision\r
</dt>\r
<dd>\r
<p>\r
A particular state of files and directories which was stored in the\r
- <a href="#ref_object_database">object database</a>. It is referenced by a\r
- <a href="#ref_commit_object">commit object</a>.\r
+ <a href="#def_object_database">object database</a>. It is referenced by a\r
+ <a href="#def_commit_object">commit object</a>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_rewind"></a>rewind\r
+<a id="def_rewind"></a>rewind\r
</dt>\r
<dd>\r
<p>\r
To throw away part of the development, i.e. to assign the\r
- <a href="#ref_head">head</a> to an earlier <a href="#ref_revision">revision</a>.\r
+ <a href="#def_head">head</a> to an earlier <a href="#def_revision">revision</a>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_SCM"></a>SCM\r
+<a id="def_SCM"></a>SCM\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_SHA1"></a>SHA1\r
+<a id="def_SHA1"></a>SHA1\r
</dt>\r
<dd>\r
<p>\r
- Synonym for <a href="#ref_object_name">object name</a>.\r
+ Synonym for <a href="#def_object_name">object name</a>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_shallow_repository"></a>shallow repository\r
+<a id="def_shallow_repository"></a>shallow repository\r
</dt>\r
<dd>\r
<p>\r
- A <a href="#ref_shallow_repository">shallow repository</a> has an incomplete\r
+ A <a href="#def_shallow_repository">shallow repository</a> has an incomplete\r
history some of whose commits have parents cauterized away (in other\r
words, git is told to pretend that these commits do not have the\r
- parents, even though they are recorded in the <a href="#ref_commit_object">commit object</a>). This is sometimes useful when you are interested only in the\r
+ parents, even though they are recorded in the <a href="#def_commit_object">commit object</a>). This is sometimes useful when you are interested only in the\r
recent history of a project even though the real history recorded in the\r
- upstream is much larger. A <a href="#ref_shallow_repository">shallow repository</a>\r
- is created by giving <tt>—depth</tt> option to <a href="git-clone.html">git-clone(1)</a>, and its\r
- history can be later deepened with <a href="git-fetch.html">git-fetch(1)</a>.\r
+ upstream is much larger. A <a href="#def_shallow_repository">shallow repository</a>\r
+ is created by giving the <tt>—depth</tt> option to <a href="git-clone.html">git-clone(1)</a>, and\r
+
its history can be later deepened with <a href="git-fetch.html">git-fetch(1)</a>.
\r </p>\r
</dd>\r
<dt>\r
-<a id="ref_symref"></a>symref\r
+<a id="def_symref"></a>symref\r
</dt>\r
<dd>\r
<p>\r
- Symbolic reference: instead of containing the <a href="#ref_SHA1">SHA1</a> id\r
- itself, it is of the format <em><a href="#ref_ref">ref</a>: refs/some/thing</em> and when\r
+ Symbolic reference: instead of containing the <a href="#def_SHA1">SHA1</a> id\r
+ itself, it is of the format <em>ref: refs/some/thing</em> and when\r
referenced, it recursively dereferences to this reference. <em>HEAD</em> is a\r
- prime example of a <a href="#ref_symref">symref</a>. Symbolic references are\r
+ prime example of a <a href="#def_symref">symref</a>. Symbolic references are\r
manipulated with the <a href="git-symbolic-ref.html">git-symbolic-ref(1)</a> command.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_tag"></a>tag\r
+<a id="def_tag"></a>tag\r
</dt>\r
<dd>\r
<p>\r
- A <a href="#ref_ref">ref</a> pointing to a <a href="#ref_tag">tag</a> or\r
- <a href="#ref_commit_object">commit object</a>. In contrast to a <a href="#ref_head">head</a>,\r
- a <a href="#ref_tag">tag</a> is not changed by a <a href="#ref_commit">commit</a>. Tags (not\r
- <a href="#ref_tag">tag</a> objects) are stored in <tt>$GIT_DIR/refs/tags/</tt>. A git\r
- <a href="#ref_tag">tag</a> has nothing to do with a Lisp <a href="#ref_tag">tag</a> (which is\r
- called <a href="#ref_object_type">object type</a> in git's context). A\r
- <a href="#ref_tag">tag</a> is most typically used to mark a particular point in the\r
- <a href="#ref_commit">commit</a> ancestry <a href="#ref_chain">chain</a>.\r
+ A <a href="#def_ref">ref</a> pointing to a <a href="#def_tag">tag</a> or\r
+ <a href="#def_commit_object">commit object</a>. In contrast to a <a href="#def_head">head</a>,\r
+ a tag is not changed by a <a href="#def_commit">commit</a>. Tags (not\r
+ <a href="#def_tag_object">tag objects</a>) are stored in <tt>$GIT_DIR/refs/tags/</tt>. A\r
+ git tag has nothing to do with a Lisp tag (which would be\r
+ called an <a href="#def_object_type">object type</a> in git's context). A\r
+ tag is most typically used to mark a particular point in the\r
+ <a href="#def_commit">commit</a> ancestry <a href="#def_chain">chain</a>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_tag_object"></a>tag object\r
+<a id="def_tag_object"></a>tag object\r
</dt>\r
<dd>\r
<p>\r
- An <a href="#ref_object">object</a> containing a <a href="#ref_ref">ref</a> pointing to\r
- another <a href="#ref_object">object</a>, which can contain a message just like a\r
- <a href="#ref_commit_object">commit object</a>. It can also contain a (PGP)\r
- signature, in which case it is called a "signed <a href="#ref_tag_object">tag object</a>".\r
+ An <a href="#def_object">object</a> containing a <a href="#def_ref">ref</a> pointing to\r
+ another <a href="#def_object">object</a>, which can contain a message just like a\r
+ <a href="#def_commit_object">commit object</a>. It can also contain a (PGP)\r
+ signature, in which case it is called a "signed <a href="#def_tag_object">tag object</a>".\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_topic_branch"></a>topic branch\r
+<a id="def_topic_branch"></a>topic branch\r
</dt>\r
<dd>\r
<p>\r
- A regular git <a href="#ref_branch">branch</a> that is used by a developer to\r
+ A regular git <a href="#def_branch">branch</a> that is used by a developer to\r
identify a conceptual line of development. Since branches are very easy\r
and inexpensive, it is often desirable to have several small branches\r
that each contain very well defined concepts or small incremental yet\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_tracking_branch"></a>tracking branch\r
+<a id="def_tracking_branch"></a>tracking branch\r
</dt>\r
<dd>\r
<p>\r
- A regular git <a href="#ref_branch">branch</a> that is used to follow changes from\r
- another <a href="#ref_repository">repository</a>. A <a href="#ref_tracking_branch">tracking branch</a> should not contain direct modifications or have local commits\r
- made to it. A <a href="#ref_tracking_branch">tracking branch</a> can usually be\r
- identified as the right-hand-side <a href="#ref_ref">ref</a> in a Pull:\r
- <a href="#ref_refspec">refspec</a>.\r
+ A regular git <a href="#def_branch">branch</a> that is used to follow changes from\r
+ another <a href="#def_repository">repository</a>. A <a href="#def_tracking_branch">tracking branch</a> should not contain direct modifications or have local commits\r
+ made to it. A <a href="#def_tracking_branch">tracking branch</a> can usually be\r
+ identified as the right-hand-side <a href="#def_ref">ref</a> in a Pull:\r
+ <a href="#def_refspec">refspec</a>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_tree"></a>tree\r
+<a id="def_tree"></a>tree\r
</dt>\r
<dd>\r
<p>\r
- Either a <a href="#ref_working_tree">working tree</a>, or a <a href="#ref_tree_object">tree object</a> together with the dependent blob and <a href="#ref_tree">tree</a> objects\r
- (i.e. a stored representation of a <a href="#ref_working_tree">working tree</a>).\r
+ Either a <a href="#def_working_tree">working tree</a>, or a <a href="#def_tree_object">tree object</a> together with the dependent blob and <a href="#def_tree">tree</a> objects\r
+ (i.e. a stored representation of a <a href="#def_working_tree">working tree</a>).\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_tree_object"></a>tree object\r
+<a id="def_tree_object"></a>tree object\r
</dt>\r
<dd>\r
<p>\r
- An <a href="#ref_object">object</a> containing a list of file names and modes along\r
- with refs to the associated blob and/or <a href="#ref_tree">tree</a> objects. A\r
- <a href="#ref_tree">tree</a> is equivalent to a <a href="#ref_directory">directory</a>.\r
+ An <a href="#def_object">object</a> containing a list of file names and modes along\r
+ with refs to the associated blob and/or tree objects. A\r
+ <a href="#def_tree">tree</a> is equivalent to a <a href="#def_directory">directory</a>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_tree-ish"></a>tree-ish\r
+<a id="def_tree-ish"></a>tree-ish\r
</dt>\r
<dd>\r
<p>\r
- A <a href="#ref_ref">ref</a> pointing to either a <a href="#ref_commit_object">commit object</a>, a <a href="#ref_tree_object">tree object</a>, or a <a href="#ref_tag_object">tag object</a> pointing to a <a href="#ref_tag">tag</a> or <a href="#ref_commit">commit</a> or\r
- <a href="#ref_tree_object">tree object</a>.\r
+ A <a href="#def_ref">ref</a> pointing to either a <a href="#def_commit_object">commit object</a>, a <a href="#def_tree_object">tree object</a>, or a <a href="#def_tag_object">tag object</a> pointing to a <a href="#def_tag">tag</a> or <a href="#def_commit">commit</a> or\r
+ <a href="#def_tree_object">tree object</a>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_unmerged_index"></a>unmerged index\r
+<a id="def_unmerged_index"></a>unmerged index\r
</dt>\r
<dd>\r
<p>\r
- An <a href="#ref_index">index</a> which contains <a href="#ref_unmerged_index">unmerged index</a> entries.\r
+ An <a href="#def_index">index</a> which contains unmerged\r
+ <a href="#def_index_entry">index entries</a>.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_unreachable_object"></a>unreachable object\r
+<a id="def_unreachable_object"></a>unreachable object\r
</dt>\r
<dd>\r
<p>\r
- An <a href="#ref_object">object</a> which is not <a href="#ref_reachable">reachable</a> from a\r
- <a href="#ref_branch">branch</a>, <a href="#ref_tag">tag</a>, or any other reference.\r
+ An <a href="#def_object">object</a> which is not <a href="#def_reachable">reachable</a> from a\r
+ <a href="#def_branch">branch</a>, <a href="#def_tag">tag</a>, or any other reference.\r
</p>\r
</dd>\r
<dt>\r
-<a id="ref_working_tree"></a>working tree\r
+<a id="def_working_tree"></a>working tree\r
</dt>\r
<dd>\r
<p>\r
The set of files and directories currently being worked on, i.e. you can\r
- work in your <a href="#ref_working_tree">working tree</a> without using git at all.\r
+ work in your <a href="#def_working_tree">working tree</a> without using git at all.\r
</p>\r
</dd>\r
</dl>\r
</div>\r
</div>\r
-<h2>Author</h2>\r
-<div class="sectionbody">\r
-<p>Written by Johannes Schindelin <Johannes.Schindelin@gmx.de> and\r
-the git-list <git@vger.kernel.org>.</p>\r
-</div>\r
-<h2>GIT</h2>\r
-<div class="sectionbody">\r
-<p>Part of the <a href="git.html">git</a> suite</p>\r
-</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 12-Mar-2007 07:28:58 UTC\r
+Last updated 26-Mar-2007 02:33:24 UTC\r
</div>\r
</div>\r
</body>\r
-alternate object database::
- Via the alternates mechanism, a repository can inherit part of its
- object database from another object database, which is called
- "alternate".
-
-bare repository::
- A bare repository is normally an appropriately named
- 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::
- Untyped object, e.g. the contents of a file.
-
-branch::
- A non-cyclical graph of revisions, i.e. the complete history of
- a particular revision, which is called the branch head. The
- branch heads are stored in `$GIT_DIR/refs/heads/`.
-
-cache::
- Obsolete for: index.
-
-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).
-
-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.
-
-checkout::
- The action of updating the working tree to a revision which was
- 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::
- As a verb: The action of storing the current state of the index in the
- object database. The result is a revision.
- As a noun: Short hand for commit object.
-
-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.
-
-core git::
- Fundamental data structures and utilities of git. Exposes only
- limited source code management tools.
-
-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).
-
-dangling object::
- An unreachable object which is not reachable even from other
- unreachable objects; a dangling object has no references to it
- from any reference or object in the repository.
-
-dircache::
+GIT Glossary
+============
+
+[[def_alternate_object_database]]alternate object database::
+ Via the alternates mechanism, a <<def_repository,repository>> can
+ inherit part of its <<def_object_database,object database>> from another
+ <<def_object_database,object database>>, which is called "alternate".
+
+[[def_bare_repository]]bare repository::
+ A <<def_bare_repository,bare repository>> is normally an appropriately
+ named <<def_directory,directory>> with a `.git` suffix that does not
+ have a locally checked-out copy of any of the files under
+ <<def_revision,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.
+
+[[def_blob_object]]blob object::
+ Untyped <<def_object,object>>, e.g. the contents of a file.
+
+[[def_branch]]branch::
+ A non-cyclical graph of revisions, i.e. the complete history of a
+ particular <<def_revision,revision>>, which is called the
+ branch <<def_head,head>>. The heads
+ are stored in `$GIT_DIR/refs/heads/`.
+
+[[def_cache]]cache::
+ Obsolete for: <<def_index,index>>.
+
+[[def_chain]]chain::
+ A list of objects, where each <<def_object,object>> in the list contains
+ a reference to its successor (for example, the successor of a
+ <<def_commit,commit>> could be one of its parents).
+
+[[def_changeset]]changeset::
+ BitKeeper/cvsps speak for "<<def_commit,commit>>". Since git does not
+ store changes, but states, it really does not make sense to use the term
+ "changesets" with git.
+
+[[def_checkout]]checkout::
+ The action of updating the <<def_working_tree,working tree>> to a
+ <<def_revision,revision>> which was stored in the
+ <<def_object_database,object database>>.
+
+[[def_cherry-picking]]cherry-picking::
+ In <<def_SCM,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 <<def_commit,commit>> and to record it based on the tip
+ of the current <<def_branch,branch>> as a new <<def_commit,commit>>.
+
+[[def_clean]]clean::
+ A <<def_working_tree,working tree>> is <<def_clean,clean>>, if it
+ corresponds to the <<def_revision,revision>> referenced by the current
+ <<def_head,head>>. Also see "<<def_dirty,dirty>>".
+
+[[def_commit]]commit::
+ As a verb: The action of storing the current state of the
+ <<def_index,index>> in the <<def_object_database,object database>>. The
+ result is a <<def_revision,revision>>. As a noun: Short hand for
+ <<def_commit_object,commit object>>.
+
+[[def_commit_object]]commit object::
+ An <<def_object,object>> which contains the information about a
+ particular <<def_revision,revision>>, such as parents, committer,
+ author, date and the <<def_tree_object,tree object>> which corresponds
+ to the top <<def_directory,directory>> of the stored
+ <<def_revision,revision>>.
+
+[[def_core_git]]core git::
+ Fundamental data structures and utilities of git. Exposes only limited
+ source code management tools.
+
+[[def_DAG]]DAG::
+ Directed acyclic graph. The <<def_commit,commit>> objects form a
+ directed acyclic graph, because they have parents (directed), and the
+ graph of <<def_commit,commit>> objects is acyclic (there is no
+ <<def_chain,chain>> which begins and ends with the same
+ <<def_object,object>>).
+
+[[def_dangling_object]]dangling object::
+ An <<def_unreachable_object,unreachable object>> which is not
+ <<def_reachable,reachable>> even from other unreachable objects; a
+ <<def_dangling_object,dangling object>> has no references to it from any
+ reference or <<def_object,object>> in the <<def_repository,repository>>.
+
+[[def_dircache]]dircache::
You are *waaaaay* behind.
-dirty::
- A working tree is said to be dirty if it contains modifications
- which have not been committed to the current branch.
-
-directory::
+[[def_directory]]directory::
The list you get with "ls" :-)
-ent::
- Favorite synonym to "tree-ish" by some total geeks. See
+[[def_dirty]]dirty::
+ A <<def_working_tree,working tree>> is said to be <<def_dirty,dirty>> if
+ it contains modifications which have not been committed to the current
+ <<def_branch,branch>>.
+
+[[def_ent]]ent::
+ Favorite synonym to "<<def_tree-ish,tree-ish>>" by some total geeks. See
`http://en.wikipedia.org/wiki/Ent_(Middle-earth)` for an in-depth
- explanation. Avoid this term, not to confuse people.
-
-fast forward::
- A fast-forward is a special type of merge where you have
- a revision and you are "merging" another branch's changes
- 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.
-
-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.
-
-file system::
- Linus Torvalds originally designed git to be a user space file
- 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).
-
-grafts::
- Grafts enables two otherwise different lines of development to be
- joined together by recording fake ancestry information for commits.
- This way you can make git pretend the set of parents a commit
- has is different from what was recorded when the commit was created.
- Configured via the `.git/info/grafts` file.
-
-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::
- A ref pointing to a head. Often, this is abbreviated to "head".
- Head refs are stored in `$GIT_DIR/refs/heads/`.
-
-hook::
- During the normal execution of several git commands,
- 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.
-
-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).
-
-master::
- The default development branch. Whenever you create a git
- repository, a branch named "master" is created, and becomes
- the active branch. In most cases, this contains the local
+ explanation. Avoid this term, not to confuse people.
+
+[[def_fast_forward]]fast forward::
+ A fast-forward is a special type of <<def_merge,merge>> where you have a
+ <<def_revision,revision>> and you are "merging" another
+ <<def_branch,branch>>'s changes that happen to be a descendant of what
+ you have. In such these cases, you do not make a new <<def_merge,merge>>
+ <<def_commit,commit>> but instead just update to his
+ <<def_revision,revision>>. This will happen frequently on a
+ <<def_tracking_branch,tracking branch>> of a remote
+ <<def_repository,repository>>.
+
+[[def_fetch]]fetch::
+ Fetching a <<def_branch,branch>> means to get the
+ <<def_branch,branch>>'s <<def_head_ref,head ref>> from a remote
+ <<def_repository,repository>>, to find out which objects are missing
+ from the local <<def_object_database,object database>>, and to get them,
+ too.
+
+[[def_file_system]]file system::
+ Linus Torvalds originally designed git to be a user space file system,
+ i.e. the infrastructure to hold files and directories. That ensured the
+ efficiency and speed of git.
+
+[[def_git_archive]]git archive::
+ Synonym for <<def_repository,repository>> (for arch people).
+
+[[def_grafts]]grafts::
+ Grafts enables two otherwise different lines of development to be joined
+ together by recording fake ancestry information for commits. This way
+ you can make git pretend the set of parents a <<def_commit,commit>> has
+ is different from what was recorded when the <<def_commit,commit>> was
+ created. Configured via the `.git/info/grafts` file.
+
+[[def_hash]]hash::
+ In git's context, synonym to <<def_object_name,object name>>.
+
+[[def_head]]head::
+ The top of a <<def_branch,branch>>. It contains a <<def_ref,ref>> to the
+ corresponding <<def_commit_object,commit object>>.
+
+[[def_head_ref]]head ref::
+ A <<def_ref,ref>> pointing to a <<def_head,head>>. Often, this is
+ abbreviated to "<<def_head,head>>". Head refs are stored in
+ `$GIT_DIR/refs/heads/`.
+
+[[def_hook]]hook::
+ During the normal execution of several git commands, 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 <<def_hook,hook>> scripts are found in the
+ `$GIT_DIR/hooks/` <<def_directory,directory>>, and are enabled by simply
+ making them executable.
+
+[[def_index]]index::
+ A collection of files with stat information, whose contents are stored
+ as objects. The <<def_index,index>> is a stored version of your working
+ <<def_tree,tree>>. Truth be told, it can also contain a second, and even
+ a third version of a <<def_working_tree,working tree>>, which are used
+ when merging.
+
+[[def_index_entry]]index entry::
+ The information regarding a particular file, stored in the
+ <<def_index,index>>. An <<def_index_entry,index entry>> can be unmerged,
+ if a <<def_merge,merge>> was started, but not yet finished (i.e. if the
+ <<def_index,index>> contains multiple versions of that file).
+
+[[def_master]]master::
+ The default development <<def_branch,branch>>. Whenever you create a git
+ <<def_repository,repository>>, a <<def_branch,branch>> named
+ "<<def_master,master>>" is created, and becomes the active
+ <<def_branch,branch>>. In most cases, this contains the local
development, though that is purely conventional and not required.
-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.
-
-object::
- The unit of storage in git. It is uniquely identified by
- the SHA1 of its contents. Consequently, an object can not
- be changed.
-
-object database::
- Stores a set of "objects", and an individual object is identified
- by its object name. The objects usually live in `$GIT_DIR/objects/`.
-
-object identifier::
- Synonym for object name.
-
-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).
-
-object type::
- One of the identifiers "commit","tree","tag" and "blob" describing
- the type of an object.
-
-octopus::
- To merge more than two branches. Also denotes an intelligent
- predator.
-
-origin::
- The default upstream repository. Most projects have at
- least one upstream project which they track. By default
- 'origin' is used for that purpose. New upstream updates
+[[def_merge]]merge::
+ To <<def_merge,merge>> branches means to try to accumulate the changes
+ since a common ancestor and apply them to the first
+ <<def_branch,branch>>. An automatic <<def_merge,merge>> uses heuristics
+ to accomplish that. Evidently, an automatic <<def_merge,merge>> can
+ fail.
+
+[[def_object]]object::
+ The unit of storage in git. It is uniquely identified by the
+ <<def_SHA1,SHA1>> of its contents. Consequently, an
+ <<def_object,object>> can not be changed.
+
+[[def_object_database]]object database::
+ Stores a set of "objects", and an individual <<def_object,object>> is
+ identified by its <<def_object_name,object name>>. The objects usually
+ live in `$GIT_DIR/objects/`.
+
+[[def_object_identifier]]object identifier::
+ Synonym for <<def_object_name,object name>>.
+
+[[def_object_name]]object name::
+ The unique identifier of an <<def_object,object>>. The <<def_hash,hash>>
+ of the <<def_object,object>>'s contents using the Secure Hash Algorithm
+ 1 and usually represented by the 40 character hexadecimal encoding of
+ the <<def_hash,hash>> of the <<def_object,object>> (possibly followed by
+ a white space).
+
+[[def_object_type]]object type::
+ One of the identifiers
+ "<<def_commit,commit>>","<<def_tree,tree>>","<<def_tag,tag>>" or "<<def_blob_object,blob>>"
+ describing the type of an <<def_object,object>>.
+
+[[def_octopus]]octopus::
+ To <<def_merge,merge>> more than two branches. Also denotes an
+ intelligent predator.
+
+[[def_origin]]origin::
+ The default upstream <<def_repository,repository>>. Most projects have
+ at least one upstream project which they track. By default
+ '<<def_origin,origin>>' is used for that purpose. New upstream updates
will be fetched into remote tracking branches named
origin/name-of-upstream-branch, which you can see using
- "git branch -r".
+ "git <<def_branch,branch>> -r".
-pack::
- A set of objects which have been compressed into one file (to save
- space or to transmit them efficiently).
+[[def_pack]]pack::
+ A set of objects which have been compressed into one file (to save space
+ or to transmit them efficiently).
-pack index::
+[[def_pack_index]]pack index::
The list of identifiers, and other information, of the objects in a
- pack, to assist in efficiently accessing the contents of a pack.
-
-parent::
- A commit object contains a (possibly empty) list of the logical
- predecessor(s) in the line of development, i.e. its parents.
-
-pickaxe::
- The term pickaxe refers to an option to the diffcore routines
- that help select changes that add or delete a given text string.
- 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::
- 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.
-
-reachable::
- All of the ancestors of a given commit are said to be reachable from
- that commit. More generally, one object is reachable from another if
- we can reach the one from the other by a chain that follows tags to
- whatever they tag, commits to their parents or trees, and trees to the
- trees or blobs that they contain.
-
-rebase::
- To clean a branch by starting from the head of the main line of
- development ("master"), and reapply the (possibly cherry-picked)
- changes from that branch.
-
-ref::
- A 40-byte hex representation of a SHA1 or a name that denotes
- 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 branch
- at $URL". See also gitlink:git-push[1]
-
-repository::
- 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.
-
-resolve::
- The action of fixing up manually what a failed automatic merge
- left behind.
-
-revision::
- A particular state of files and directories which was stored in
- 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::
+ <<def_pack,pack>>, to assist in efficiently accessing the contents of a
+ <<def_pack,pack>>.
+
+[[def_parent]]parent::
+ A <<def_commit_object,commit object>> contains a (possibly empty) list
+ of the logical predecessor(s) in the line of development, i.e. its
+ parents.
+
+[[def_pickaxe]]pickaxe::
+ The term <<def_pickaxe,pickaxe>> refers to an option to the diffcore
+ routines that help select changes that add or delete a given text
+ string. With the --pickaxe-all option, it can be used to view the full
+ <<def_changeset,changeset>> that introduced or removed, say, a
+ particular line of text. See gitlink:git-diff[1].
+
+[[def_plumbing]]plumbing::
+ Cute name for <<def_core_git,core git>>.
+
+[[def_porcelain]]porcelain::
+ Cute name for programs and program suites depending on
+ <<def_core_git,core git>>, presenting a high level access to
+ <<def_core_git,core git>>. Porcelains expose more of a <<def_SCM,SCM>>
+ interface than the <<def_plumbing,plumbing>>.
+
+[[def_pull]]pull::
+ Pulling a <<def_branch,branch>> means to <<def_fetch,fetch>> it and
+ <<def_merge,merge>> it.
+
+[[def_push]]push::
+ Pushing a <<def_branch,branch>> means to get the <<def_branch,branch>>'s
+ <<def_head_ref,head ref>> from a remote <<def_repository,repository>>,
+ find out if it is an ancestor to the <<def_branch,branch>>'s local
+ <<def_head_ref,head ref>> is a direct, and in that case, putting all
+ objects, which are <<def_reachable,reachable>> from the local
+ <<def_head_ref,head ref>>, and which are missing from the remote
+ <<def_repository,repository>>, into the remote
+ <<def_object_database,object database>>, and updating the remote
+ <<def_head_ref,head ref>>. If the remote <<def_head,head>> is not an
+ ancestor to the local <<def_head,head>>, the <<def_push,push>> fails.
+
+[[def_reachable]]reachable::
+ All of the ancestors of a given <<def_commit,commit>> are said to be
+ <<def_reachable,reachable>> from that <<def_commit,commit>>. More
+ generally, one <<def_object,object>> is <<def_reachable,reachable>> from
+ another if we can reach the one from the other by a <<def_chain,chain>>
+ that follows <<def_tag,tags>> to whatever they tag,
+ <<def_commit_object,commits>> to their parents or trees, and
+ <<def_tree_object,trees>> to the trees or <<def_blob_object,blobs>>
+ that they contain.
+
+[[def_rebase]]rebase::
+ To reapply a series of changes from a <<def_branch,branch>> to a
+ different base, and reset the <<def_head,head>> of that branch
+ to the result.
+
+[[def_ref]]ref::
+ A 40-byte hex representation of a <<def_SHA1,SHA1>> or a name that
+ denotes a particular <<def_object,object>>. These may be stored in
+ `$GIT_DIR/refs/`.
+
+[[def_refspec]]refspec::
+ A <<def_refspec,refspec>> is used by <<def_fetch,fetch>> and
+ <<def_push,push>> to describe the mapping between remote <<def_ref,ref>>
+ and local <<def_ref,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 <<def_branch,branch>> <<def_head,head>>
+ from the $URL and store it as my origin
+ <<def_branch,branch>> <<def_head,head>>". And `git <<def_push,push>>
+ $URL refs/heads/master:refs/heads/to-upstream` means
+ "publish my master <<def_branch,branch>>
+ <<def_head,head>> as to-upstream <<def_branch,branch>> at $URL". See
+ also gitlink:git-push[1]
+
+[[def_repository]]repository::
+ A collection of refs together with an <<def_object_database,object
+ database>> containing all objects which are <<def_reachable,reachable>>
+ from the refs, possibly accompanied by meta data from one or more
+ porcelains. A <<def_repository,repository>> can share an
+ <<def_object_database,object database>> with other repositories.
+
+[[def_resolve]]resolve::
+ The action of fixing up manually what a failed automatic
+ <<def_merge,merge>> left behind.
+
+[[def_revision]]revision::
+ A particular state of files and directories which was stored in the
+ <<def_object_database,object database>>. It is referenced by a
+ <<def_commit_object,commit object>>.
+
+[[def_rewind]]rewind::
+ To throw away part of the development, i.e. to assign the
+ <<def_head,head>> to an earlier <<def_revision,revision>>.
+
+[[def_SCM]]SCM::
Source code management (tool).
-SHA1::
- Synonym for object name.
-
-shallow repository::
- A shallow repository has an incomplete history some of
- whose commits have parents cauterized away (in other
- words, git is told to pretend that these commits do not
- have the parents, even though they are recorded in the
- commit object). This is sometimes useful when you are
- interested only in the recent history of a project even
- though the real history recorded in the upstream is
- much larger. A shallow repository is created by giving
- `--depth` option to gitlink:git-clone[1], and its
- history can be later deepened with gitlink:git-fetch[1].
-
-symref::
- Symbolic reference: instead of containing the SHA1 id itself, it
- is of the format 'ref: refs/some/thing' and when referenced, it
- recursively dereferences to this reference. 'HEAD' is a prime
- example of a symref. Symbolic references are manipulated with
- the gitlink:git-symbolic-ref[1] command.
-
-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.
-
-unreachable object::
- An object which is not reachable from a branch, tag, or any
- other reference.
-
-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.
-
+[[def_SHA1]]SHA1::
+ Synonym for <<def_object_name,object name>>.
+
+[[def_shallow_repository]]shallow repository::
+ A <<def_shallow_repository,shallow repository>> has an incomplete
+ history some of whose commits have parents cauterized away (in other
+ words, git is told to pretend that these commits do not have the
+ parents, even though they are recorded in the <<def_commit_object,commit
+ object>>). This is sometimes useful when you are interested only in the
+ recent history of a project even though the real history recorded in the
+ upstream is much larger. A <<def_shallow_repository,shallow repository>>
+ is created by giving the `--depth` option to gitlink:git-clone[1], and
+ its history can be later deepened with gitlink:git-fetch[1].
+
+[[def_symref]]symref::
+ Symbolic reference: instead of containing the <<def_SHA1,SHA1>> id
+ itself, it is of the format 'ref: refs/some/thing' and when
+ referenced, it recursively dereferences to this reference. 'HEAD' is a
+ prime example of a <<def_symref,symref>>. Symbolic references are
+ manipulated with the gitlink:git-symbolic-ref[1] command.
+
+[[def_tag]]tag::
+ A <<def_ref,ref>> pointing to a <<def_tag,tag>> or
+ <<def_commit_object,commit object>>. In contrast to a <<def_head,head>>,
+ a tag is not changed by a <<def_commit,commit>>. Tags (not
+ <<def_tag_object,tag objects>>) are stored in `$GIT_DIR/refs/tags/`. A
+ git tag has nothing to do with a Lisp tag (which would be
+ called an <<def_object_type,object type>> in git's context). A
+ tag is most typically used to mark a particular point in the
+ <<def_commit,commit>> ancestry <<def_chain,chain>>.
+
+[[def_tag_object]]tag object::
+ An <<def_object,object>> containing a <<def_ref,ref>> pointing to
+ another <<def_object,object>>, which can contain a message just like a
+ <<def_commit_object,commit object>>. It can also contain a (PGP)
+ signature, in which case it is called a "signed <<def_tag_object,tag
+ object>>".
+
+[[def_topic_branch]]topic branch::
+ A regular git <<def_branch,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.
+
+[[def_tracking_branch]]tracking branch::
+ A regular git <<def_branch,branch>> that is used to follow changes from
+ another <<def_repository,repository>>. A <<def_tracking_branch,tracking
+ branch>> should not contain direct modifications or have local commits
+ made to it. A <<def_tracking_branch,tracking branch>> can usually be
+ identified as the right-hand-side <<def_ref,ref>> in a Pull:
+ <<def_refspec,refspec>>.
+
+[[def_tree]]tree::
+ Either a <<def_working_tree,working tree>>, or a <<def_tree_object,tree
+ object>> together with the dependent blob and <<def_tree,tree>> objects
+ (i.e. a stored representation of a <<def_working_tree,working tree>>).
+
+[[def_tree_object]]tree object::
+ An <<def_object,object>> containing a list of file names and modes along
+ with refs to the associated blob and/or tree objects. A
+ <<def_tree,tree>> is equivalent to a <<def_directory,directory>>.
+
+[[def_tree-ish]]tree-ish::
+ A <<def_ref,ref>> pointing to either a <<def_commit_object,commit
+ object>>, a <<def_tree_object,tree object>>, or a <<def_tag_object,tag
+ object>> pointing to a <<def_tag,tag>> or <<def_commit,commit>> or
+ <<def_tree_object,tree object>>.
+
+[[def_unmerged_index]]unmerged index::
+ An <<def_index,index>> which contains unmerged
+ <<def_index_entry,index entries>>.
+
+[[def_unreachable_object]]unreachable object::
+ An <<def_object,object>> which is not <<def_reachable,reachable>> from a
+ <<def_branch,branch>>, <<def_tag,tag>>, or any other reference.
+
+[[def_working_tree]]working tree::
+ The set of files and directories currently being worked on, i.e. you can
+ work in your <<def_working_tree,working tree>> without using git at all.
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Git User's Manual</title><link rel="stylesheet" href="docbook-xsl.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.69.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="id232635"></a>Git User's Manual</h1></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="preface"><a href="#id264704">Preface</a></span></dt><dt><span class="chapter"><a href="#id233155">1. Git Quick Start</a></span></dt><dd><dl><dt><span class="section"><a href="#id233166">Creating a new repository</a></span></dt><dt><span class="section"><a href="#id233198">Managing branches</a></span></dt><dt><span class="section"><a href="#id232445">Exploring history</a></span></dt><dt><span class="section"><a href="#id232489">Making changes</a></span></dt><dt><span class="section"><a href="#id233361">Merging</a></span></dt><dt><span class="section"><a href="#id233378">Sharing your changes</a></span></dt><dt><span class="section"><a href="#id233463">Repository maintenance</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id232662">2. Repositories and Branches</a></span></dt><dd><dl><dt><span class="section"><a href="#id232667">How to get a git repository</a></span></dt><dt><span class="section"><a href="#id232724">How to check out a different version of a project</a></span></dt><dt><span class="section"><a href="#id273
402">Understanding History: Commits</a></span></dt><dd><dl><dt><span class="section"><a href="#id273567">Understanding history: commits, parents, and reachability</a></span></dt><dt><span class="section"><a href="#id273607">Understanding history: History diagrams</a></span></dt><dt><span class="section"><a href="#id273635">Understanding history: What is a branch?</a></span></dt></dl></dd><dt><span class="section"><a href="#id273658">Manipulating branches</a></span></dt><dt><span class="section"><a href="#id273790">Examining branches from a remote repository</a></span></dt><dt><span class="section"><a href="#how-git-stores-references">Naming branches, tags, and other references</a></span></dt><dt><span class="section"><a href="#Updating-a-repository-with-git-fetch">Updating a repository with git fetch</a></span></dt><dt><span class="section"><a href="#id274036">Fetching branches from other repositories</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id274110">3. Exploring git history</a></span></dt><dd><dl><dt><span class="section"><a href="#id274132">How to use bisect to find a regression</a></span></dt><dt><span class="section"><a href="#id274252">Naming commits</a></span></dt><dt><span class="section"><a href="#id274400">Creating tags</a></span></dt><dt><span class="section"><a href="#id274435">Browsing revisions</a></span></dt><dt><span class="section"><a href="#id274509">Generating diffs</a></span></dt><dt><span class="section"><a href="#id274552">Viewing old file versions</a></span></dt><dt><span class="section"><a href="#id274578">Examples</a></span></dt><dd><dl><dt><span class="section"><a href="#id274583">Check whether two branches point at the same history</a></span></dt><dt><span class="section"><a href="#id274636">Find first tagged version including a given fix</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#id274800">4. Developing with git</a></span></dt><dd><dl><dt><span class="section"><a href="#id274805">Telling git your name</a></span></dt><dt><span class="section"><a href="#id274837">Creating a new repository</a></span></dt><dt><span class="section"><a href="#how-to-make-a-commit">how to make a commit</a></span></dt><dt><span class="section"><a href="#id275065">creating good commit messages</a></span></dt><dt><span class="section"><a href="#id275081">how to merge</a></span></dt><dt><span class="section"><a href="#resolving-a-merge">Resolving a merge</a></span></dt><dd><dl><dt><span class="section"><a href="#id275217">Getting conflict-resolution help during a merge</a></span></dt></dl></dd><dt><span class="section"><a href="#undoing-a-merge">undoing a merge</a></span></dt><dt><span class="section"><a href="#id275426">Fast-forward merges</a></span></dt><dt><span class="section"><a href="#id275455">Fixing mistakes</a></span></dt><dd><dl><dt><span class="section"><a href="#id275508">Fixing a mistake with a new commit</a></span></dt><dt><span class="section"><a href="#fixing-a-mistake-by-editing-history">Fixing a mistake by editing history</a></span></dt><dt><span class="section"><a href="#id275640">Checking out an old version of a file</a></span></dt></dl></dd><dt><span class="section"><a href="#id275699">Ensuring good performance</a></span></dt><dt><span class="section"><a href="#id275736">Ensuring reliability</a></span></dt><dd><dl><dt><span class="section"><a href="#id275742">Checking the repository for corruption</a></span></dt><dt><span class="section"><a href="#id275817">Recovering lost changes</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#id275967">5. Sharing development with others</a></span></dt><dd><dl><dt><span class="section"><a href="#getting-updates-with-git-pull">Getting updates with git pull</a></span></dt><dt><span class="section"><a href="#id276098">Submitting patches to a project</a></span></dt><dt><span class="section"><a href="#id276148">Importing patches to a project</a></span></dt><dt><span class="section"><a href="#setting-up-a-public-repository">Setting up a public repository</a></span></dt><dt><span class="section"><a href="#exporting-via-http">Exporting a git repository via http</a></span></dt><dt><span class="section"><a href="#exporting-via-git">Exporting a git repository via the git protocol</a></span></dt><dt><span class="section"><a href="#pushing-changes-to-a-public-repository">Pushing changes to a public repository</a></span></dt><dt><span class="section"><a href="#id276559">Setting up a shared repository</a></span></dt><dt><span class="section"><a href="#id276578">Allow web browsing of a repository</a></span></dt><dt><span class="section"><a href="#id276591">Examples</a></span></dt></dl></dd><dt><span class="chapter"><a href="#cleaning-up-history">6. Rewriting history and maintaining patch series</a></span></dt><dd><dl><dt><span class="section"><a href="#id276623">Creating the perfect patch series</a></span></dt><dt><span class="section"><a href="#id276698">Keeping a patch series up to date using git-rebase</a></span></dt><dt><span class="section"><a href="#id276828">Modifying a single commit</a></span></dt><dt><span class="section"><a href="#id276918">Reordering or selecting from a patch series</a></span></dt><dt><span class="section"><a href="#id276978">Other tools</a></span></dt><dt><span class="section"><a href="#id276991">Problems with rewriting history</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id277062">7. Advanced branch management</a></span></dt><dd><dl><dt><span class="section"><a href="#id277068">Fetching individual branches</a></span></dt><dt><span class="section"><a href="#fast-forwards">Understanding git history: fast-forwards</a></span></dt><dt><span class="section"><a href="#id277188">Forcing git fetch to do non-fast-forward updates</a></span></dt><dt><span class="section"><a href="#id277215">Configuring remote branches</a></span></dt></dl></dd><dt><span class="chapter"><a href="#git-internals">8. Git internals</a></span></dt><dd><dl><dt><span class="section"><a href="#id277353">The Object Database</a></span></dt><dt><span class="section"><a href="#id277469">Blob Object</a></span></dt><dt><span class="section"><a href="#id277512">Tree Object</a></span></dt><dt><span class="section"><a href="#id232240">Commit Object</a></span></dt><dt><span class="section"><a href="#id277705">Trust</a></span></dt><dt><span class="section"><a href="#id277755">Tag Object</a></span></dt><dt><span class="section"><a href="#id277801">The "index" aka "Current Directory Cache"</a></span></dt><dt><span class="section"><a href="#id277877">The Workflow</a></span></dt><dd><dl><dt><span class="section"><a href="#id277895">working directory -> index</a></span></dt><dt><span class="section"><a href="#id277985">index -> object database</a></span></dt><dt><span class="section"><a href="#id278013">object database -> index</a></span></dt><dt><span class="section"><a href="#id278044">index -> working directory</a></span></dt><dt><span class="section"><a href="#id278108">Tying it all together</a></span></dt></dl></dd><dt><span class="section"><a href="#id278202">Examining the data</a></span></dt><dt><span class="section"><a href="#id278280">Merging multiple trees</a></span></dt><dt><span class="section"><a href="#id278368">Merging multiple trees, continued</a></span></dt><dt><span class="section"><a href="#id278628">How git stores objects efficiently: pack files</a></span></dt><dt><span class="section"><a href="#dangling-objects">Dangling objects</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id278888">9. Glossary of git terms</a></span></dt><dt><span class="chapter"><a href="#id280134">10. Notes and todo list for this manual</a></span></dt></dl></div><div class="preface" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id264704"></a>Preface</h2></div></div></div><p>This manual is designed to be readable by someone with basic unix
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Git User's Manual</title><link rel="stylesheet" href="docbook-xsl.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.69.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="id232635"></a>Git User's Manual</h1></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="preface"><a href="#id264704">Preface</a></span></dt><dt><span class="chapter"><a href="#id233155">1. Git Quick Start</a></span></dt><dd><dl><dt><span class="section"><a href="#id233166">Creating a new repository</a></span></dt><dt><span class="section"><a href="#id233198">Managing branches</a></span></dt><dt><span class="section"><a href="#id232445">Exploring history</a></span></dt><dt><span class="section"><a href="#id232489">Making changes</a></span></dt><dt><span class="section"><a href="#id233361">Merging</a></span></dt><dt><span class="section"><a href="#id233378">Sharing your changes</a></span></dt><dt><span class="section"><a href="#id233463">Repository maintenance</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id232662">2. Repositories and Branches</a></span></dt><dd><dl><dt><span class="section"><a href="#id232667">How to get a git repository</a></span></dt><dt><span class="section"><a href="#id232724">How to check out a different version of a project</a></span></dt><dt><span class="section"><a href="#id273
520">Understanding History: Commits</a></span></dt><dd><dl><dt><span class="section"><a href="#id273583">Understanding history: commits, parents, and reachability</a></span></dt><dt><span class="section"><a href="#id273622">Understanding history: History diagrams</a></span></dt><dt><span class="section"><a href="#id273650">Understanding history: What is a branch?</a></span></dt></dl></dd><dt><span class="section"><a href="#id273673">Manipulating branches</a></span></dt><dt><span class="section"><a href="#id273806">Examining branches from a remote repository</a></span></dt><dt><span class="section"><a href="#how-git-stores-references">Naming branches, tags, and other references</a></span></dt><dt><span class="section"><a href="#Updating-a-repository-with-git-fetch">Updating a repository with git fetch</a></span></dt><dt><span class="section"><a href="#id274051">Fetching branches from other repositories</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id274126">3. Exploring git history</a></span></dt><dd><dl><dt><span class="section"><a href="#id274148">How to use bisect to find a regression</a></span></dt><dt><span class="section"><a href="#id274267">Naming commits</a></span></dt><dt><span class="section"><a href="#id274415">Creating tags</a></span></dt><dt><span class="section"><a href="#id274450">Browsing revisions</a></span></dt><dt><span class="section"><a href="#id274524">Generating diffs</a></span></dt><dt><span class="section"><a href="#id274567">Viewing old file versions</a></span></dt><dt><span class="section"><a href="#id274593">Examples</a></span></dt><dd><dl><dt><span class="section"><a href="#id274599">Check whether two branches point at the same history</a></span></dt><dt><span class="section"><a href="#id274652">Find first tagged version including a given fix</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#id274815">4. Developing with git</a></span></dt><dd><dl><dt><span class="section"><a href="#id274821">Telling git your name</a></span></dt><dt><span class="section"><a href="#id274853">Creating a new repository</a></span></dt><dt><span class="section"><a href="#how-to-make-a-commit">how to make a commit</a></span></dt><dt><span class="section"><a href="#id275080">creating good commit messages</a></span></dt><dt><span class="section"><a href="#id275096">how to merge</a></span></dt><dt><span class="section"><a href="#resolving-a-merge">Resolving a merge</a></span></dt><dd><dl><dt><span class="section"><a href="#id275233">Getting conflict-resolution help during a merge</a></span></dt></dl></dd><dt><span class="section"><a href="#undoing-a-merge">undoing a merge</a></span></dt><dt><span class="section"><a href="#id275442">Fast-forward merges</a></span></dt><dt><span class="section"><a href="#id275470">Fixing mistakes</a></span></dt><dd><dl><dt><span class="section"><a href="#id275523">Fixing a mistake with a new commit</a></span></dt><dt><span class="section"><a href="#fixing-a-mistake-by-editing-history">Fixing a mistake by editing history</a></span></dt><dt><span class="section"><a href="#id275656">Checking out an old version of a file</a></span></dt></dl></dd><dt><span class="section"><a href="#id275714">Ensuring good performance</a></span></dt><dt><span class="section"><a href="#id275752">Ensuring reliability</a></span></dt><dd><dl><dt><span class="section"><a href="#id275757">Checking the repository for corruption</a></span></dt><dt><span class="section"><a href="#id275832">Recovering lost changes</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#id275982">5. Sharing development with others</a></span></dt><dd><dl><dt><span class="section"><a href="#getting-updates-with-git-pull">Getting updates with git pull</a></span></dt><dt><span class="section"><a href="#id276114">Submitting patches to a project</a></span></dt><dt><span class="section"><a href="#id276163">Importing patches to a project</a></span></dt><dt><span class="section"><a href="#setting-up-a-public-repository">Setting up a public repository</a></span></dt><dt><span class="section"><a href="#exporting-via-http">Exporting a git repository via http</a></span></dt><dt><span class="section"><a href="#exporting-via-git">Exporting a git repository via the git protocol</a></span></dt><dt><span class="section"><a href="#pushing-changes-to-a-public-repository">Pushing changes to a public repository</a></span></dt><dt><span class="section"><a href="#id276576">Setting up a shared repository</a></span></dt><dt><span class="section"><a href="#id276595">Allow web browsing of a repository</a></span></dt><dt><span class="section"><a href="#id276608">Examples</a></span></dt></dl></dd><dt><span class="chapter"><a href="#cleaning-up-history">6. Rewriting history and maintaining patch series</a></span></dt><dd><dl><dt><span class="section"><a href="#id276640">Creating the perfect patch series</a></span></dt><dt><span class="section"><a href="#id276714">Keeping a patch series up to date using git-rebase</a></span></dt><dt><span class="section"><a href="#id276845">Modifying a single commit</a></span></dt><dt><span class="section"><a href="#id276935">Reordering or selecting from a patch series</a></span></dt><dt><span class="section"><a href="#id276995">Other tools</a></span></dt><dt><span class="section"><a href="#id277008">Problems with rewriting history</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id277079">7. Advanced branch management</a></span></dt><dd><dl><dt><span class="section"><a href="#id277085">Fetching individual branches</a></span></dt><dt><span class="section"><a href="#fast-forwards">Understanding git history: fast-forwards</a></span></dt><dt><span class="section"><a href="#id277205">Forcing git fetch to do non-fast-forward updates</a></span></dt><dt><span class="section"><a href="#id277232">Configuring remote branches</a></span></dt></dl></dd><dt><span class="chapter"><a href="#git-internals">8. Git internals</a></span></dt><dd><dl><dt><span class="section"><a href="#id277370">The Object Database</a></span></dt><dt><span class="section"><a href="#id277486">Blob Object</a></span></dt><dt><span class="section"><a href="#id277529">Tree Object</a></span></dt><dt><span class="section"><a href="#id232240">Commit Object</a></span></dt><dt><span class="section"><a href="#id277722">Trust</a></span></dt><dt><span class="section"><a href="#id277772">Tag Object</a></span></dt><dt><span class="section"><a href="#id277818">The "index" aka "Current Directory Cache"</a></span></dt><dt><span class="section"><a href="#id277894">The Workflow</a></span></dt><dd><dl><dt><span class="section"><a href="#id277912">working directory -> index</a></span></dt><dt><span class="section"><a href="#id278002">index -> object database</a></span></dt><dt><span class="section"><a href="#id278030">object database -> index</a></span></dt><dt><span class="section"><a href="#id278061">index -> working directory</a></span></dt><dt><span class="section"><a href="#id278125">Tying it all together</a></span></dt></dl></dd><dt><span class="section"><a href="#id278219">Examining the data</a></span></dt><dt><span class="section"><a href="#id278297">Merging multiple trees</a></span></dt><dt><span class="section"><a href="#id278385">Merging multiple trees, continued</a></span></dt><dt><span class="section"><a href="#id278645">How git stores objects efficiently: pack files</a></span></dt><dt><span class="section"><a href="#dangling-objects">Dangling objects</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id278905">9. GIT Glossary</a></span></dt><dt><span class="chapter"><a href="#id282187">10. Notes and todo list for this manual</a></span></dt></dl></div><div class="preface" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id264704"></a>Preface</h2></div></div></div><p>This manual is designed to be readable by someone with basic unix
command-line skills, but no previous knowledge of git.</p><p>Chapter 1 gives a brief overview of git commands, without any
explanation; you may prefer to skip to chapter 2 on a first reading.</p><p>Chapters 2 and 3 explain how to fetch and study a project using
git—the tools you'd need to build and test a particular version of a
current branch:</p><div class="literallayout"><p>$ git pull git://example.com/project.git theirbranch</p></div><p>Store the fetched branch into a local branch before merging into the
current branch:</p><div class="literallayout"><p>$ git pull git://example.com/project.git theirbranch:mybranch</p></div><p>After creating commits on a local branch, update the remote
branch with your commits:</p><div class="literallayout"><p>$ git push ssh://example.com/project.git mybranch:theirbranch</p></div><p>When remote and local branch are both named "test":</p><div class="literallayout"><p>$ git push ssh://example.com/project.git test</p></div><p>Shortcut version for a frequently used remote repository:</p><div class="literallayout"><p>$ git remote add example ssh://example.com/project.git<br>
-$ git push example test</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id233463"></a>Repository maintenance</h2></div></div></div><p>Check for corruption:</p><div class="literallayout"><p>$ git fsck</p></div><p>Recompress, remove unused cruft:</p><div class="literallayout"><p>$ git gc</p></div></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id232662"></a>Chapter 2. Repositories and Branches</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id232667">How to get a git repository</a></span></dt><dt><span class="section"><a href="#id232724">How to check out a different version of a project</a></span></dt><dt><span class="section"><a href="#id273
402">Understanding History: Commits</a></span></dt><dd><dl><dt><span class="section"><a href="#id273567">Understanding history: commits, parents, and reachability</a></span></dt><dt><span class="section"><a href="#id273607">Understanding history: History diagrams</a></span></dt><dt><span class="section"><a href="#id273635">Understanding history: What is a branch?</a></span></dt></dl></dd><dt><span class="section"><a href="#id273658">Manipulating branches</a></span></dt><dt><span class="section"><a href="#id273790">Examining branches from a remote repository</a></span></dt><dt><span class="section"><a href="#how-git-stores-references">Naming branches, tags, and other references</a></span></dt><dt><span class="section"><a href="#Updating-a-repository-with-git-fetch">Updating a repository with git fetch</a></span></dt><dt><span class="section"><a href="#id274036">Fetching branches from other repositories</a></span></dt></dl></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id232667"></a>How to get a git repository</h2></div></div></div><p>It will be useful to have a git repository to experiment with as you
+$ git push example test</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id233463"></a>Repository maintenance</h2></div></div></div><p>Check for corruption:</p><div class="literallayout"><p>$ git fsck</p></div><p>Recompress, remove unused cruft:</p><div class="literallayout"><p>$ git gc</p></div></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id232662"></a>Chapter 2. Repositories and Branches</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id232667">How to get a git repository</a></span></dt><dt><span class="section"><a href="#id232724">How to check out a different version of a project</a></span></dt><dt><span class="section"><a href="#id273
520">Understanding History: Commits</a></span></dt><dd><dl><dt><span class="section"><a href="#id273583">Understanding history: commits, parents, and reachability</a></span></dt><dt><span class="section"><a href="#id273622">Understanding history: History diagrams</a></span></dt><dt><span class="section"><a href="#id273650">Understanding history: What is a branch?</a></span></dt></dl></dd><dt><span class="section"><a href="#id273673">Manipulating branches</a></span></dt><dt><span class="section"><a href="#id273806">Examining branches from a remote repository</a></span></dt><dt><span class="section"><a href="#how-git-stores-references">Naming branches, tags, and other references</a></span></dt><dt><span class="section"><a href="#Updating-a-repository-with-git-fetch">Updating a repository with git fetch</a></span></dt><dt><span class="section"><a href="#id274051">Fetching branches from other repositories</a></span></dt></dl></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id232667"></a>How to get a git repository</h2></div></div></div><p>It will be useful to have a git repository to experiment with as you
read this manual.</p><p>The best way to get one is by using the <a href="git-clone.html" target="_top">git-clone(1)</a> command
to download a copy of an existing repository for a project that you
are interested in. If you don't already have a project in mind, here
repositories above.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id232724"></a>How to check out a different version of a project</h2></div></div></div><p>Git is best thought of as a tool for storing the history of a
collection of files. It stores the history as a compressed
collection of interrelated snapshots (versions) of the project's
-contents.</p><p>A single git repository may contain multiple branches. Each branch
-is a bookmark referencing a particular point in the project history.
-The <a href="git-branch.html" target="_top">git-branch(1)</a> command shows you the list of branches:</p><div class="literallayout"><p>$ git branch<br>
-* master</p></div><p>A freshly cloned repository contains a single branch, named "master",
-and the working directory contains the version of the project
-referred to by the master branch.</p><p>Most projects also use tags. Tags, like branches, are references
-into the project's history, and can be listed using the
+contents.</p><p>A single git repository may contain multiple branches. It keeps track
+of them by keeping a list of <a href="#def_head">heads</a> which reference the
+latest version on each branch; the <a href="git-branch.html" target="_top">git-branch(1)</a> command shows
+you the list of branch heads:</p><div class="literallayout"><p>$ git branch<br>
+* master</p></div><p>A freshly cloned repository contains a single branch head, named
+"master", and working directory is initialized to the state of
+the project referred to by "master".</p><p>Most projects also use <a href="#def_tag">tags</a>. Tags, like heads, are
+references into the project's history, and can be listed using the
<a href="git-tag.html" target="_top">git-tag(1)</a> command:</p><div class="literallayout"><p>$ git tag -l<br>
v2.6.11<br>
v2.6.11-tree<br>
v2.6.12-rc6<br>
v2.6.13<br>
...</p></div><p>Tags are expected to always point at the same version of a project,
-while branches are expected to advance as development progresses.</p><p>Create a new branch pointing to one of these versions and check it
+while heads are expected to advance as development progresses.</p><p>Create a new branch head pointing to one of these versions and check it
out using <a href="git-checkout.html" target="_top">git-checkout(1)</a>:</p><div class="literallayout"><p>$ git checkout -b new v2.6.13</p></div><p>The working directory then reflects the contents that the project had
when it was tagged v2.6.13, and <a href="git-branch.html" target="_top">git-branch(1)</a> shows two
branches, with an asterisk marking the currently checked-out branch:</p><div class="literallayout"><p>$ git branch<br>
master<br>
* new</p></div><p>If you decide that you'd rather see version 2.6.17, you can modify
-the current branch to point at v2.6.17 instead, with</p><div class="literallayout"><p>$ git reset --hard v2.6.17</p></div><p>Note that if the current branch was your only reference to a
+the current branch to point at v2.6.17 instead, with</p><div class="literallayout"><p>$ git reset --hard v2.6.17</p></div><p>Note that if the current branch head was your only reference to a
particular point in history, then resetting that branch may leave you
-with no way to find the history it used to point to; so use this
-c
ommand carefully.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id273402"></a>Understanding History: Commits</h2></div></div></div><p>Every change in the history of a project is represented by a commit.
+with no way to find the history it used to point to; so use this command
+c
arefully.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id273520"></a>Understanding History: Commits</h2></div></div></div><p>Every change in the history of a project is represented by a commit.
The <a href="git-show.html" target="_top">git-show(1)</a> command shows the most recent commit on the
current branch:</p><div class="literallayout"><p>$ git show<br>
commit 2b5f6dcce5bf94b9b119e9ed8d537098ec61c3d2<br>
contents of the commit, you are guaranteed that the commit can never change
without its name also changing.</p><p>In fact, in <a href="#git-internals" title="Chapter 8. Git internals">Chapter 8, <i>Git internals</i></a> we shall see that everything stored in git
history, including file data and directory contents, is stored in an object
-with a name that is a hash of its contents.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2735
67"></a>Understanding history: commits, parents, and reachability</h3></div></div></div><p>Every commit (except the very first commit in a project) also has a
+with a name that is a hash of its contents.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2735
83"></a>Understanding history: commits, parents, and reachability</h3></div></div></div><p>Every commit (except the very first commit in a project) also has a
parent commit which shows what happened before this commit.
Following the chain of parents will eventually take you back to the
beginning of the project.</p><p>However, the commits do not form a simple list; git allows lines of
commits will help understand how the git organizes history.</p><p>In the following, we say that commit X is "reachable" from commit Y
if commit X is an ancestor of commit Y. Equivalently, you could say
that Y is a descendent of X, or that there is a chain of parents
-leading from commit Y to commit X.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2736
07"></a>Understanding history: History diagrams</h3></div></div></div><p>We will sometimes represent git history using diagrams like the one
+leading from commit Y to commit X.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2736
22"></a>Understanding history: History diagrams</h3></div></div></div><p>We will sometimes represent git history using diagrams like the one
below. Commits are shown as "o", and the links between them with
lines drawn with - / and \. Time goes left to right:</p><pre class="literallayout"> o--o--o <-- Branch A
/
o--o--o <-- master
\
o--o--o <-- Branch B</pre><p>If we need to talk about a particular commit, the character "o" may
-be replaced with another letter or number.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id273635"></a>Understanding history: What is a branch?</h3></div></div></div><p>Though we've been using the word "branch" to mean a kind of reference
-to a particular commit, the word branch is also commonly used to
-refer to the line of commits leading up to that point. In the
-example above, git may think of the branch named "A" as just a
-pointer to one particular commit, but we may refer informally to the
-line of three commits leading up to that point as all being part of
-"branch A".</p><p>If we need to make it clear that we're just talking about the most
-recent commit on the branch, we may refer to that commit as the
-"head" of the branch.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id273658"></a>Manipulating branches</h2></div></div></div><p>Creating, deleting, and modifying branches is quick and easy; here's
+be replaced with another letter or number.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id273650"></a>Understanding history: What is a branch?</h3></div></div></div><p>When we need to be precise, we will use the word "branch" to mean a line
+of development, and "branch head" (or just "head") to mean a reference
+to the most recent commit on a branch. In the example above, the branch
+head named "A" is a pointer to one particular commit, but we refer to
+the line of three commits leading up to that point as all being part of
+"branch A".</p><p>However, when no confusion will result, we often just use the term
+"branch" both for branches and for branch heads.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id273673"></a>Manipulating branches</h2></div></div></div><p>Creating, deleting, and modifying branches is quick and easy; here's
a summary of the commands:</p><div class="variablelist"><dl><dt><span class="term">
git branch
</span></dt><dd>
create a new branch <new> referencing <start-point>, and
check it out.
</dd></dl></div><p>It is also useful to know that the special symbol "HEAD" can always
-be used to refer to the current branch.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id273
790"></a>Examining branches from a remote repository</h2></div></div></div><p>The "master" branch that was created at the time you cloned is a copy
+be used to refer to the current branch.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id273
806"></a>Examining branches from a remote repository</h2></div></div></div><p>The "master" branch that was created at the time you cloned is a copy
of the HEAD in the repository that you cloned from. That repository
may also have had other branches, though, and your local repository
keeps branches which track each of those remote branches, which you
at the new commits.</p><p>The command "git fetch", with no arguments, will update all of the
remote-tracking branches to the latest version found in her
repository. It will not touch any of your own branches—not even the
-"master" branch that was created for you on clone.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2740
36"></a>Fetching branches from other repositories</h2></div></div></div><p>You can also track branches from repositories other than the one you
+"master" branch that was created for you on clone.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2740
51"></a>Fetching branches from other repositories</h2></div></div></div><p>You can also track branches from repositories other than the one you
cloned from, using <a href="git-remote.html" target="_top">git-remote(1)</a>:</p><div class="literallayout"><p>$ git remote add linux-nfs git://linux-nfs.org/pub/nfs-2.6.git<br>
$ git fetch<br>
* refs/remotes/linux-nfs/master: storing branch 'master' ...<br>
...</p></div><p>This is what causes git to track the remote's branches; you may modify
or delete these configuration options by editing .git/config with a
text editor. (See the "CONFIGURATION FILE" section of
-<a href="git-config.html" target="_top">git-config(1)</a> for details.)</p></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id2741
10"></a>Chapter 3. Exploring git history</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id274132">How to use bisect to find a regression</a></span></dt><dt><span class="section"><a href="#id274252">Naming commits</a></span></dt><dt><span class="section"><a href="#id274400">Creating tags</a></span></dt><dt><span class="section"><a href="#id274435">Browsing revisions</a></span></dt><dt><span class="section"><a href="#id274509">Generating diffs</a></span></dt><dt><span class="section"><a href="#id274552">Viewing old file versions</a></span></dt><dt><span class="section"><a href="#id274578">Examples</a></span></dt><dd><dl><dt><span class="section"><a href="#id274583">Check whether two branches point at the same history</a></span></dt><dt><span class="section"><a href="#id274636">Find first tagged version including a given fix</a></span></dt></dl></dd></dl></div><p>Git is best thought of as a tool for storing the history of a
+<a href="git-config.html" target="_top">git-config(1)</a> for details.)</p></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id2741
26"></a>Chapter 3. Exploring git history</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id274148">How to use bisect to find a regression</a></span></dt><dt><span class="section"><a href="#id274267">Naming commits</a></span></dt><dt><span class="section"><a href="#id274415">Creating tags</a></span></dt><dt><span class="section"><a href="#id274450">Browsing revisions</a></span></dt><dt><span class="section"><a href="#id274524">Generating diffs</a></span></dt><dt><span class="section"><a href="#id274567">Viewing old file versions</a></span></dt><dt><span class="section"><a href="#id274593">Examples</a></span></dt><dd><dl><dt><span class="section"><a href="#id274599">Check whether two branches point at the same history</a></span></dt><dt><span class="section"><a href="#id274652">Find first tagged version including a given fix</a></span></dt></dl></dd></dl></div><p>Git is best thought of as a tool for storing the history of a
collection of files. It does this by storing compressed snapshots of
the contents of a file heirarchy, together with "commits" which show
the relationships between these snapshots.</p><p>Git provides extremely flexible and fast tools for exploring the
history of a project.</p><p>We start with one specialized tool that is useful for finding the
-commit that introduced a bug into a project.</p><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2741
32"></a>How to use bisect to find a regression</h2></div></div></div><p>Suppose version 2.6.18 of your project worked, but the version at
+commit that introduced a bug into a project.</p><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2741
48"></a>How to use bisect to find a regression</h2></div></div></div><p>Suppose version 2.6.18 of your project worked, but the version at
"master" crashes. Sometimes the best way to find the cause of such a
regression is to perform a brute-force search through the project's
history to find the particular commit that caused the problem. The
run</p><div class="literallayout"><p>$ git bisect-visualize</p></div><p>which will run gitk and label the commit it chose with a marker that
says "bisect". Chose a safe-looking commit nearby, note its commit
id, and check it out with:</p><div class="literallayout"><p>$ git reset --hard fb47ddb2db...</p></div><p>then test, run "bisect good" or "bisect bad" as appropriate, and
-continue.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2742
52"></a>Naming commits</h2></div></div></div><p>We have seen several ways of naming commits already:</p><div class="itemizedlist"><ul type="disc"><li>
+continue.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2742
67"></a>Naming commits</h2></div></div></div><p>We have seen several ways of naming commits already:</p><div class="itemizedlist"><ul type="disc"><li>
40-hexdigit object name
</li><li>
branch name: refers to the commit at the head of the given
branch.</p><p>The <a href="git-rev-parse.html" target="_top">git-rev-parse(1)</a> command is a low-level command that is
occasionally useful for translating some name for a commit to the object
name for that commit:</p><div class="literallayout"><p>$ git rev-parse origin<br>
-e05db0fd4f31dde7005f075a84f96b360d05984b</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2744
00"></a>Creating tags</h2></div></div></div><p>We can also create a tag to refer to a particular commit; after
+e05db0fd4f31dde7005f075a84f96b360d05984b</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2744
15"></a>Creating tags</h2></div></div></div><p>We can also create a tag to refer to a particular commit; after
running</p><div class="literallayout"><p>$ git-tag stable-1 1b2e1d63ff</p></div><p>You can use stable-1 to refer to the commit 1b2e1d63ff.</p><p>This creates a "lightweight" tag. If the tag is a tag you wish to
share with others, and possibly sign cryptographically, then you
should create a tag object instead; see the <a href="git-tag.html" target="_top">git-tag(1)</a> man
-page for details.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2744
35"></a>Browsing revisions</h2></div></div></div><p>The <a href="git-log.html" target="_top">git-log(1)</a> command can show lists of commits. On its
+page for details.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2744
50"></a>Browsing revisions</h2></div></div></div><p>The <a href="git-log.html" target="_top">git-log(1)</a> command can show lists of commits. On its
own, it shows all commits reachable from the parent commit; but you
can also make more specific requests:</p><div class="literallayout"><p>$ git log v2.5.. # commits since (not reachable from) v2.5<br>
$ git log test..master # commits reachable from master but not test<br>
display options.</p><p>Note that git log starts with the most recent commit and works
backwards through the parents; however, since git history can contain
multiple independent lines of development, the particular order that
-commits are listed in may be somewhat arbitrary.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2745
09"></a>Generating diffs</h2></div></div></div><p>You can generate diffs between any two versions using
+commits are listed in may be somewhat arbitrary.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2745
24"></a>Generating diffs</h2></div></div></div><p>You can generate diffs between any two versions using
<a href="git-diff.html" target="_top">git-diff(1)</a>:</p><div class="literallayout"><p>$ git diff master..test</p></div><p>Sometimes what you want instead is a set of patches:</p><div class="literallayout"><p>$ git format-patch master..test</p></div><p>will generate a file with a patch for each commit reachable from test
but not from master. Note that if master also has commits which are
not reachable from test, then the combined result of these patches
-will not be the same as the diff produced by the git-diff example.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2745
52"></a>Viewing old file versions</h2></div></div></div><p>You can always view an old version of a file by just checking out the
+will not be the same as the diff produced by the git-diff example.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2745
67"></a>Viewing old file versions</h2></div></div></div><p>You can always view an old version of a file by just checking out the
correct revision first. But sometimes it is more convenient to be
able to view an old version of a single file without checking
anything out; this command does that:</p><div class="literallayout"><p>$ git show v2.5:fs/locks.c</p></div><p>Before the colon may be anything that names a commit, and after it
-may be any path to a file tracked by git.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2745
78"></a>Examples</h2></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id274583"></a>Check whether two branches point at the same history</h3></div></div></div><p>Suppose you want to check whether two branches point at the same point
+may be any path to a file tracked by git.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2745
93"></a>Examples</h2></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id274599"></a>Check whether two branches point at the same history</h3></div></div></div><p>Suppose you want to check whether two branches point at the same point
in history.</p><div class="literallayout"><p>$ git diff origin..master</p></div><p>will tell you whether the contents of the project are the same at the
two branches; in theory, however, it's possible that the same project
contents could have been arrived at by two different historical
$ git rev-list master<br>
e05db0fd4f31dde7005f075a84f96b360d05984b</p></div><p>Or you could recall that the … operator selects all commits
contained reachable from either one reference or the other but not
-both: so</p><div class="literallayout"><p>$ git log origin...master</p></div><p>will return no commits when the two branches are equal.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2746
36"></a>Find first tagged version including a given fix</h3></div></div></div><p>Suppose you know that the commit e05db0fd fixed a certain problem.
+both: so</p><div class="literallayout"><p>$ git log origin...master</p></div><p>will return no commits when the two branches are equal.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2746
52"></a>Find first tagged version including a given fix</h3></div></div></div><p>Suppose you know that the commit e05db0fd fixed a certain problem.
You'd like to find the earliest tagged release that contains that
fix.</p><p>Of course, there may be more than one answer—if the history branched
after commit e05db0fd, then there could be multiple "earliest" tagged
! [v1.5.0-rc2] GIT v1.5.0-rc2<br>
...</p></div><p>then search for a line that looks like</p><div class="literallayout"><p>+ ++ [e05db0fd] Fix warnings in sha1_file.c - use C99 printf format if<br>
available</p></div><p>Which shows that e05db0fd is reachable from itself, from v1.5.0-rc1, and
-from v1.5.0-rc2, but not from v1.5.0-rc0.</p></div></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id2748
00"></a>Chapter 4. Developing with git</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id274805">Telling git your name</a></span></dt><dt><span class="section"><a href="#id274837">Creating a new repository</a></span></dt><dt><span class="section"><a href="#how-to-make-a-commit">how to make a commit</a></span></dt><dt><span class="section"><a href="#id275065">creating good commit messages</a></span></dt><dt><span class="section"><a href="#id275081">how to merge</a></span></dt><dt><span class="section"><a href="#resolving-a-merge">Resolving a merge</a></span></dt><dd><dl><dt><span class="section"><a href="#id275217">Getting conflict-resolution help during a merge</a></span></dt></dl></dd><dt><span class="section"><a href="#undoing-a-merge">undoing a merge</a></span></dt><dt><span class="section"><a href="#id275426">Fast-forward merges</a></span></dt><dt><span class="section"><a href="#id275455">Fixing mistakes</a></span></dt><dd><dl><dt><span class="section"><a href="#id275508">Fixing a mistake with a new commit</a></span></dt><dt><span class="section"><a href="#fixing-a-mistake-by-editing-history">Fixing a mistake by editing history</a></span></dt><dt><span class="section"><a href="#id275640">Checking out an old version of a file</a></span></dt></dl></dd><dt><span class="section"><a href="#id275699">Ensuring good performance</a></span></dt><dt><span class="section"><a href="#id275736">Ensuring reliability</a></span></dt><dd><dl><dt><span class="section"><a href="#id275742">Checking the repository for corruption</a></span></dt><dt><span class="section"><a href="#id275817">Recovering lost changes</a></span></dt></dl></dd></dl></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id274805"></a>Telling git your name</h2></div></div></div><p>Before creating any commits, you should introduce yourself to git. The
+from v1.5.0-rc2, but not from v1.5.0-rc0.</p></div></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id2748
15"></a>Chapter 4. Developing with git</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id274821">Telling git your name</a></span></dt><dt><span class="section"><a href="#id274853">Creating a new repository</a></span></dt><dt><span class="section"><a href="#how-to-make-a-commit">how to make a commit</a></span></dt><dt><span class="section"><a href="#id275080">creating good commit messages</a></span></dt><dt><span class="section"><a href="#id275096">how to merge</a></span></dt><dt><span class="section"><a href="#resolving-a-merge">Resolving a merge</a></span></dt><dd><dl><dt><span class="section"><a href="#id275233">Getting conflict-resolution help during a merge</a></span></dt></dl></dd><dt><span class="section"><a href="#undoing-a-merge">undoing a merge</a></span></dt><dt><span class="section"><a href="#id275442">Fast-forward merges</a></span></dt><dt><span class="section"><a href="#id275470">Fixing mistakes</a></span></dt><dd><dl><dt><span class="section"><a href="#id275523">Fixing a mistake with a new commit</a></span></dt><dt><span class="section"><a href="#fixing-a-mistake-by-editing-history">Fixing a mistake by editing history</a></span></dt><dt><span class="section"><a href="#id275656">Checking out an old version of a file</a></span></dt></dl></dd><dt><span class="section"><a href="#id275714">Ensuring good performance</a></span></dt><dt><span class="section"><a href="#id275752">Ensuring reliability</a></span></dt><dd><dl><dt><span class="section"><a href="#id275757">Checking the repository for corruption</a></span></dt><dt><span class="section"><a href="#id275832">Recovering lost changes</a></span></dt></dl></dd></dl></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id274821"></a>Telling git your name</h2></div></div></div><p>Before creating any commits, you should introduce yourself to git. The
easiest way to do so is:</p><div class="literallayout"><p>$ cat >~/.gitconfig <<\EOF<br>
[user]<br>
name = Your Name Comes Here<br>
email = you@yourdomain.example.com<br>
EOF</p></div><p>(See the "CONFIGURATION FILE" section of <a href="git-config.html" target="_top">git-config(1)</a> for
-details on the configuration file.)</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2748
37"></a>Creating a new repository</h2></div></div></div><p>Creating a new repository from scratch is very easy:</p><div class="literallayout"><p>$ mkdir project<br>
+details on the configuration file.)</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2748
53"></a>Creating a new repository</h2></div></div></div><p>Creating a new repository from scratch is very easy:</p><div class="literallayout"><p>$ mkdir project<br>
$ cd project<br>
$ git init</p></div><p>If you have some initial content (say, a tarball):</p><div class="literallayout"><p>$ tar -xzvf project.tar.gz<br>
$ cd project<br>
$ git diff # difference between the index file and your<br>
# working directory; changes that would not<br>
# be included if you ran "commit" now.<br>
-$ git status # a brief per-file summary of the above.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2750
65"></a>creating good commit messages</h2></div></div></div><p>Though not required, it's a good idea to begin the commit message
+$ git status # a brief per-file summary of the above.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2750
80"></a>creating good commit messages</h2></div></div></div><p>Though not required, it's a good idea to begin the commit message
with a single short (less than 50 character) line summarizing the
change, followed by a blank line and then a more thorough
description. Tools that turn commits into email, for example, use
the first line on the Subject line and the rest of the commit in the
-body.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2750
81"></a>how to merge</h2></div></div></div><p>You can rejoin two diverging branches of development using
+body.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2750
96"></a>how to merge</h2></div></div></div><p>You can rejoin two diverging branches of development using
<a href="git-merge.html" target="_top">git-merge(1)</a>:</p><div class="literallayout"><p>$ git merge branchname</p></div><p>merges the development in the branch "branchname" into the current
branch. If there are conflicts—for example, if the same file is
modified in two different ways in the remote branch and the local
some information about the merge. Normally you can just use this
default message unchanged, but you may add additional commentary of
your own if desired.</p><p>The above is all you need to know to resolve a simple merge. But git
-also provides more information to help resolve conflicts:</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2752
17"></a>Getting conflict-resolution help during a merge</h3></div></div></div><p>All of the changes that git was able to merge automatically are
+also provides more information to help resolve conflicts:</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2752
33"></a>Getting conflict-resolution help during a merge</h3></div></div></div><p>All of the changes that git was able to merge automatically are
already added to the index file, so <a href="git-diff.html" target="_top">git-diff(1)</a> shows only
the conflicts. It uses an unusual syntax:</p><div class="literallayout"><p>$ git diff<br>
diff --cc file.txt<br>
away, you can always return to the pre-merge state with</p><div class="literallayout"><p>$ git reset --hard HEAD</p></div><p>Or, if you've already commited the merge that you want to throw away,</p><div class="literallayout"><p>$ git reset --hard ORIG_HEAD</p></div><p>However, this last command can be dangerous in some cases—never
throw away a commit you have already committed if that commit may
itself have been merged into another branch, as doing so may confuse
-further merges.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2754
26"></a>Fast-forward merges</h2></div></div></div><p>There is one special case not mentioned above, which is treated
+further merges.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2754
42"></a>Fast-forward merges</h2></div></div></div><p>There is one special case not mentioned above, which is treated
differently. Normally, a merge results in a merge commit, with two
parents, one pointing at each of the two lines of development that
were merged.</p><p>However, if one of the two lines of development is completely
already contained in the other—then git just performs a
<a href="#fast-forwards" title="Understanding git history: fast-forwards">fast forward</a>; the head of the current branch is
moved forward to point at the head of the merged-in branch, without
-any new commits being created.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2754
55"></a>Fixing mistakes</h2></div></div></div><p>If you've messed up the working tree, but haven't yet committed your
+any new commits being created.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2754
70"></a>Fixing mistakes</h2></div></div></div><p>If you've messed up the working tree, but haven't yet committed your
mistake, you can return the entire working tree to the last committed
state with</p><div class="literallayout"><p>$ git reset --hard HEAD</p></div><p>If you make a commit that you later wish you hadn't, there are two
fundamentally different ways to fix the problem:</p><div class="orderedlist"><ol type="1"><li>
git does not normally expect the "history" of a project to
change, and cannot correctly perform repeated merges from
a branch that has had its history changed.
-</li></ol></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2755
08"></a>Fixing a mistake with a new commit</h3></div></div></div><p>Creating a new commit that reverts an earlier change is very easy;
+</li></ol></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2755
23"></a>Fixing a mistake with a new commit</h3></div></div></div><p>Creating a new commit that reverts an earlier change is very easy;
just pass the <a href="git-revert.html" target="_top">git-revert(1)</a> command a reference to the bad
commit; for example, to revert the most recent commit:</p><div class="literallayout"><p>$ git revert HEAD</p></div><p>This will create a new commit which undoes the change in HEAD. You
will be given a chance to edit the commit message for the new commit.</p><p>You can also revert an earlier change, for example, the next-to-last:</p><div class="literallayout"><p>$ git revert HEAD^</p></div><p>In this case git will attempt to undo the old change while leaving
been merged into another branch; use <a href="git-revert.html" target="_top">git-revert(1)</a> instead in
that case.</p><p>It is also possible to edit commits further back in the history, but
this is an advanced topic to be left for
-<a href="#cleaning-up-history" title="Chapter 6. Rewriting history and maintaining patch series">another chapter</a>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2756
40"></a>Checking out an old version of a file</h3></div></div></div><p>In the process of undoing a previous bad change, you may find it
+<a href="#cleaning-up-history" title="Chapter 6. Rewriting history and maintaining patch series">another chapter</a>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2756
56"></a>Checking out an old version of a file</h3></div></div></div><p>In the process of undoing a previous bad change, you may find it
useful to check out an older version of a particular file using
<a href="git-checkout.html" target="_top">git-checkout(1)</a>. We've used git checkout before to switch
branches, but it has quite different behavior if it is given a path
name: the command</p><div class="literallayout"><p>$ git checkout HEAD^ path/to/file</p></div><p>replaces path/to/file by the contents it had in the commit HEAD^, and
also updates the index to match. It does not change branches.</p><p>If you just want to look at an old version of the file, without
modifying the working directory, you can do that with
-<a href="git-show.html" target="_top">git-show(1)</a>:</p><div class="literallayout"><p>$ git show HEAD^:path/to/file</p></div><p>which will display the given version of the file.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id275
699"></a>Ensuring good performance</h2></div></div></div><p>On large repositories, git depends on compression to keep the history
+<a href="git-show.html" target="_top">git-show(1)</a>:</p><div class="literallayout"><p>$ git show HEAD^:path/to/file</p></div><p>which will display the given version of the file.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id275
714"></a>Ensuring good performance</h2></div></div></div><p>On large repositories, git depends on compression to keep the history
information from taking up to much space on disk or in memory.</p><p>This compression is not performed automatically. Therefore you
should occasionally run <a href="git-gc.html" target="_top">git-gc(1)</a>:</p><div class="literallayout"><p>$ git gc</p></div><p>to recompress the archive. This can be very time-consuming, so
-you may prefer to run git-gc when you are not doing other work.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2757
36"></a>Ensuring reliability</h2></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id275742"></a>Checking the repository for corruption</h3></div></div></div><p>The <a href="git-fsck.html" target="_top">git-fsck(1)</a> command runs a number of self-consistency checks
+you may prefer to run git-gc when you are not doing other work.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2757
52"></a>Ensuring reliability</h2></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id275757"></a>Checking the repository for corruption</h3></div></div></div><p>The <a href="git-fsck.html" target="_top">git-fsck(1)</a> command runs a number of self-consistency checks
on the repository, and reports on any problems. This may take some
time. The most common warning by far is about "dangling" objects:</p><div class="literallayout"><p>$ git fsck<br>
dangling commit 7281251ddd2a61e38657c827739c57015671a6b3<br>
you can remove them at any time with <a href="git-prune.html" target="_top">git-prune(1)</a> or the —prune
option to <a href="git-gc.html" target="_top">git-gc(1)</a>:</p><div class="literallayout"><p>$ git gc --prune</p></div><p>This may be time-consuming. Unlike most other git operations (including
git-gc when run without any options), it is not safe to prune while
-other git operations are in progress in the same repository.</p><p>For more about dangling objects, see <a href="#dangling-objects" title="Dangling objects">the section called “Dangling objects”</a>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2758
17"></a>Recovering lost changes</h3></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id275822"></a>Reflogs</h4></div></div></div><p>Say you modify a branch with <a href="git-reset.html" target="_top">git-reset(1)</a> —hard, and then
+other git operations are in progress in the same repository.</p><p>For more about dangling objects, see <a href="#dangling-objects" title="Dangling objects">the section called “Dangling objects”</a>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2758
32"></a>Recovering lost changes</h3></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id275838"></a>Reflogs</h4></div></div></div><p>Say you modify a branch with <a href="git-reset.html" target="_top">git-reset(1)</a> —hard, and then
realize that the branch was the only reference you had to that point in
history.</p><p>Fortunately, git also keeps a log, called a "reflog", of all the
previous values of each branch. So in this case you can still find the
section of <a href="git-rev-parse.html" target="_top">git-rev-parse(1)</a> for details.</p><p>Note that the reflog history is very different from normal git history.
While normal history is shared by every repository that works on the
same project, the reflog history is not shared: it tells you only about
-how the branches in your local repository have changed over time.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id2759
00"></a>Examining dangling objects</h4></div></div></div><p>In some situations the reflog may not be able to save you. For
+how the branches in your local repository have changed over time.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id2759
16"></a>Examining dangling objects</h4></div></div></div><p>In some situations the reflog may not be able to save you. For
example, suppose you delete a branch, then realize you need the history
it contained. The reflog is also deleted; however, if you have not
yet pruned the repository, then you may still be able to find
(And notice that it might not be just one commit: we only report the
"tip of the line" as being dangling, but there might be a whole deep
and complex commit history that was dropped.)</p><p>If you decide you want the history back, you can always create a new
-reference pointing to it, for example, a new branch:</p><div class="literallayout"><p>$ git branch recovered-branch 7281251ddd</p></div></div></div></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id2759
67"></a>Chapter 5. Sharing development with others</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#getting-updates-with-git-pull">Getting updates with git pull</a></span></dt><dt><span class="section"><a href="#id276098">Submitting patches to a project</a></span></dt><dt><span class="section"><a href="#id276148">Importing patches to a project</a></span></dt><dt><span class="section"><a href="#setting-up-a-public-repository">Setting up a public repository</a></span></dt><dt><span class="section"><a href="#exporting-via-http">Exporting a git repository via http</a></span></dt><dt><span class="section"><a href="#exporting-via-git">Exporting a git repository via the git protocol</a></span></dt><dt><span class="section"><a href="#pushing-changes-to-a-public-repository">Pushing changes to a public repository</a></span></dt><dt><span class="section"><a href="#id276559">Setting up a shared repository</a></span></dt><dt><span class="section"><a href="#id276578">Allow web browsing of a repository</a></span></dt><dt><span class="section"><a href="#id276591">Examples</a></span></dt></dl></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="getting-updates-with-git-pull"></a>Getting updates with git pull</h2></div></div></div><p>After you clone a repository and make a few changes of your own, you
+reference pointing to it, for example, a new branch:</p><div class="literallayout"><p>$ git branch recovered-branch 7281251ddd</p></div></div></div></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id2759
82"></a>Chapter 5. Sharing development with others</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#getting-updates-with-git-pull">Getting updates with git pull</a></span></dt><dt><span class="section"><a href="#id276114">Submitting patches to a project</a></span></dt><dt><span class="section"><a href="#id276163">Importing patches to a project</a></span></dt><dt><span class="section"><a href="#setting-up-a-public-repository">Setting up a public repository</a></span></dt><dt><span class="section"><a href="#exporting-via-http">Exporting a git repository via http</a></span></dt><dt><span class="section"><a href="#exporting-via-git">Exporting a git repository via the git protocol</a></span></dt><dt><span class="section"><a href="#pushing-changes-to-a-public-repository">Pushing changes to a public repository</a></span></dt><dt><span class="section"><a href="#id276576">Setting up a shared repository</a></span></dt><dt><span class="section"><a href="#id276595">Allow web browsing of a repository</a></span></dt><dt><span class="section"><a href="#id276608">Examples</a></span></dt></dl></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="getting-updates-with-git-pull"></a>Getting updates with git pull</h2></div></div></div><p>After you clone a repository and make a few changes of your own, you
may wish to check the original repository for updates and merge them
into your own work.</p><p>We have already seen <a href="#Updating-a-repository-with-git-fetch" title="Updating a repository with git fetch">how to keep remote tracking branches up to date</a> with <a href="git-fetch.html" target="_top">git-fetch(1)</a>,
and how to merge two branches. So you can merge in changes from the
updated to point to the latest commit from the upstream branch.)</p><p>The git-pull command can also be given "." as the "remote" repository,
in which case it just merges in a branch from the current repository; so
the commands</p><div class="literallayout"><p>$ git pull . branch<br>
-$ git merge branch</p></div><p>are roughly equivalent. The former is actually very commonly used.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id276
098"></a>Submitting patches to a project</h2></div></div></div><p>If you just have a few changes, the simplest way to submit them may
+$ git merge branch</p></div><p>are roughly equivalent. The former is actually very commonly used.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id276
114"></a>Submitting patches to a project</h2></div></div></div><p>If you just have a few changes, the simplest way to submit them may
just be to send them as patches in email:</p><p>First, use <a href="git-format-patch.html" target="_top">git-format-patch(1)</a>; for example:</p><div class="literallayout"><p>$ git format-patch origin</p></div><p>will produce a numbered series of files in the current directory, one
for each patch in the current branch but not in origin/HEAD.</p><p>You can then import these into your mail client and send them by
hand. However, if you have a lot to send at once, you may prefer to
use the <a href="git-send-email.html" target="_top">git-send-email(1)</a> script to automate the process.
Consult the mailing list for your project first to determine how they
-prefer such patches be handled.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2761
48"></a>Importing patches to a project</h2></div></div></div><p>Git also provides a tool called <a href="git-am.html" target="_top">git-am(1)</a> (am stands for
+prefer such patches be handled.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2761
63"></a>Importing patches to a project</h2></div></div></div><p>Git also provides a tool called <a href="git-am.html" target="_top">git-am(1)</a> (am stands for
"apply mailbox"), for importing such an emailed series of patches.
Just save all of the patch-containing messages, in order, into a
single mailbox file, say "patches.mbox", then run</p><div class="literallayout"><p>$ git am -3 patches.mbox</p></div><p>Git will apply each patch in order; if any conflicts are found, it
then you can just pull changes from each other's repositories
directly; note that all of the commands (<a href="git-clone.html" target="_top">git-clone(1)</a>,
git-fetch[1], git-pull[1], etc.) that accept a URL as an argument
-will also accept a local file patch; so, for example, you can
+will also accept a local directory name; so, for example, you can
use</p><div class="literallayout"><p>$ git clone /path/to/repository<br>
$ git pull /path/to/other/repository</p></div><p>If this sort of setup is inconvenient or impossible, another (more
common) option is to set up a public repository on a public server.
url = ssh://yourserver.com/~you/proj.git<br>
EOF</p></div><p>you should be able to perform the above push with just</p><div class="literallayout"><p>$ git push public-repo master</p></div><p>See the explanations of the remote.<name>.url, branch.<name>.remote,
and remote.<name>.push options in <a href="git-config.html" target="_top">git-config(1)</a> for
-details.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2765
59"></a>Setting up a shared repository</h2></div></div></div><p>Another way to collaborate is by using a model similar to that
+details.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2765
76"></a>Setting up a shared repository</h2></div></div></div><p>Another way to collaborate is by using a model similar to that
commonly used in CVS, where several developers with special rights
all push to and pull from a single shared repository. See
<a href="cvs-migration.txt" target="_top">git for CVS users</a> for instructions on how to
-set this up.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2765
78"></a>Allow web browsing of a repository</h2></div></div></div><p>The gitweb cgi script provides users an easy way to browse your
+set this up.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2765
95"></a>Allow web browsing of a repository</h2></div></div></div><p>The gitweb cgi script provides users an easy way to browse your
project's files and history without having to install git; see the file
-gitweb/README in the git source tree for instructions on setting it up.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id276
591"></a>Examples</h2></div></div></div><p>TODO: topic branches, typical roles as in everyday.txt, ?</p></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="cleaning-up-history"></a>Chapter 6. Rewriting history and maintaining patch series</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id276623">Creating the perfect patch series</a></span></dt><dt><span class="section"><a href="#id276698">Keeping a patch series up to date using git-rebase</a></span></dt><dt><span class="section"><a href="#id276828">Modifying a single commit</a></span></dt><dt><span class="section"><a href="#id276918">Reordering or selecting from a patch series</a></span></dt><dt><span class="section"><a href="#id276978">Other tools</a></span></dt><dt><span class="section"><a href="#id276991">Problems with rewriting history</a></span></dt></dl></div><p>Normally commits are only added to a project, never taken away or
+gitweb/README in the git source tree for instructions on setting it up.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id276
608"></a>Examples</h2></div></div></div><p>TODO: topic branches, typical roles as in everyday.txt, ?</p></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="cleaning-up-history"></a>Chapter 6. Rewriting history and maintaining patch series</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id276640">Creating the perfect patch series</a></span></dt><dt><span class="section"><a href="#id276714">Keeping a patch series up to date using git-rebase</a></span></dt><dt><span class="section"><a href="#id276845">Modifying a single commit</a></span></dt><dt><span class="section"><a href="#id276935">Reordering or selecting from a patch series</a></span></dt><dt><span class="section"><a href="#id276995">Other tools</a></span></dt><dt><span class="section"><a href="#id277008">Problems with rewriting history</a></span></dt></dl></div><p>Normally commits are only added to a project, never taken away or
replaced. Git is designed with this assumption, and violating it will
cause git's merge machinery (for example) to do the wrong thing.</p><p>However, there is a situation in which it can be useful to violate this
-assumption.</p><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2766
23"></a>Creating the perfect patch series</h2></div></div></div><p>Suppose you are a contributor to a large project, and you want to add a
+assumption.</p><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2766
40"></a>Creating the perfect patch series</h2></div></div></div><p>Suppose you are a contributor to a large project, and you want to add a
complicated feature, and to present it to the other developers in a way
that makes it easy for them to read your changes, verify that they are
correct, and understand why you made each change.</p><p>If you present all of your changes as a single patch (or commit), they
(probably much messier!) development process did.
</li></ol></div><p>We will introduce some tools that can help you do this, explain how to
use them, and then explain some of the problems that can arise because
-you are rewriting history.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id276
698"></a>Keeping a patch series up to date using git-rebase</h2></div></div></div><p>Suppose that you create a branch "mywork" on a remote-tracking branch
+you are rewriting history.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id276
714"></a>Keeping a patch series up to date using git-rebase</h2></div></div></div><p>Suppose that you create a branch "mywork" on a remote-tracking branch
"origin", and create some commits on top of it:</p><div class="literallayout"><p>$ git checkout -b mywork origin<br>
$ vi file.txt<br>
$ git commit<br>
and allow you to fix the conflicts; after fixing conflicts, use "git
add" to update the index with those contents, and then, instead of
running git-commit, just run</p><div class="literallayout"><p>$ git rebase --continue</p></div><p>and git will continue applying the rest of the patches.</p><p>At any point you may use the —abort option to abort this process and
-return mywork to the state it had before you started the rebase:</p><div class="literallayout"><p>$ git rebase --abort</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2768
28"></a>Modifying a single commit</h2></div></div></div><p>We saw in <a href="#fixing-a-mistake-by-editing-history" title="Fixing a mistake by editing history">the section called “Fixing a mistake by editing history”</a> that you can replace the
+return mywork to the state it had before you started the rebase:</p><div class="literallayout"><p>$ git rebase --abort</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2768
45"></a>Modifying a single commit</h2></div></div></div><p>We saw in <a href="#fixing-a-mistake-by-editing-history" title="Fixing a mistake by editing history">the section called “Fixing a mistake by editing history”</a> that you can replace the
most recent commit using</p><div class="literallayout"><p>$ git commit --amend</p></div><p>which will replace the old commit by a new commit incorporating your
changes, giving you a chance to edit the old commit message first.</p><p>You can also use a combination of this and <a href="git-rebase.html" target="_top">git-rebase(1)</a> to edit
commits further back in your history. First, tag the problematic commit with</p><div class="literallayout"><p>$ git tag bad mywork~5</p></div><p>(Either gitk or git-log may be useful for finding the commit.)</p><p>Then check out a new branch at that commit, edit it, and rebase the rest of
then clean up with</p><div class="literallayout"><p>$ git branch -d TMP<br>
$ git tag -d bad</p></div><p>Note that the immutable nature of git history means that you haven't really
"modified" existing commits; instead, you have replaced the old commits with
-new commits having new object names.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2769
18"></a>Reordering or selecting from a patch series</h2></div></div></div><p>Given one existing commit, the <a href="git-cherry-pick.html" target="_top">git-cherry-pick(1)</a> command
+new commits having new object names.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2769
35"></a>Reordering or selecting from a patch series</h2></div></div></div><p>Given one existing commit, the <a href="git-cherry-pick.html" target="_top">git-cherry-pick(1)</a> command
allows you to apply the change introduced by that commit and create a
new commit that records it. So, for example, if "mywork" points to a
series of patches on top of "origin", you might do something like:</p><div class="literallayout"><p>$ git checkout -b mywork-new origin<br>
—amend.</p><p>Another technique is to use git-format-patch to create a series of
patches, then reset the state to before the patches:</p><div class="literallayout"><p>$ git format-patch origin<br>
$ git reset --hard origin</p></div><p>Then modify, reorder, or eliminate patches as preferred before applying
-them again with <a href="git-am.html" target="_top">git-am(1)</a>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2769
78"></a>Other tools</h2></div></div></div><p>There are numerous other tools, such as stgit, which exist for the
+them again with <a href="git-am.html" target="_top">git-am(1)</a>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2769
95"></a>Other tools</h2></div></div></div><p>There are numerous other tools, such as stgit, which exist for the
purpose of maintaining a patch series. These are outside of the scope of
-this manual.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id27
6991"></a>Problems with rewriting history</h2></div></div></div><p>The primary problem with rewriting the history of a branch has to do
+this manual.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id27
7008"></a>Problems with rewriting history</h2></div></div></div><p>The primary problem with rewriting the history of a branch has to do
with merging. Suppose somebody fetches your branch and merges it into
their branch, with a result something like this:</p><pre class="literallayout"> o--o--O--o--o--o <-- origin
\ \
and it may be useful for others to be able to fetch those branches in
order to examine or test them, but they should not attempt to pull such
branches into their own work.</p><p>For true distributed development that supports proper merging,
-published branches should never be rewritten.</p></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id2770
62"></a>Chapter 7. Advanced branch management</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id277068">Fetching individual branches</a></span></dt><dt><span class="section"><a href="#fast-forwards">Understanding git history: fast-forwards</a></span></dt><dt><span class="section"><a href="#id277188">Forcing git fetch to do non-fast-forward updates</a></span></dt><dt><span class="section"><a href="#id277215">Configuring remote branches</a></span></dt></dl></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id277068"></a>Fetching individual branches</h2></div></div></div><p>Instead of using <a href="git-remote.html" target="_top">git-remote(1)</a>, you can also choose just
+published branches should never be rewritten.</p></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id2770
79"></a>Chapter 7. Advanced branch management</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id277085">Fetching individual branches</a></span></dt><dt><span class="section"><a href="#fast-forwards">Understanding git history: fast-forwards</a></span></dt><dt><span class="section"><a href="#id277205">Forcing git fetch to do non-fast-forward updates</a></span></dt><dt><span class="section"><a href="#id277232">Configuring remote branches</a></span></dt></dl></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id277085"></a>Fetching individual branches</h2></div></div></div><p>Instead of using <a href="git-remote.html" target="_top">git-remote(1)</a>, you can also choose just
to update one branch at a time, and to store it locally under an
arbitrary name:</p><div class="literallayout"><p>$ git fetch origin todo:my-todo-work</p></div><p>The first argument, "origin", just tells git to fetch from the
repository you originally cloned from. The second argument tells git
described in the following section. However, note that in the
situation above this may mean losing the commits labeled "a" and "b",
unless you've already created a reference of your own pointing to
-them.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id277
188"></a>Forcing git fetch to do non-fast-forward updates</h2></div></div></div><p>If git fetch fails because the new head of a branch is not a
+them.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id277
205"></a>Forcing git fetch to do non-fast-forward updates</h2></div></div></div><p>If git fetch fails because the new head of a branch is not a
descendant of the old head, you may force the update with:</p><div class="literallayout"><p>$ git fetch git://example.com/proj.git +master:refs/remotes/example/master</p></div><p>Note the addition of the "+" sign. Be aware that commits that the
old version of example/master pointed at may be lost, as we saw in
-the previous section.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2772
15"></a>Configuring remote branches</h2></div></div></div><p>We saw above that "origin" is just a shortcut to refer to the
+the previous section.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2772
32"></a>Configuring remote branches</h2></div></div></div><p>We saw above that "origin" is just a shortcut to refer to the
repository that you originally cloned from. This information is
stored in git configuration variables, which you can see using
<a href="git-config.html" target="_top">git-config(1)</a>:</p><div class="literallayout"><p>$ git config -l<br>
throwing away commits on mybranch.</p><p>Also note that all of the above configuration can be performed by
directly editing the file .git/config instead of using
<a href="git-config.html" target="_top">git-config(1)</a>.</p><p>See <a href="git-config.html" target="_top">git-config(1)</a> for more details on the configuration
-options mentioned above.</p></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="git-internals"></a>Chapter 8. Git internals</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id2773
53">The Object Database</a></span></dt><dt><span class="section"><a href="#id277469">Blob Object</a></span></dt><dt><span class="section"><a href="#id277512">Tree Object</a></span></dt><dt><span class="section"><a href="#id232240">Commit Object</a></span></dt><dt><span class="section"><a href="#id277705">Trust</a></span></dt><dt><span class="section"><a href="#id277755">Tag Object</a></span></dt><dt><span class="section"><a href="#id277801">The "index" aka "Current Directory Cache"</a></span></dt><dt><span class="section"><a href="#id277877">The Workflow</a></span></dt><dd><dl><dt><span class="section"><a href="#id277895">working directory -> index</a></span></dt><dt><span class="section"><a href="#id277985">index -> object database</a></span></dt><dt><span class="section"><a href="#id278013">object database -> index</a></span></dt><dt><span class="section"><a href="#id278044">index -> working directory</a></span></dt><dt><span class="section"><a href="#id278108">Tying it all together</a></span></dt></dl></dd><dt><span class="section"><a href="#id278202">Examining the data</a></span></dt><dt><span class="section"><a href="#id278280">Merging multiple trees</a></span></dt><dt><span class="section"><a href="#id278368">Merging multiple trees, continued</a></span></dt><dt><span class="section"><a href="#id278628">How git stores objects efficiently: pack files</a></span></dt><dt><span class="section"><a href="#dangling-objects">Dangling objects</a></span></dt></dl></div><p>There are two object abstractions: the "object database", and the
-"current directory cache" aka "index".</p><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2773
53"></a>The Object Database</h2></div></div></div><p>The object database is literally just a content-addressable collection
+options mentioned above.</p></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="git-internals"></a>Chapter 8. Git internals</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id2773
70">The Object Database</a></span></dt><dt><span class="section"><a href="#id277486">Blob Object</a></span></dt><dt><span class="section"><a href="#id277529">Tree Object</a></span></dt><dt><span class="section"><a href="#id232240">Commit Object</a></span></dt><dt><span class="section"><a href="#id277722">Trust</a></span></dt><dt><span class="section"><a href="#id277772">Tag Object</a></span></dt><dt><span class="section"><a href="#id277818">The "index" aka "Current Directory Cache"</a></span></dt><dt><span class="section"><a href="#id277894">The Workflow</a></span></dt><dd><dl><dt><span class="section"><a href="#id277912">working directory -> index</a></span></dt><dt><span class="section"><a href="#id278002">index -> object database</a></span></dt><dt><span class="section"><a href="#id278030">object database -> index</a></span></dt><dt><span class="section"><a href="#id278061">index -> working directory</a></span></dt><dt><span class="section"><a href="#id278125">Tying it all together</a></span></dt></dl></dd><dt><span class="section"><a href="#id278219">Examining the data</a></span></dt><dt><span class="section"><a href="#id278297">Merging multiple trees</a></span></dt><dt><span class="section"><a href="#id278385">Merging multiple trees, continued</a></span></dt><dt><span class="section"><a href="#id278645">How git stores objects efficiently: pack files</a></span></dt><dt><span class="section"><a href="#dangling-objects">Dangling objects</a></span></dt></dl></div><p>There are two object abstractions: the "object database", and the
+"current directory cache" aka "index".</p><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2773
70"></a>The Object Database</h2></div></div></div><p>The object database is literally just a content-addressable collection
of objects. All objects are named by their content, which is
approximated by the SHA1 hash of the object itself. Objects may refer
to other objects (by referencing their SHA1 hash), and so you can
connectivity to other objects verified. This is generally done with
the <code class="literal">git-fsck</code> program, which generates a full dependency graph
of all objects, and verifies their internal consistency (in addition
-to just verifying their superficial consistency through the hash).</p><p>The object types in some more detail:</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2774
69"></a>Blob Object</h2></div></div></div><p>A "blob" object is nothing but a binary blob of data, and doesn't
+to just verifying their superficial consistency through the hash).</p><p>The object types in some more detail:</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2774
86"></a>Blob Object</h2></div></div></div><p>A "blob" object is nothing but a binary blob of data, and doesn't
refer to anything else. There is no signature or any other
verification of the data, so while the object is consistent (it <span class="emphasis"><em>is</em></span>
indexed by its sha1 hash, so the data itself is certainly correct), it
object. The object is totally independent of its location in the
directory tree, and renaming a file does not change the object that
file is associated with in any way.</p><p>A blob is typically created when <a href="git-update-index.html" target="_top">git-update-index(1)</a>
-is run, and its data can be accessed by <a href="git-cat-file.html" target="_top">git-cat-file(1)</a>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2775
12"></a>Tree Object</h2></div></div></div><p>The next hierarchical object type is the "tree" object. A tree object
+is run, and its data can be accessed by <a href="git-cat-file.html" target="_top">git-cat-file(1)</a>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2775
29"></a>Tree Object</h2></div></div></div><p>The next hierarchical object type is the "tree" object. A tree object
is a list of mode/name/blob data, sorted by name. Alternatively, the
mode data may specify a directory mode, in which case instead of
naming a blob, that name is associated with another TREE object.</p><p>Like the "blob" object, a tree object is uniquely determined by the
implicit in the trees involved (the result tree, and the result trees
of the parents), and describing that makes no sense in this idiotic
file manager.</p><p>A commit is created with <a href="git-commit-tree.html" target="_top">git-commit-tree(1)</a> and
-its data can be accessed by <a href="git-cat-file.html" target="_top">git-cat-file(1)</a>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2777
05"></a>Trust</h2></div></div></div><p>An aside on the notion of "trust". Trust is really outside the scope
+its data can be accessed by <a href="git-cat-file.html" target="_top">git-cat-file(1)</a>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2777
22"></a>Trust</h2></div></div></div><p>An aside on the notion of "trust". Trust is really outside the scope
of "git", but it's worth noting a few things. First off, since
everything is hashed with SHA1, you <span class="emphasis"><em>can</em></span> trust that an object is
intact and has not been messed with by external sources. So the name
commits tells others that they can trust the whole history.</p><p>In other words, you can easily validate a whole archive by just
sending out a single email that tells the people the name (SHA1 hash)
of the top commit, and digitally sign that email using something
-like GPG/PGP.</p><p>To assist in this, git also provides the tag object…</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2777
55"></a>Tag Object</h2></div></div></div><p>Git provides the "tag" object to simplify creating, managing and
+like GPG/PGP.</p><p>To assist in this, git also provides the tag object…</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2777
72"></a>Tag Object</h2></div></div></div><p>Git provides the "tag" object to simplify creating, managing and
exchanging symbolic and signed tokens. The "tag" object at its
simplest simply symbolically identifies another object by containing
the sha1, type and symbolic name.</p><p>However it can optionally contain additional signature information
verification) has to come from outside.</p><p>A tag is created with <a href="git-mktag.html" target="_top">git-mktag(1)</a>,
its data can be accessed by <a href="git-cat-file.html" target="_top">git-cat-file(1)</a>,
and the signature can be verified by
-<a href="git-verify-tag.html" target="_top">git-verify-tag(1)</a>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2778
01"></a>The "index" aka "Current Directory Cache"</h2></div></div></div><p>The index is a simple binary file, which contains an efficient
+<a href="git-verify-tag.html" target="_top">git-verify-tag(1)</a>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2778
18"></a>The "index" aka "Current Directory Cache"</h2></div></div></div><p>The index is a simple binary file, which contains an efficient
representation of a virtual directory content at some random time. It
does so by a simple array that associates a set of names, dates,
permissions and content (aka "blob") objects together. The cache is
the index file can have the representation of an intermediate tree that
has not yet been instantiated. So the index can be thought of as a
write-back cache, which can contain dirty information that has not yet
-been written back to the backing store.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2778
77"></a>The Workflow</h2></div></div></div><p>Generally, all "git" operations work on the index file. Some operations
+been written back to the backing store.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2778
94"></a>The Workflow</h2></div></div></div><p>Generally, all "git" operations work on the index file. Some operations
work <span class="strong"><strong>purely</strong></span> on the index file (showing the current state of the
index), but most operations move data to and from the index file. Either
from the database or from the working directory. Thus there are four
-main combinations:</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id277
895"></a>working directory -> index</h3></div></div></div><p>You update the index with information from the working directory with
+main combinations:</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id277
912"></a>working directory -> index</h3></div></div></div><p>You update the index with information from the working directory with
the <a href="git-update-index.html" target="_top">git-update-index(1)</a> command. You
generally update the index information by just specifying the filename
you want to update, like so:</p><div class="literallayout"><p>$ git-update-index filename</p></div><p>but to avoid common mistakes with filename globbing etc, the command
will refresh the "stat" information of each index to match the current
stat information. It will <span class="emphasis"><em>not</em></span> update the object status itself, and
it will only update the fields that are used to quickly test whether
-an object still matches its old backing store object.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id27
7985"></a>index -> object database</h3></div></div></div><p>You write your current index file to a "tree" object with the program</p><div class="literallayout"><p>$ git-write-tree</p></div><p>that doesn't come with any options - it will just write out the
+an object still matches its old backing store object.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id27
8002"></a>index -> object database</h3></div></div></div><p>You write your current index file to a "tree" object with the program</p><div class="literallayout"><p>$ git-write-tree</p></div><p>that doesn't come with any options - it will just write out the
current index into the set of tree objects that describe that state,
and it will return the name of the resulting top-level tree. You can
use that tree to re-generate the index at any time by going in the
-other direction:</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2780
13"></a>object database -> index</h3></div></div></div><p>You read a "tree" file from the object database, and use that to
+other direction:</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2780
30"></a>object database -> index</h3></div></div></div><p>You read a "tree" file from the object database, and use that to
populate (and overwrite - don't do this if your index contains any
unsaved state that you might want to restore later!) your current
index. Normal operation is just</p><div class="literallayout"><p>$ git-read-tree <sha1 of tree></p></div><p>and your index file will now be equivalent to the tree that you saved
earlier. However, that is only your <span class="emphasis"><em>index</em></span> file: your working
-directory contents have not been modified.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2780
44"></a>index -> working directory</h3></div></div></div><p>You update your working directory from the index by "checking out"
+directory contents have not been modified.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2780
61"></a>index -> working directory</h3></div></div></div><p>You update your working directory from the index by "checking out"
files. This is not a very common operation, since normally you'd just
keep your files updated, and rather than write to your working
directory, you'd tell the index files about the changes in your
if you have an old version of the tree already checked out, you will
need to use the "-f" flag (<span class="emphasis"><em>before</em></span> the "-a" flag or the filename) to
<span class="emphasis"><em>force</em></span> the checkout.</p><p>Finally, there are a few odds and ends which are not purely moving
-from one representation to the other:</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2781
08"></a>Tying it all together</h3></div></div></div><p>To commit a tree you have instantiated with "git-write-tree", you'd
+from one representation to the other:</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2781
25"></a>Tying it all together</h3></div></div></div><p>To commit a tree you have instantiated with "git-write-tree", you'd
create a "commit" object that refers to that tree and the history
behind it - most notably the "parent" commits that preceded it in
history.</p><p>Normally a "commit" has one parent: the previous state of the tree
| Working |<br>
| Directory |<br>
+-----------+<br>
-</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2782
02"></a>Examining the data</h2></div></div></div><p>You can examine the data represented in the object database and the
+</p></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2782
19"></a>Examining the data</h2></div></div></div><p>You can examine the data represented in the object database and the
index with various helper tools. For every object, you can use
<a href="git-cat-file.html" target="_top">git-cat-file(1)</a> to examine details about the
object:</p><div class="literallayout"><p>$ git-cat-file -t <objectname></p></div><p>shows the type of the object, and once you have the type (which is
readable form.</p><p>It's especially instructive to look at "commit" objects, since those
tend to be small and fairly self-explanatory. In particular, if you
follow the convention of having the top commit name in <code class="literal">.git/HEAD</code>,
-you can do</p><div class="literallayout"><p>$ git-cat-file commit HEAD</p></div><p>to see what the top commit was.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2782
80"></a>Merging multiple trees</h2></div></div></div><p>Git helps you do a three-way merge, which you can expand to n-way by
+you can do</p><div class="literallayout"><p>$ git-cat-file commit HEAD</p></div><p>to see what the top commit was.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2782
97"></a>Merging multiple trees</h2></div></div></div><p>Git helps you do a three-way merge, which you can expand to n-way by
repeating the merge procedure arbitrary times until you finally
"commit" the state. The normal situation is that you'd only do one
three-way merge (two parents), and commit it, but if you like to, you
always do a merge against your last commit (which should thus match what
you have in your current index anyway).</p><p>To do the merge, do</p><div class="literallayout"><p>$ git-read-tree -m -u <origtree> <yourtree> <targettree></p></div><p>which will do all trivial merge operations for you directly in the
index file, and you can just write the result out with
-<code class="literal">git-write-tree</code>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2783
68"></a>Merging multiple trees, continued</h2></div></div></div><p>Sadly, many merges aren't trivial. If there are files that have
+<code class="literal">git-write-tree</code>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2783
85"></a>Merging multiple trees, continued</h2></div></div></div><p>Sadly, many merges aren't trivial. If there are files that have
been added.moved or removed, or if both branches have modified the
same file, you will be left with an index tree that contains "merge
entries" in it. Such an index tree can <span class="emphasis"><em>NOT</em></span> be written out to a tree
to help you understand what conceptually happens under the hood.
In practice, nobody, not even git itself, uses three <code class="literal">git-cat-file</code>
for this. There is <code class="literal">git-merge-index</code> program that extracts the
-stages to temporary files and calls a "merge" script on it:</p><div class="literallayout"><p>$ git-merge-index git-merge-one-file hello.c</p></div><p>and that is what higher level <code class="literal">git merge -s resolve</code> is implemented with.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2786
28"></a>How git stores objects efficiently: pack files</h2></div></div></div><p>We've seen how git stores each object in a file named after the
+stages to temporary files and calls a "merge" script on it:</p><div class="literallayout"><p>$ git-merge-index git-merge-one-file hello.c</p></div><p>and that is what higher level <code class="literal">git merge -s resolve</code> is implemented with.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2786
45"></a>How git stores objects efficiently: pack files</h2></div></div></div><p>We've seen how git stores each object in a file named after the
object's SHA1 hash.</p><p>Unfortunately this system becomes inefficient once a project has a
lot of objects. Try this on an old project:</p><div class="literallayout"><p>$ git count-objects<br>
6930 objects, 47620 kilobytes</p></div><p>The first number is the number of objects which are kept in
Running it while somebody is actually changing the repository can cause
confusing and scary messages, but it won't actually do anything bad. In
contrast, running "git prune" while somebody is actively changing the
-repository is a <span class="strong"><strong>BAD</strong></span> idea).</p></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id278
888"></a>Chapter 9. Glossary of git terms</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
-alternate object database
+repository is a <span class="strong"><strong>BAD</strong></span> idea).</p></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id278
905"></a>Chapter 9. GIT Glossary</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
+<a name="def_alternate_object_database"></a>alternate object database
</span></dt><dd>
- Via the alternates mechanism, a repository can inherit part of its
- object database from another object database, which is called
- "alternate".
+ Via the alternates mechanism, a <a href="#def_repository">repository</a> can
+ inherit part of its <a href="#def_object_database">object database</a> from another
+ <a href="#def_object_database">object database</a>, which is called "alternate".
</dd><dt><span class="term">
-bare repository
+<a name="def_bare_repository"></a>bare repository
</span></dt><dd>
- A bare repository is normally an appropriately named
- directory with a <code class="literal">.git</code> suffix that does not have a
- locally checked-out copy of any of the files under revision
- control. That is, all of the <code class="literal">git</code> administrative and
- control files that would normally be present in the
- hidden <code class="literal">.git</code> sub-directory are directly present in
- the <code class="literal">repository.git</code> directory instead, and no other files
- are present and checked out. Usually publishers of public
- repositories make bare repositories available.
+ A <a href="#def_bare_repository">bare repository</a> is normally an appropriately
+ named <a href="#def_directory">directory</a> with a <code class="literal">.git</code> suffix that does not
+ have a locally checked-out copy of any of the files under
+ <a href="#def_revision">revision</a> control. That is, all of the <code class="literal">git</code>
+ administrative and control files that would normally be present in the
+ hidden <code class="literal">.git</code> sub-directory are directly present in the
+ <code class="literal">repository.git</code> directory instead,
+ and no other files are present and checked out. Usually publishers of
+ public repositories make bare repositories available.
</dd><dt><span class="term">
-blob object
+<a name="def_blob_object"></a>blob object
</span></dt><dd>
- Untyped object, e.g. the contents of a file.
+ Untyped <a href="#def_object">object</a>, e.g. the contents of a file.
</dd><dt><span class="term">
-branch
+<a name="def_branch"></a>branch
</span></dt><dd>
- A non-cyclical graph of revisions, i.e. the complete history of
- a particular revision, which is called the branch head. The
- branch heads are stored in <code class="literal">$GIT_DIR/refs/heads/</code>.
+ A non-cyclical graph of revisions, i.e. the complete history of a
+ particular <a href="#def_revision">revision</a>, which is called the
+ branch <a href="#def_head">head</a>. The heads
+ are stored in <code class="literal">$GIT_DIR/refs/heads/</code>.
</dd><dt><span class="term">
-cache
+<a name="def_cache"></a>cache
</span></dt><dd>
- Obsolete for: index.
+ Obsolete for: <a href="#def_index">index</a>.
</dd><dt><span class="term">
-chain
+<a name="def_chain"></a>chain
</span></dt><dd>
- 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).
+ A list of objects, where each <a href="#def_object">object</a> in the list contains
+ a reference to its successor (for example, the successor of a
+ <a href="#def_commit">commit</a> could be one of its parents).
</dd><dt><span class="term">
-changeset
+<a name="def_changeset"></a>changeset
</span></dt><dd>
- 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.
+ BitKeeper/cvsps speak for "<a href="#def_commit">commit</a>". Since git does not
+ store changes, but states, it really does not make sense to use the term
+ "changesets" with git.
</dd><dt><span class="term">
-checkout
+<a name="def_checkout"></a>checkout
</span></dt><dd>
- The action of updating the working tree to a revision which was
- stored in the object database.
+ The action of updating the <a href="#def_working_tree">working tree</a> to a
+ <a href="#def_revision">revision</a> which was stored in the
+ <a href="#def_object_database">object database</a>.
</dd><dt><span class="term">
-cherry-picking
+<a name="def_cherry-picking"></a>cherry-picking
</span></dt><dd>
- 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.
+ In <a href="#def_SCM">SCM</a> 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 <a href="#def_commit">commit</a> and to record it based on the tip
+ of the current <a href="#def_branch">branch</a> as a new <a href="#def_commit">commit</a>.
</dd><dt><span class="term">
-clean
+<a name="def_clean"></a>clean
</span></dt><dd>
- A working tree is clean, if it corresponds to the revision
- referenced by the current head. Also see "dirty".
+ A <a href="#def_working_tree">working tree</a> is <a href="#def_clean">clean</a>, if it
+ corresponds to the <a href="#def_revision">revision</a> referenced by the current
+ <a href="#def_head">head</a>. Also see "<a href="#def_dirty">dirty</a>".
</dd><dt><span class="term">
-commit
+<a name="def_commit"></a>commit
</span></dt><dd>
- As a verb: The action of storing the current state of the index in the
- object database. The result is a revision.
- As a noun: Short hand for commit object.
+ As a verb: The action of storing the current state of the
+ <a href="#def_index">index</a> in the <a href="#def_object_database">object database</a>. The
+ result is a <a href="#def_revision">revision</a>. As a noun: Short hand for
+ <a href="#def_commit_object">commit object</a>.
</dd><dt><span class="term">
-commit object
+<a name="def_commit_object"></a>commit object
</span></dt><dd>
- 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.
+ An <a href="#def_object">object</a> which contains the information about a
+ particular <a href="#def_revision">revision</a>, such as parents, committer,
+ author, date and the <a href="#def_tree_object">tree object</a> which corresponds
+ to the top <a href="#def_directory">directory</a> of the stored
+ <a href="#def_revision">revision</a>.
</dd><dt><span class="term">
-core git
+<a name="def_core_git"></a>core git
</span></dt><dd>
- Fundamental data structures and utilities of git. Exposes only
- limited source code management tools.
+ Fundamental data structures and utilities of git. Exposes only limited
+ source code management tools.
</dd><dt><span class="term">
-DAG
+<a name="def_DAG"></a>DAG
</span></dt><dd>
- 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).
+ Directed acyclic graph. The <a href="#def_commit">commit</a> objects form a
+ directed acyclic graph, because they have parents (directed), and the
+ graph of <a href="#def_commit">commit</a> objects is acyclic (there is no
+ <a href="#def_chain">chain</a> which begins and ends with the same
+ <a href="#def_object">object</a>).
</dd><dt><span class="term">
-dangling object
+<a name="def_dangling_object"></a>dangling object
</span></dt><dd>
- An unreachable object which is not reachable even from other
- unreachable objects; a dangling object has no references to it
- from any reference or object in the repository.
+ An <a href="#def_unreachable_object">unreachable object</a> which is not
+ <a href="#def_reachable">reachable</a> even from other unreachable objects; a
+ <a href="#def_dangling_object">dangling object</a> has no references to it from any
+ reference or <a href="#def_object">object</a> in the <a href="#def_repository">repository</a>.
</dd><dt><span class="term">
-dircache
+<a name="def_dircache"></a>dircache
</span></dt><dd>
You are <span class="strong"><strong>waaaaay</strong></span> behind.
</dd><dt><span class="term">
-dirty
+<a name="def_directory"></a>directory
</span></dt><dd>
- A working tree is said to be dirty if it contains modifications
- which have not been committed to the current branch.
+ The list you get with "ls" :-)
</dd><dt><span class="term">
-directory
+<a name="def_dirty"></a>dirty
</span></dt><dd>
- The list you get with "ls" :-)
+ A <a href="#def_working_tree">working tree</a> is said to be <a href="#def_dirty">dirty</a> if
+ it contains modifications which have not been committed to the current
+ <a href="#def_branch">branch</a>.
</dd><dt><span class="term">
-ent
+<a name="def_ent"></a>ent
</span></dt><dd>
- Favorite synonym to "tree-ish" by some total geeks. See
+ Favorite synonym to "<a href="#def_tree-ish">tree-ish</a>" by some total geeks. See
<code class="literal">http://en.wikipedia.org/wiki/Ent_(Middle-earth)</code> for an in-depth
- explanation. Avoid this term, not to confuse people.
+ explanation. Avoid this term, not to confuse people.
</dd><dt><span class="term">
-fast forward
+<a name="def_fast_forward"></a>fast forward
</span></dt><dd>
- A fast-forward is a special type of merge where you have
- a revision and you are "merging" another branch's changes
- 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.
+ A fast-forward is a special type of <a href="#def_merge">merge</a> where you have a
+ <a href="#def_revision">revision</a> and you are "merging" another
+ <a href="#def_branch">branch</a>'s changes that happen to be a descendant of what
+ you have. In such these cases, you do not make a new <a href="#def_merge">merge</a>
+ <a href="#def_commit">commit</a> but instead just update to his
+ <a href="#def_revision">revision</a>. This will happen frequently on a
+ <a href="#def_tracking_branch">tracking branch</a> of a remote
+ <a href="#def_repository">repository</a>.
</dd><dt><span class="term">
-fetch
+<a name="def_fetch"></a>fetch
</span></dt><dd>
- 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.
+ Fetching a <a href="#def_branch">branch</a> means to get the
+ <a href="#def_branch">branch</a>'s <a href="#def_head_ref">head ref</a> from a remote
+ <a href="#def_repository">repository</a>, to find out which objects are missing
+ from the local <a href="#def_object_database">object database</a>, and to get them,
+ too.
</dd><dt><span class="term">
-file system
+<a name="def_file_system"></a>file system
</span></dt><dd>
- Linus Torvalds originally designed git to be a user space file
- system, i.e. the infrastructure to hold files and directories.
- That ensured the efficiency and speed of git.
+ Linus Torvalds originally designed git to be a user space file system,
+ i.e. the infrastructure to hold files and directories. That ensured the
+ efficiency and speed of git.
</dd><dt><span class="term">
-git archive
+<a name="def_git_archive"></a>git archive
</span></dt><dd>
- Synonym for repository (for arch people).
+ Synonym for <a href="#def_repository">repository</a> (for arch people).
</dd><dt><span class="term">
-grafts
+<a name="def_grafts"></a>grafts
</span></dt><dd>
- Grafts enables two otherwise different lines of development to be
- joined together by recording fake ancestry information for commits.
- This way you can make git pretend the set of parents a commit
- has is different from what was recorded when the commit was created.
- Configured via the <code class="literal">.git/info/grafts</code> file.
+ Grafts enables two otherwise different lines of development to be joined
+ together by recording fake ancestry information for commits. This way
+ you can make git pretend the set of parents a <a href="#def_commit">commit</a> has
+ is different from what was recorded when the <a href="#def_commit">commit</a> was
+ created. Configured via the <code class="literal">.git/info/grafts</code> file.
</dd><dt><span class="term">
-hash
+<a name="def_hash"></a>hash
</span></dt><dd>
- In git's context, synonym to object name.
+ In git's context, synonym to <a href="#def_object_name">object name</a>.
</dd><dt><span class="term">
-head
+<a name="def_head"></a>head
</span></dt><dd>
- The top of a branch. It contains a ref to the corresponding
- commit object.
+ The top of a <a href="#def_branch">branch</a>. It contains a <a href="#def_ref">ref</a> to the
+ corresponding <a href="#def_commit_object">commit object</a>.
</dd><dt><span class="term">
-head ref
+<a name="def_head_ref"></a>head ref
</span></dt><dd>
- A ref pointing to a head. Often, this is abbreviated to "head".
- Head refs are stored in <code class="literal">$GIT_DIR/refs/heads/</code>.
+ A <a href="#def_ref">ref</a> pointing to a <a href="#def_head">head</a>. Often, this is
+ abbreviated to "<a href="#def_head">head</a>". Head refs are stored in
+ <code class="literal">$GIT_DIR/refs/heads/</code>.
</dd><dt><span class="term">
-hook
+<a name="def_hook"></a>hook
</span></dt><dd>
- During the normal execution of several git commands,
- 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 <code class="literal">$GIT_DIR/hooks/</code> directory,
- and are enabled by simply making them executable.
+ During the normal execution of several git commands, 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 <a href="#def_hook">hook</a> scripts are found in the
+ <code class="literal">$GIT_DIR/hooks/</code> <a href="#def_directory">directory</a>, and are enabled by simply
+ making them executable.
</dd><dt><span class="term">
-index
+<a name="def_index"></a>index
</span></dt><dd>
- 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.
+ A collection of files with stat information, whose contents are stored
+ as objects. The <a href="#def_index">index</a> is a stored version of your working
+ <a href="#def_tree">tree</a>. Truth be told, it can also contain a second, and even
+ a third version of a <a href="#def_working_tree">working tree</a>, which are used
+ when merging.
</dd><dt><span class="term">
-index entry
+<a name="def_index_entry"></a>index entry
</span></dt><dd>
- 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).
+ The information regarding a particular file, stored in the
+ <a href="#def_index">index</a>. An <a href="#def_index_entry">index entry</a> can be unmerged,
+ if a <a href="#def_merge">merge</a> was started, but not yet finished (i.e. if the
+ <a href="#def_index">index</a> contains multiple versions of that file).
</dd><dt><span class="term">
-master
+<a name="def_master"></a>master
</span></dt><dd>
- The default development branch. Whenever you create a git
- repository, a branch named "master" is created, and becomes
- the active branch. In most cases, this contains the local
+ The default development <a href="#def_branch">branch</a>. Whenever you create a git
+ <a href="#def_repository">repository</a>, a <a href="#def_branch">branch</a> named
+ "<a href="#def_master">master</a>" is created, and becomes the active
+ <a href="#def_branch">branch</a>. In most cases, this contains the local
development, though that is purely conventional and not required.
</dd><dt><span class="term">
-merge
+<a name="def_merge"></a>merge
</span></dt><dd>
- 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.
+ To <a href="#def_merge">merge</a> branches means to try to accumulate the changes
+ since a common ancestor and apply them to the first
+ <a href="#def_branch">branch</a>. An automatic <a href="#def_merge">merge</a> uses heuristics
+ to accomplish that. Evidently, an automatic <a href="#def_merge">merge</a> can
+ fail.
</dd><dt><span class="term">
-object
+<a name="def_object"></a>object
</span></dt><dd>
- The unit of storage in git. It is uniquely identified by
- the SHA1 of its contents. Consequently, an object can not
- be changed.
+ The unit of storage in git. It is uniquely identified by the
+ <a href="#def_SHA1">SHA1</a> of its contents. Consequently, an
+ <a href="#def_object">object</a> can not be changed.
</dd><dt><span class="term">
-object database
+<a name="def_object_database"></a>object database
</span></dt><dd>
- Stores a set of "objects", and an individual object is identified
- by its object name. The objects usually live in <code class="literal">$GIT_DIR/objects/</code>.
+ Stores a set of "objects", and an individual <a href="#def_object">object</a> is
+ identified by its <a href="#def_object_name">object name</a>. The objects usually
+ live in <code class="literal">$GIT_DIR/objects/</code>.
</dd><dt><span class="term">
-object identifier
+<a name="def_object_identifier"></a>object identifier
</span></dt><dd>
- Synonym for object name.
+ Synonym for <a href="#def_object_name">object name</a>.
</dd><dt><span class="term">
-object name
+<a name="def_object_name"></a>object name
</span></dt><dd>
- 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).
+ The unique identifier of an <a href="#def_object">object</a>. The <a href="#def_hash">hash</a>
+ of the <a href="#def_object">object</a>'s contents using the Secure Hash Algorithm
+ 1 and usually represented by the 40 character hexadecimal encoding of
+ the <a href="#def_hash">hash</a> of the <a href="#def_object">object</a> (possibly followed by
+ a white space).
</dd><dt><span class="term">
-object type
+<a name="def_object_type"></a>object type
</span></dt><dd>
- One of the identifiers "commit","tree","tag" and "blob" describing
- the type of an object.
+ One of the identifiers
+ "<a href="#def_commit">commit</a>","<a href="#def_tree">tree</a>","<a href="#def_tag">tag</a>" or "<a href="#def_blob_object">blob</a>"
+ describing the type of an <a href="#def_object">object</a>.
</dd><dt><span class="term">
-octopus
+<a name="def_octopus"></a>octopus
</span></dt><dd>
- To merge more than two branches. Also denotes an intelligent
- predator.
+ To <a href="#def_merge">merge</a> more than two branches. Also denotes an
+ intelligent predator.
</dd><dt><span class="term">
-origin
+<a name="def_origin"></a>origin
</span></dt><dd>
- The default upstream repository. Most projects have at
- least one upstream project which they track. By default
- <span class="emphasis"><em>origin</em></span> is used for that purpose. New upstream updates
+ The default upstream <a href="#def_repository">repository</a>. Most projects have
+ at least one upstream project which they track. By default
+ <span class="emphasis"><em><a href="#def_origin">origin</a></em></span> is used for that purpose. New upstream updates
will be fetched into remote tracking branches named
origin/name-of-upstream-branch, which you can see using
- "git branch -r".
+ "git <a href="#def_branch">branch</a> -r".
</dd><dt><span class="term">
-pack
+<a name="def_pack"></a>pack
</span></dt><dd>
- A set of objects which have been compressed into one file (to save
- space or to transmit them efficiently).
+ A set of objects which have been compressed into one file (to save space
+ or to transmit them efficiently).
</dd><dt><span class="term">
-pack index
+<a name="def_pack_index"></a>pack index
</span></dt><dd>
The list of identifiers, and other information, of the objects in a
- pack, to assist in efficiently accessing the contents of a pack.
+ <a href="#def_pack">pack</a>, to assist in efficiently accessing the contents of a
+ <a href="#def_pack">pack</a>.
</dd><dt><span class="term">
-parent
+<a name="def_parent"></a>parent
</span></dt><dd>
- A commit object contains a (possibly empty) list of the logical
- predecessor(s) in the line of development, i.e. its parents.
+ A <a href="#def_commit_object">commit object</a> contains a (possibly empty) list
+ of the logical predecessor(s) in the line of development, i.e. its
+ parents.
</dd><dt><span class="term">
-pickaxe
+<a name="def_pickaxe"></a>pickaxe
</span></dt><dd>
- The term pickaxe refers to an option to the diffcore routines
- that help select changes that add or delete a given text string.
- 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 <a href="git-diff.html" target="_top">git-diff(1)</a>.
+ The term <a href="#def_pickaxe">pickaxe</a> refers to an option to the diffcore
+ routines that help select changes that add or delete a given text
+ string. With the —pickaxe-all option, it can be used to view the full
+ <a href="#def_changeset">changeset</a> that introduced or removed, say, a
+
particular line of text. See <a href="git-diff.html" target="_top">git-diff(1)</a>.
</dd><dt><span class="term">
-plumbing
+<a name="def_plumbing"></a>plumbing
</span></dt><dd>
- Cute name for core git.
+ Cute name for <a href="#def_core_git">core git</a>.
</dd><dt><span class="term">
-porcelain
+<a name="def_porcelain"></a>porcelain
</span></dt><dd>
- 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.
+ Cute name for programs and program suites depending on
+ <a href="#def_core_git">core git</a>, presenting a high level access to
+ <a href="#def_core_git">core git</a>. Porcelains expose more of a <a href="#def_SCM">SCM</a>
+ interface than the <a href="#def_plumbing">plumbing</a>.
</dd><dt><span class="term">
-pull
+<a name="def_pull"></a>pull
</span></dt><dd>
- Pulling a branch means to fetch it and merge it.
+ Pulling a <a href="#def_branch">branch</a> means to <a href="#def_fetch">fetch</a> it and
+ <a href="#def_merge">merge</a> it.
</dd><dt><span class="term">
-push
+<a name="def_push"></a>push
</span></dt><dd>
- 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.
+ Pushing a <a href="#def_branch">branch</a> means to get the <a href="#def_branch">branch</a>'s
+ <a href="#def_head_ref">head ref</a> from a remote <a href="#def_repository">repository</a>,
+ find out if it is an ancestor to the <a href="#def_branch">branch</a>'s local
+ <a href="#def_head_ref">head ref</a> is a direct, and in that case, putting all
+ objects, which are <a href="#def_reachable">reachable</a> from the local
+ <a href="#def_head_ref">head ref</a>, and which are missing from the remote
+ <a href="#def_repository">repository</a>, into the remote
+ <a href="#def_object_database">object database</a>, and updating the remote
+ <a href="#def_head_ref">head ref</a>. If the remote <a href="#def_head">head</a> is not an
+ ancestor to the local <a href="#def_head">head</a>, the <a href="#def_push">push</a> fails.
</dd><dt><span class="term">
-reachable
+<a name="def_reachable"></a>reachable
</span></dt><dd>
- All of the ancestors of a given commit are said to be reachable from
- that commit. More generally, one object is reachable from another if
- we can reach the one from the other by a chain that follows tags to
- whatever they tag, commits to their parents or trees, and trees to the
- trees or blobs that they contain.
+ All of the ancestors of a given <a href="#def_commit">commit</a> are said to be
+ <a href="#def_reachable">reachable</a> from that <a href="#def_commit">commit</a>. More
+ generally, one <a href="#def_object">object</a> is <a href="#def_reachable">reachable</a> from
+ another if we can reach the one from the other by a <a href="#def_chain">chain</a>
+ that follows <a href="#def_tag">tags</a> to whatever they tag,
+ <a href="#def_commit_object">commits</a> to their parents or trees, and
+ <a href="#def_tree_object">trees</a> to the trees or <a href="#def_blob_object">blobs</a>
+ that they contain.
</dd><dt><span class="term">
-rebase
+<a name="def_rebase"></a>rebase
</span></dt><dd>
- To clean a branch by starting from the head of the main line of
- development ("master"), and reapply the (possibly cherry-picked)
- changes from that branch.
+ To reapply a series of changes from a <a href="#def_branch">branch</a> to a
+ different base, and reset the <a href="#def_head">head</a> of that branch
+ to the result.
</dd><dt><span class="term">
-ref
+<a name="def_ref"></a>ref
</span></dt><dd>
- A 40-byte hex representation of a SHA1 or a name that denotes
- a particular object. These may be stored in <code class="literal">$GIT_DIR/refs/</code>.
+ A 40-byte hex representation of a <a href="#def_SHA1">SHA1</a> or a name that
+ denotes a particular <a href="#def_object">object</a>. These may be stored in
+ <code class="literal">$GIT_DIR/refs/</code>.
</dd><dt><span class="term">
-refspec
+<a name="def_refspec"></a>refspec
</span></dt><dd>
- 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:
- <code class="literal">git fetch $URL refs/heads/master:refs/heads/origin</code>
- means "grab the master branch head from the $URL and store
- it as my origin branch head".
- And <code class="literal">git push $URL refs/heads/master:refs/heads/to-upstream</code>
- means "publish my master branch head as to-upstream branch
- at $URL". See also <a href="git-push.html" target="_top">git-push(1)</a>
+ A <a href="#def_refspec">refspec</a> is used by <a href="#def_fetch">fetch</a> and
+ <a href="#def_push">push</a> to describe the mapping between remote <a href="#def_ref">ref</a>
+ and local <a href="#def_ref">ref</a>. They are combined with a colon in the format
+ <src>:<dst>, preceded by an optional plus sign, +. For example: <code class="literal">git
+ fetch $URL refs/heads/master:refs/heads/origin</code> means
+ "grab the master <a href="#def_branch">branch</a> <a href="#def_head">head</a>
+ from the $URL and store it as my origin
+ <a href="#def_branch">branch</a> <a href="#def_head">head</a>". And <code class="literal">git <a href="#def_push">push</a>
+ $URL refs/heads/master:refs/heads/to-upstream</code> means
+ "publish my master <a href="#def_branch">branch</a>
+ <a href="#def_head">head</a> as to-upstream <a href="#def_branch">branch</a> at $URL". See
+ also <a href="git-push.html" target="_top">git-push(1)</a>
</dd><dt><span class="term">
-repository
+<a name="def_repository"></a>repository
</span></dt><dd>
- 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.
+ A collection of refs together with an <a href="#def_object_database">object database</a> containing all objects which are <a href="#def_reachable">reachable</a>
+ from the refs, possibly accompanied by meta data from one or more
+ porcelains. A <a href="#def_repository">repository</a> can share an
+ <a href="#def_object_database">object database</a> with other repositories.
</dd><dt><span class="term">
-resolve
+<a name="def_resolve"></a>resolve
</span></dt><dd>
- The action of fixing up manually what a failed automatic merge
- left behind.
+ The action of fixing up manually what a failed automatic
+ <a href="#def_merge">merge</a> left behind.
</dd><dt><span class="term">
-revision
+<a name="def_revision"></a>revision
</span></dt><dd>
- A particular state of files and directories which was stored in
- the object database. It is referenced by a commit object.
+ A particular state of files and directories which was stored in the
+ <a href="#def_object_database">object database</a>. It is referenced by a
+ <a href="#def_commit_object">commit object</a>.
</dd><dt><span class="term">
-rewind
+<a name="def_rewind"></a>rewind
</span></dt><dd>
- To throw away part of the development, i.e. to assign the head to
- an earlier revision.
+ To throw away part of the development, i.e. to assign the
+ <a href="#def_head">head</a> to an earlier <a href="#def_revision">revision</a>.
</dd><dt><span class="term">
-SCM
+<a name="def_SCM"></a>SCM
</span></dt><dd>
Source code management (tool).
</dd><dt><span class="term">
-SHA1
+<a name="def_SHA1"></a>SHA1
</span></dt><dd>
- Synonym for object name.
+ Synonym for <a href="#def_object_name">object name</a>.
</dd><dt><span class="term">
-shallow repository
+<a name="def_shallow_repository"></a>shallow repository
</span></dt><dd>
- A shallow repository has an incomplete history some of
- whose commits have parents cauterized away (in other
- words, git is told to pretend that these commits do not
- have the parents, even though they are recorded in the
- commit object). This is sometimes useful when you are
- interested only in the recent history of a project even
- though the real history recorded in the upstream is
- much larger. A shallow repository is created by giving
- <code class="literal">—depth</code> option to <a href="git-clone.html" target="_top">git-clone(1)</a>, and its
- history can be later deepened with <a href="git-fetch.html" target="_top">git-fetch(1)</a>.
+ A <a href="#def_shallow_repository">shallow repository</a> has an incomplete
+ history some of whose commits have parents cauterized away (in other
+ words, git is told to pretend that these commits do not have the
+ parents, even though they are recorded in the <a href="#def_commit_object">commit object</a>). This is sometimes useful when you are interested only in the
+ recent history of a project even though the real history recorded in the
+ upstream is much larger. A <a href="#def_shallow_repository">shallow repository</a>
+ is created by giving the <code class="literal">—depth</code> option to <a href="git-clone.html" target="_top">git-clone(1)</a>, and
+ its history can be later deepened with <a href="git-fetch.html" target="_top">git-fetch(1)</a>.
</dd><dt><span class="term">
-symref
+<a name="def_symref"></a>symref
</span></dt><dd>
- Symbolic reference: instead of containing the SHA1 id itself, it
- is of the format <span class="emphasis"><em>ref: refs/some/thing</em></span> and when referenced, it
- recursively dereferences to this reference. <span class="emphasis"><em>HEAD</em></span> is a prime
- example of a symref. Symbolic references are manipulated with
- the <a href="git-symbolic-ref.html" target="_top">git-symbolic-ref(1)</a> command.
+ Symbolic reference: instead of containing the <a href="#def_SHA1">SHA1</a> id
+ itself, it is of the format <span class="emphasis"><em>ref: refs/some/thing</em></span> and when
+ referenced, it recursively dereferences to this reference. <span class="emphasis"><em>HEAD</em></span> is a
+ prime example of a <a href="#def_symref">symref</a>. Symbolic references are
+
manipulated with the <a href="git-symbolic-ref.html" target="_top">git-symbolic-ref(1)</a> command.
</dd><dt><span class="term">
-topic branch
+<a name="def_tag"></a>tag
</span></dt><dd>
- 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.
+ A <a href="#def_ref">ref</a> pointing to a <a href="#def_tag">tag</a> or
+ <a href="#def_commit_object">commit object</a>. In contrast to a <a href="#def_head">head</a>,
+ a tag is not changed by a <a href="#def_commit">commit</a>. Tags (not
+ <a href="#def_tag_object">tag objects</a>) are stored in <code class="literal">$GIT_DIR/refs/tags/</code>. A
+ git tag has nothing to do with a Lisp tag (which would be
+ called an <a href="#def_object_type">object type</a> in git's context). A
+ tag is most typically used to mark a particular point in the
+ <a href="#def_commit">commit</a> ancestry <a href="#def_chain">chain</a>.
</dd><dt><span class="term">
-tracking branch
+<a name="def_tag_object"></a>tag object
</span></dt><dd>
- 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.
+ An <a href="#def_object">object</a> containing a <a href="#def_ref">ref</a> pointing to
+ another <a href="#def_object">object</a>, which can contain a message just like a
+ <a href="#def_commit_object">commit object</a>. It can also contain a (PGP)
+ signature, in which case it is called a "signed <a href="#def_tag_object">tag object</a>".
</dd><dt><span class="term">
-tree object
+<a name="def_topic_branch"></a>topic branch
</span></dt><dd>
- 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.
+ A regular git <a href="#def_branch">branch</a> 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.
</dd><dt><span class="term">
-tree
+<a name="def_tracking_branch"></a>tracking branch
</span></dt><dd>
- 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).
+ A regular git <a href="#def_branch">branch</a> that is used to follow changes from
+ another <a href="#def_repository">repository</a>. A <a href="#def_tracking_branch">tracking branch</a> should not contain direct modifications or have local commits
+ made to it. A <a href="#def_tracking_branch">tracking branch</a> can usually be
+ identified as the right-hand-side <a href="#def_ref">ref</a> in a Pull:
+ <a href="#def_refspec">refspec</a>.
</dd><dt><span class="term">
-tree-ish
+<a name="def_tree"></a>tree
</span></dt><dd>
- A ref pointing to either a commit object, a tree object, or a
- tag object pointing to a tag or commit or tree object.
+ Either a <a href="#def_working_tree">working tree</a>, or a <a href="#def_tree_object">tree object</a> together with the dependent blob and <a href="#def_tree">tree</a> objects
+ (i.e. a stored representation of a <a href="#def_working_tree">working tree</a>).
</dd><dt><span class="term">
-tag object
+<a name="def_tree_object"></a>tree object
</span></dt><dd>
- 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".
+ An <a href="#def_object">object</a> containing a list of file names and modes along
+ with refs to the associated blob and/or tree objects. A
+ <a href="#def_tree">tree</a> is equivalent to a <a href="#def_directory">directory</a>.
</dd><dt><span class="term">
-tag
+<a name="def_tree-ish"></a>tree-ish
</span></dt><dd>
- 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 <code class="literal">$GIT_DIR/refs/tags/</code>. 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.
+ A <a href="#def_ref">ref</a> pointing to either a <a href="#def_commit_object">commit object</a>, a <a href="#def_tree_object">tree object</a>, or a <a href="#def_tag_object">tag object</a> pointing to a <a href="#def_tag">tag</a> or <a href="#def_commit">commit</a> or
+ <a href="#def_tree_object">tree object</a>.
</dd><dt><span class="term">
-unmerged index
+<a name="def_unmerged_index"></a>unmerged index
</span></dt><dd>
- An index which contains unmerged index entries.
+ An <a href="#def_index">index</a> which contains unmerged
+ <a href="#def_index_entry">index entries</a>.
</dd><dt><span class="term">
-unreachable object
+<a name="def_unreachable_object"></a>unreachable object
</span></dt><dd>
- An object which is not reachable from a branch, tag, or any
- other reference.
+ An <a href="#def_object">object</a> which is not <a href="#def_reachable">reachable</a> from a
+ <a href="#def_branch">branch</a>, <a href="#def_tag">tag</a>, or any other reference.
</dd><dt><span class="term">
-working tree
+<a name="def_working_tree"></a>working tree
</span></dt><dd>
- The set of files and directories currently being worked on,
- i.e. you can work in your working tree without using git at all.
-</dd></dl></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id28
0134"></a>Chapter 10. Notes and todo list for this manual</h2></div></div></div><p>This is a work in progress.</p><p>The basic requirements:
+ The set of files and directories currently being worked on, i.e. you can
+ work in your <a href="#def_working_tree">working tree</a> without using git at all.
+</dd></dl></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id28
2187"></a>Chapter 10. Notes and todo list for this manual</h2></div></div></div><p>This is a work in progress.</p><p>The basic requirements:
- It must be readable in order, from beginning to end, by
someone intelligent with a basic grasp of the unix
commandline, but without any special knowledge of git. If
projects / git.git / commitdiff