glossary-content.txt 26.6 KB
Newer Older
1
[[def_alternate_object_database]]alternate object database::
2 3
	Via the alternates mechanism, a <<def_repository,repository>>
	can inherit part of its <<def_object_database,object database>>
4
	from another object database, which is called an "alternate".
5 6

[[def_bare_repository]]bare repository::
7
	A bare repository is normally an appropriately
8 9
	named <<def_directory,directory>> with a `.git` suffix that does not
	have a locally checked-out copy of any of the files under
10
	revision control. That is, all of the Git
11 12
	administrative and control files that would normally be present in the
	hidden `.git` sub-directory are directly present in the
13
	`repository.git` directory instead,
14 15 16 17 18 19 20
	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::
21 22 23 24
	A "branch" is an active line of development.  The most recent
	<<def_commit,commit>> on a branch is referred to as the tip of
	that branch.  The tip of the branch is referenced by a branch
	<<def_head,head>>, which moves forward as additional development
25
	is done on the branch.  A single Git
26 27 28 29
	<<def_repository,repository>> can track an arbitrary number of
	branches, but your <<def_working_tree,working tree>> is
	associated with just one of them (the "current" or "checked out"
	branch), and <<def_HEAD,HEAD>> points to that branch.
30 31 32 33 34 35 36

[[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
37
	<<def_commit,commit>> could be one of its <<def_parent,parents>>).
38 39

[[def_changeset]]changeset::
40
	BitKeeper/cvsps speak for "<<def_commit,commit>>". Since Git does not
41
	store changes, but states, it really does not make sense to use the term
42
	"changesets" with Git.
43 44

[[def_checkout]]checkout::
45 46 47 48 49 50
	The action of updating all or part of the
	<<def_working_tree,working tree>> with a <<def_tree_object,tree object>>
	or <<def_blob_object,blob>> from the
	<<def_object_database,object database>>, and updating the
	<<def_index,index>> and <<def_HEAD,HEAD>> if the whole working tree has
	been pointed at a new <<def_branch,branch>>.
51 52 53 54

[[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
55
	as a new series of changes on top of a different codebase. In Git, this is
56
	performed by the "git cherry-pick" command to extract the change introduced
57
	by an existing <<def_commit,commit>> and to record it based on the tip
58
	of the current <<def_branch,branch>> as a new commit.
59 60

[[def_clean]]clean::
61
	A <<def_working_tree,working tree>> is clean, if it
62 63 64 65
	corresponds to the <<def_revision,revision>> referenced by the current
	<<def_head,head>>. Also see "<<def_dirty,dirty>>".

[[def_commit]]commit::
66
	As a noun: A single point in the
67
	Git history; the entire history of a project is represented as a
68
	set of interrelated commits.  The word "commit" is often
69
	used by Git in the same places other revision control systems
70 71 72 73
	use the words "revision" or "version".  Also used as a short
	hand for <<def_commit_object,commit object>>.
+
As a verb: The action of storing a new snapshot of the project's
74
state in the Git history, by creating a new commit representing the current
75 76
state of the <<def_index,index>> and advancing <<def_HEAD,HEAD>>
to point at the new commit.
77 78 79

[[def_commit_object]]commit object::
	An <<def_object,object>> which contains the information about a
80
	particular <<def_revision,revision>>, such as <<def_parent,parents>>, committer,
81 82
	author, date and the <<def_tree_object,tree object>> which corresponds
	to the top <<def_directory,directory>> of the stored
83
	revision.
84

85 86 87 88 89 90 91 92 93 94 95 96
[[def_commit-ish]]commit-ish (also committish)::
	A <<def_commit_object,commit object>> or an
	<<def_object,object>> that can be recursively dereferenced to
	a commit object.
	The following are all commit-ishes:
	a commit object,
	a <<def_tag_object,tag object>> that points to a commit
	object,
	a tag object that points to a tag object that points to a
	commit object,
	etc.

97 98
[[def_core_git]]core Git::
	Fundamental data structures and utilities of Git. Exposes only limited
99 100 101
	source code management tools.

[[def_DAG]]DAG::
L
Lea Wiemann 已提交
102
	Directed acyclic graph. The <<def_commit_object,commit objects>> form a
103
	directed acyclic graph, because they have parents (directed), and the
L
Lea Wiemann 已提交
104 105
	graph of commit objects is acyclic (there is no <<def_chain,chain>>
	which begins and ends with the same <<def_object,object>>).
106 107 108 109

[[def_dangling_object]]dangling object::
	An <<def_unreachable_object,unreachable object>> which is not
	<<def_reachable,reachable>> even from other unreachable objects; a
110
	dangling object has no references to it from any
111 112
	reference or <<def_object,object>> in the <<def_repository,repository>>.

113 114
[[def_detached_HEAD]]detached HEAD::
	Normally the <<def_HEAD,HEAD>> stores the name of a
115 116 117 118 119 120 121 122 123 124 125 126 127
	<<def_branch,branch>>, and commands that operate on the
	history HEAD represents operate on the history leading to the
	tip of the branch the HEAD points at.  However, Git also
	allows you to <<def_checkout,check out>> an arbitrary
	<<def_commit,commit>> that isn't necessarily the tip of any
	particular branch.  The HEAD in such a state is called
	"detached".
+
Note that commands that operate on the history of the current branch
(e.g. `git commit` to build a new history on top of it) still work
while the HEAD is detached. They update the HEAD to point at the tip
of the updated history without affecting any branch.  Commands that
update or inquire information _about_ the current branch (e.g. `git
128
branch --set-upstream-to` that sets what remote-tracking branch the
129 130
current branch integrates with) obviously do not work, as there is no
(real) current branch to ask about in this state.
131

132
[[def_directory]]directory::
J
Jon Loeliger 已提交
133
	The list you get with "ls" :-)
J
Johannes Schindelin 已提交
134

135
[[def_dirty]]dirty::
136
	A <<def_working_tree,working tree>> is said to be "dirty" if
137
	it contains modifications which have not been <<def_commit,committed>> to the current
138 139
	<<def_branch,branch>>.

140 141 142 143
[[def_evil_merge]]evil merge::
	An evil merge is a <<def_merge,merge>> that introduces changes that
	do not appear in any <<def_parent,parent>>.

144
[[def_fast_forward]]fast-forward::
145 146 147 148 149
	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
150
	revision. This will happen frequently on a
151
	<<def_remote_tracking_branch,remote-tracking branch>> of a remote
152 153 154 155
	<<def_repository,repository>>.

[[def_fetch]]fetch::
	Fetching a <<def_branch,branch>> means to get the
156 157 158
	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>>,
159
	and to get them, too.  See also linkgit:git-fetch[1].
160 161

[[def_file_system]]file system::
162
	Linus Torvalds originally designed Git to be a user space file system,
163
	i.e. the infrastructure to hold files and directories. That ensured the
164
	efficiency and speed of Git.
165

166
[[def_git_archive]]Git archive::
167 168
	Synonym for <<def_repository,repository>> (for arch people).

169 170 171 172
[[def_gitfile]]gitfile::
	A plain file `.git` at the root of a working tree that
	points at the directory that is the real repository.

173 174 175
[[def_grafts]]grafts::
	Grafts enables two otherwise different lines of development to be joined
	together by recording fake ancestry information for commits. This way
176
	you can make Git pretend the set of <<def_parent,parents>> a <<def_commit,commit>> has
177
	is different from what was recorded when the commit was
178
	created. Configured via the `.git/info/grafts` file.
J
Jeff King 已提交
179 180 181 182
+
Note that the grafts mechanism is outdated and can lead to problems
transferring objects between repositories; see linkgit:git-replace[1]
for a more flexible and robust system to do the same thing.
183 184

[[def_hash]]hash::
185
	In Git's context, synonym for <<def_object_name,object name>>.
186 187

[[def_head]]head::
188
	A <<def_ref,named reference>> to the <<def_commit,commit>> at the tip of a
189 190
	<<def_branch,branch>>.  Heads are stored in a file in
	`$GIT_DIR/refs/heads/` directory, except when using packed refs. (See
191
	linkgit:git-pack-refs[1].)
192 193

[[def_HEAD]]HEAD::
194
	The current <<def_branch,branch>>.  In more detail: Your <<def_working_tree,
195 196 197
	working tree>> is normally derived from the state of the tree
	referred to by HEAD.  HEAD is a reference to one of the
	<<def_head,heads>> in your repository, except when using a
198 199
	<<def_detached_HEAD,detached HEAD>>, in which case it directly
	references an arbitrary commit.
200 201

[[def_head_ref]]head ref::
202
	A synonym for <<def_head,head>>.
203 204

[[def_hook]]hook::
205
	During the normal execution of several Git commands, call-outs are made
206 207 208
	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
209
	operation is done. The hook scripts are found in the
210
	`$GIT_DIR/hooks/` directory, and are enabled by simply
211
	removing the `.sample` suffix from the filename. In earlier versions
212
	of Git you had to make them executable.
213 214 215

[[def_index]]index::
	A collection of files with stat information, whose contents are stored
216 217 218 219
	as objects. The index is a stored version of your
	<<def_working_tree,working tree>>. Truth be told, it can also contain a second, and even
	a third version of a working tree, which are used
	when <<def_merge,merging>>.
220 221 222

[[def_index_entry]]index entry::
	The information regarding a particular file, stored in the
223 224 225
	<<def_index,index>>. An index entry can be unmerged, if a
	<<def_merge,merge>> was started, but not yet finished (i.e. if
	the index contains multiple versions of that file).
226 227

[[def_master]]master::
228
	The default development <<def_branch,branch>>. Whenever you
229
	create a Git <<def_repository,repository>>, a branch named
230 231 232
	"master" is created, and becomes the active branch. In most
	cases, this contains the local development, though that is
	purely by convention and is not required.
J
Johannes Schindelin 已提交
233

234
[[def_merge]]merge::
235 236 237 238 239 240 241 242 243 244 245 246 247
	As a verb: To bring the contents of another
	<<def_branch,branch>> (possibly from an external
	<<def_repository,repository>>) into the current branch.  In the
	case where the merged-in branch is from a different repository,
	this is done by first <<def_fetch,fetching>> the remote branch
	and then merging the result into the current branch.  This
	combination of fetch and merge operations is called a
	<<def_pull,pull>>.  Merging is performed by an automatic process
	that identifies changes made since the branches diverged, and
	then applies all those changes together.  In cases where changes
	conflict, manual intervention may be required to complete the
	merge.
+
248
As a noun: unless it is a <<def_fast_forward,fast-forward>>, a
249 250 251 252 253
successful merge results in the creation of a new <<def_commit,commit>>
representing the result of the merge, and having as
<<def_parent,parents>> the tips of the merged <<def_branch,branches>>.
This commit is referred to as a "merge commit", or sometimes just a
"merge".
254 255

[[def_object]]object::
256
	The unit of storage in Git. It is uniquely identified by the
257
	<<def_SHA1,SHA-1>> of its contents. Consequently, an
258
	object can not be changed.
259 260 261 262 263 264 265 266 267 268

[[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::
269 270 271
	The unique identifier of an <<def_object,object>>.  The
	object name is usually represented by a 40 character
	hexadecimal string.  Also colloquially called <<def_SHA1,SHA-1>>.
272 273

[[def_object_type]]object type::
L
Lea Wiemann 已提交
274 275 276 277
	One of the identifiers "<<def_commit_object,commit>>",
	"<<def_tree_object,tree>>", "<<def_tag_object,tag>>" or
	"<<def_blob_object,blob>>" describing the type of an
	<<def_object,object>>.
278 279

[[def_octopus]]octopus::
280
	To <<def_merge,merge>> more than two <<def_branch,branches>>.
281 282 283 284

[[def_origin]]origin::
	The default upstream <<def_repository,repository>>. Most projects have
	at least one upstream project which they track. By default
285
	'origin' is used for that purpose. New upstream updates
286
	will be fetched into <<def_remote_tracking_branch,remote-tracking branches>> named
287
	origin/name-of-upstream-branch, which you can see using
288
	`git branch -r`.
289

290 291 292
[[def_pack]]pack::
	A set of objects which have been compressed into one file (to save space
	or to transmit them efficiently).
J
Johannes Schindelin 已提交
293

294
[[def_pack_index]]pack index::
J
Jon Loeliger 已提交
295
	The list of identifiers, and other information, of the objects in a
296
	<<def_pack,pack>>, to assist in efficiently accessing the contents of a
297
	pack.
298

J
Jonathan Nieder 已提交
299
[[def_pathspec]]pathspec::
300
	Pattern used to limit paths in Git commands.
J
Jonathan Nieder 已提交
301 302
+
Pathspecs are used on the command line of "git ls-files", "git
303 304
ls-tree", "git add", "git grep", "git diff", "git checkout",
and many other commands to
J
Jonathan Nieder 已提交
305 306 307 308
limit the scope of operations to some subset of the tree or
worktree.  See the documentation of each command for whether
paths are relative to the current directory or toplevel.  The
pathspec syntax is as follows:
309 310
+
--
J
Jonathan Nieder 已提交
311 312 313 314 315 316 317 318 319

* any path matches itself
* the pathspec up to the last slash represents a
  directory prefix.  The scope of that pathspec is
  limited to that subtree.
* the rest of the pathspec is a pattern for the remainder
  of the pathname.  Paths relative to the directory
  prefix will be matched against that pattern using fnmatch(3);
  in particular, '*' and '?' _can_ match directory separators.
320 321

--
J
Jonathan Nieder 已提交
322 323 324 325
+
For example, Documentation/*.jpg will match all .jpg files
in the Documentation subtree,
including Documentation/chapter_1/figure_1.jpg.
326 327 328 329
+
A pathspec that begins with a colon `:` has special meaning.  In the
short form, the leading colon `:` is followed by zero or more "magic
signature" letters (which optionally is terminated by another colon `:`),
330 331
and the remainder is the pattern to match against the path.
The "magic signature" consists of ASCII symbols that are neither
T
Thomas Ackermann 已提交
332
alphanumeric, glob, regex special characters nor colon.
333 334 335
The optional colon that terminates the "magic signature" can be
omitted if the pattern begins with a character that does not belong to
"magic signature" symbol set and is not a colon.
336 337 338 339 340 341
+
In the long form, the leading colon `:` is followed by a open
parenthesis `(`, a comma-separated list of zero or more "magic words",
and a close parentheses `)`, and the remainder is the pattern to match
against the path.
+
342 343
A pathspec with only a colon means "there is no pathspec". This form
should not be combined with other pathspec.
344 345
+
--
346 347 348 349
top;;
	The magic word `top` (magic signature: `/`) makes the pattern
	match from the root of the working tree, even when you are
	running the command from inside a subdirectory.
350 351 352 353

literal;;
	Wildcards in the pattern such as `*` or `?` are treated
	as literal characters.
354

355 356 357
icase;;
	Case insensitive match.

358 359 360 361 362 363 364 365 366 367 368 369 370
glob;;
	Git treats the pattern as a shell glob suitable for
	consumption by fnmatch(3) with the FNM_PATHNAME flag:
	wildcards in the pattern will not match a / in the pathname.
	For example, "Documentation/{asterisk}.html" matches
	"Documentation/git.html" but not "Documentation/ppc/ppc.html"
	or "tools/perf/Documentation/perf.html".
+
Two consecutive asterisks ("`**`") in patterns matched against
full pathname may have special meaning:

 - A leading "`**`" followed by a slash means match in all
   directories. For example, "`**/foo`" matches file or directory
371
   "`foo`" anywhere, the same as pattern "`foo`". "`**/foo/bar`"
372 373 374
   matches file or directory "`bar`" anywhere that is directly
   under directory "`foo`".

375 376
 - A trailing "`/**`" matches everything inside. For example,
   "`abc/**`" matches all files inside directory "abc", relative
377 378 379 380 381 382 383 384 385
   to the location of the `.gitignore` file, with infinite depth.

 - A slash followed by two consecutive asterisks then a slash
   matches zero or more directories. For example, "`a/**/b`"
   matches "`a/b`", "`a/x/b`", "`a/x/y/b`" and so on.

 - Other consecutive asterisks are considered invalid.
+
Glob magic is incompatible with literal magic.
386 387 388 389 390

exclude;;
	After a path matches any non-exclude pathspec, it will be run
	through all exclude pathspec (magic signature: `!`). If it
	matches, the path is ignored.
391
--
392

393 394 395 396 397 398 399 400
[[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
R
Ralf Wildenhues 已提交
401
	string. With the `--pickaxe-all` option, it can be used to view the full
402
	<<def_changeset,changeset>> that introduced or removed, say, a
403
	particular line of text. See linkgit:git-diff[1].
404 405

[[def_plumbing]]plumbing::
406
	Cute name for <<def_core_git,core Git>>.
407 408 409

[[def_porcelain]]porcelain::
	Cute name for programs and program suites depending on
410 411
	<<def_core_git,core Git>>, presenting a high level access to
	core Git. Porcelains expose more of a <<def_SCM,SCM>>
412 413
	interface than the <<def_plumbing,plumbing>>.

414 415
[[def_per_worktree_ref]]per-worktree ref::
	Refs that are per-<<def_working_tree,worktree>>, rather than
416 417 418
	global.  This is presently only <<def_HEAD,HEAD>> and any refs
	that start with `refs/bisect/`, but might later include other
	unusual refs.
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435

[[def_pseudoref]]pseudoref::
	Pseudorefs are a class of files under `$GIT_DIR` which behave
	like refs for the purposes of rev-parse, but which are treated
	specially by git.  Pseudorefs both have names that are all-caps,
	and always start with a line consisting of a
	<<def_SHA1,SHA-1>> followed by whitespace.  So, HEAD is not a
	pseudoref, because it is sometimes a symbolic ref.  They might
	optionally contain some additional data.  `MERGE_HEAD` and
	`CHERRY_PICK_HEAD` are examples.  Unlike
	<<def_per_worktree_ref,per-worktree refs>>, these files cannot
	be symbolic refs, and never have reflogs.  They also cannot be
	updated through the normal ref update machinery.  Instead,
	they are updated by directly writing to the files.  However,
	they can be read as if they were refs, so `git rev-parse
	MERGE_HEAD` will work.

436 437
[[def_pull]]pull::
	Pulling a <<def_branch,branch>> means to <<def_fetch,fetch>> it and
438
	<<def_merge,merge>> it.  See also linkgit:git-pull[1].
439 440

[[def_push]]push::
441
	Pushing a <<def_branch,branch>> means to get the branch's
442
	<<def_head_ref,head ref>> from a remote <<def_repository,repository>>,
R
Ralf Wildenhues 已提交
443 444
	find out if it is a direct ancestor to the branch's local
	head ref, and in that case, putting all
445
	objects, which are <<def_reachable,reachable>> from the local
446 447
	head ref, and which are missing from the remote
	repository, into the remote
448
	<<def_object_database,object database>>, and updating the remote
449 450
	head ref. If the remote <<def_head,head>> is not an
	ancestor to the local head, the push fails.
451 452 453

[[def_reachable]]reachable::
	All of the ancestors of a given <<def_commit,commit>> are said to be
454 455
	"reachable" from that commit. More
	generally, one <<def_object,object>> is reachable from
456
	another if we can reach the one from the other by a <<def_chain,chain>>
457 458 459 460
	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.
461 462

[[def_rebase]]rebase::
463 464 465
	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.
466 467

[[def_ref]]ref::
468 469 470 471 472 473 474 475 476 477 478 479 480 481
	A name that begins with `refs/` (e.g. `refs/heads/master`)
	that points to an <<def_object_name,object name>> or another
	ref (the latter is called a <<def_symref,symbolic ref>>).
	For convenience, a ref can sometimes be abbreviated when used
	as an argument to a Git command; see linkgit:gitrevisions[7]
	for details.
	Refs are stored in the <<def_repository,repository>>.
+
The ref namespace is hierarchical.
Different subhierarchies are used for different purposes (e.g. the
`refs/heads/` hierarchy is used to represent local branches).
+
There are a few special-purpose refs that do not begin with `refs/`.
The most notable example is `HEAD`.
482

J
Johannes Schindelin 已提交
483 484 485 486
[[def_reflog]]reflog::
	A reflog shows the local "history" of a ref.  In other words,
	it can tell you what the 3rd last revision in _this_ repository
	was, and what was the current state in _this_ repository,
487
	yesterday 9:14pm.  See linkgit:git-reflog[1] for details.
J
Johannes Schindelin 已提交
488

489
[[def_refspec]]refspec::
490
	A "refspec" is used by <<def_fetch,fetch>> and
491
	<<def_push,push>> to describe the mapping between remote
492
	<<def_ref,ref>> and local ref.
493

494 495 496 497 498
[[def_remote]]remote repository::
	A <<def_repository,repository>> which is used to track the same
	project but resides somewhere else. To communicate with remotes,
	see <<def_fetch,fetch>> or <<def_push,push>>.

499
[[def_remote_tracking_branch]]remote-tracking branch::
500 501 502 503 504 505 506
	A <<def_ref,ref>> that is used to follow changes from another
	<<def_repository,repository>>. It typically looks like
	'refs/remotes/foo/bar' (indicating that it tracks a branch named
	'bar' in a remote named 'foo'), and matches the right-hand-side of
	a configured fetch <<def_refspec,refspec>>. A remote-tracking
	branch should not contain direct modifications or have local
	commits made to it.
507

508
[[def_repository]]repository::
509
	A collection of <<def_ref,refs>> together with an
510 511
	<<def_object_database,object database>> containing all objects
	which are <<def_reachable,reachable>> from the refs, possibly
512 513 514
	accompanied by meta data from one or more <<def_porcelain,porcelains>>. A
	repository can share an object database with other repositories
	via <<def_alternate_object_database,alternates mechanism>>.
515 516 517 518 519 520

[[def_resolve]]resolve::
	The action of fixing up manually what a failed automatic
	<<def_merge,merge>> left behind.

[[def_revision]]revision::
521
	Synonym for <<def_commit,commit>> (the noun).
522 523 524 525 526 527

[[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::
J
Johannes Schindelin 已提交
528 529
	Source code management (tool).

530 531 532
[[def_SHA1]]SHA-1::
	"Secure Hash Algorithm 1"; a cryptographic hash function.
	In the context of Git used as a synonym for <<def_object_name,object name>>.
533 534

[[def_shallow_repository]]shallow repository::
535 536
	A shallow <<def_repository,repository>> has an incomplete
	history some of whose <<def_commit,commits>> have <<def_parent,parents>> cauterized away (in other
537
	words, Git is told to pretend that these commits do not have the
538 539 540
	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
541
	upstream is much larger. A shallow repository
542 543
	is created by giving the `--depth` option to linkgit:git-clone[1], and
	its history can be later deepened with linkgit:git-fetch[1].
544

545 546 547 548 549 550 551 552 553 554 555
[[def_submodule]]submodule::
	A <<def_repository,repository>> that holds the history of a
	separate project inside another repository (the latter of
	which is called <<def_superproject, superproject>>).

[[def_superproject]]superproject::
	A <<def_repository,repository>> that references repositories
	of other projects in its working tree as <<def_submodule,submodules>>.
	The superproject knows about the names of (but does not hold
	copies of) commit objects of the contained submodules.

556
[[def_symref]]symref::
557
	Symbolic reference: instead of containing the <<def_SHA1,SHA-1>>
558 559 560
	id itself, it is of the format 'ref: refs/some/thing' and when
	referenced, it recursively dereferences to this reference.
	'<<def_HEAD,HEAD>>' is a prime example of a symref. Symbolic
561
	references are manipulated with the linkgit:git-symbolic-ref[1]
562
	command.
563 564

[[def_tag]]tag::
565 566 567 568
	A <<def_ref,ref>> under `refs/tags/` namespace that points to an
	object of an arbitrary type (typically a tag points to either a
	<<def_tag_object,tag>> or a <<def_commit_object,commit object>>).
	In contrast to a <<def_head,head>>, a tag is not updated by
569
	the `commit` command. A Git tag has nothing to do with a Lisp
570
	tag (which would be called an <<def_object_type,object type>>
571
	in Git's context). A tag is most typically used to mark a particular
572
	point in the commit ancestry <<def_chain,chain>>.
573 574 575

[[def_tag_object]]tag object::
	An <<def_object,object>> containing a <<def_ref,ref>> pointing to
576
	another object, which can contain a message just like a
577
	<<def_commit_object,commit object>>. It can also contain a (PGP)
578
	signature, in which case it is called a "signed tag object".
579 580

[[def_topic_branch]]topic branch::
581
	A regular Git <<def_branch,branch>> that is used by a developer to
582 583 584 585 586 587 588
	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_tree]]tree::
	Either a <<def_working_tree,working tree>>, or a <<def_tree_object,tree
589
	object>> together with the dependent <<def_blob_object,blob>> and tree objects
590
	(i.e. a stored representation of a working tree).
591 592 593

[[def_tree_object]]tree object::
	An <<def_object,object>> containing a list of file names and modes along
594
	with refs to the associated blob and/or tree objects. A
595 596
	<<def_tree,tree>> is equivalent to a <<def_directory,directory>>.

597
[[def_tree-ish]]tree-ish (also treeish)::
598 599 600 601 602 603 604 605 606 607 608 609
	A <<def_tree_object,tree object>> or an <<def_object,object>>
	that can be recursively dereferenced to a tree object.
	Dereferencing a <<def_commit_object,commit object>> yields the
	tree object corresponding to the <<def_revision,revision>>'s
	top <<def_directory,directory>>.
	The following are all tree-ishes:
	a <<def_commit-ish,commit-ish>>,
	a tree object,
	a <<def_tag_object,tag object>> that points to a tree object,
	a tag object that points to a tag object that points to a tree
	object,
	etc.
610 611

[[def_unmerged_index]]unmerged index::
612 613
	An <<def_index,index>> which contains unmerged
	<<def_index_entry,index entries>>.
614 615 616 617 618

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

619 620 621 622 623 624
[[def_upstream_branch]]upstream branch::
	The default <<def_branch,branch>> that is merged into the branch in
	question (or the branch in question is rebased onto). It is configured
	via branch.<name>.remote and branch.<name>.merge. If the upstream branch
	of 'A' is 'origin/B' sometimes we say "'A' is tracking 'origin/B'".

625
[[def_working_tree]]working tree::
626 627 628
	The tree of actual checked out files.  The working tree normally
	contains the contents of the <<def_HEAD,HEAD>> commit's tree,
	plus any local changes that you have made but not yet committed.