Autogenerated manpages for v2.44.0-53-g0f9d4
[git-manpages.git] / man7 / gitglossary.7
blobdd8dd526f8be4a690e7ff4aa19e7889338879992
1 '\" t
2 .\"     Title: gitglossary
3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\"      Date: 2024-02-27
6 .\"    Manual: Git Manual
7 .\"    Source: Git 2.44.0.53.g0f9d4d28b7
8 .\"  Language: English
9 .\"
10 .TH "GITGLOSSARY" "7" "2024\-02\-27" "Git 2\&.44\&.0\&.53\&.g0f9d4d2" "Git Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el       .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 gitglossary \- A Git Glossary
32 .SH "SYNOPSIS"
33 .sp
35 .SH "DESCRIPTION"
36 .PP
37 alternate object database
38 .RS 4
39 Via the alternates mechanism, a
40 repository
41 can inherit part of its
42 object database
43 from another object database, which is called an "alternate"\&.
44 .RE
45 .PP
46 bare repository
47 .RS 4
48 A bare repository is normally an appropriately named
49 directory
50 with a
51 \fB\&.git\fR
52 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
53 \fB\&.git\fR
54 sub\-directory are directly present in the
55 \fBrepository\&.git\fR
56 directory instead, and no other files are present and checked out\&. Usually publishers of public repositories make bare repositories available\&.
57 .RE
58 .PP
59 blob object
60 .RS 4
61 Untyped
62 object, e\&.g\&. the contents of a file\&.
63 .RE
64 .PP
65 branch
66 .RS 4
67 A "branch" is a line of development\&. The most recent
68 commit
69 on a branch is referred to as the tip of that branch\&. The tip of the branch is
70 referenced
71 by a branch
72 head, which moves forward as additional development is done on the branch\&. A single Git
73 repository
74 can track an arbitrary number of branches, but your
75 working tree
76 is associated with just one of them (the "current" or "checked out" branch), and
77 HEAD
78 points to that branch\&.
79 .RE
80 .PP
81 cache
82 .RS 4
83 Obsolete for:
84 index\&.
85 .RE
86 .PP
87 chain
88 .RS 4
89 A list of objects, where each
90 object
91 in the list contains a reference to its successor (for example, the successor of a
92 commit
93 could be one of its
94 parents)\&.
95 .RE
96 .PP
97 changeset
98 .RS 4
99 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\&.
102 checkout
103 .RS 4
104 The action of updating all or part of the
105 working tree
106 with a
107 tree object
109 blob
110 from the
111 object database, and updating the
112 index
114 HEAD
115 if the whole working tree has been pointed at a new
116 branch\&.
119 cherry\-picking
120 .RS 4
123 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 a different codebase\&. In Git, this is performed by the "git cherry\-pick" command to extract the change introduced by an existing
124 commit
125 and to record it based on the tip of the current
126 branch
127 as a new commit\&.
130 clean
131 .RS 4
133 working tree
134 is clean, if it corresponds to the
135 revision
136 referenced by the current
137 head\&. Also see "dirty"\&.
140 commit
141 .RS 4
142 As a noun: A single point in the Git history; the entire history of a project is represented as a set of interrelated commits\&. The word "commit" is often used by Git in the same places other revision control systems use the words "revision" or "version"\&. Also used as a short hand for
143 commit object\&.
145 As a verb: The action of storing a new snapshot of the project\(cqs state in the Git history, by creating a new commit representing the current state of the
146 index
147 and advancing
148 HEAD
149 to point at the new commit\&.
152 commit graph concept, representations and usage
153 .RS 4
154 A synonym for the
156 structure formed by the commits in the object database,
157 referenced
158 by branch tips, using their
159 chain
160 of linked commits\&. This structure is the definitive commit graph\&. The graph can be represented in other ways, e\&.g\&. the
161 "commit\-graph" file\&.
164 commit\-graph file
165 .RS 4
166 The "commit\-graph" (normally hyphenated) file is a supplemental representation of the
167 commit graph
168 which accelerates commit graph walks\&. The "commit\-graph" file is stored either in the \&.git/objects/info directory or in the info directory of an alternate object database\&.
171 commit object
172 .RS 4
174 object
175 which contains the information about a particular
176 revision, such as
177 parents, committer, author, date and the
178 tree object
179 which corresponds to the top
180 directory
181 of the stored revision\&.
184 commit\-ish (also committish)
185 .RS 4
187 commit object
188 or an
189 object
190 that can be recursively
191 dereferenced
192 to a commit object\&. The following are all commit\-ishes: a commit object, a
193 tag object
194 that points to a commit object, a tag object that points to a tag object that points to a commit object, etc\&.
197 core Git
198 .RS 4
199 Fundamental data structures and utilities of Git\&. Exposes only limited source code management tools\&.
203 .RS 4
204 Directed acyclic graph\&. The
205 commit objects
206 form a directed acyclic graph, because they have parents (directed), and the graph of commit objects is acyclic (there is no
207 chain
208 which begins and ends with the same
209 object)\&.
212 dangling object
213 .RS 4
215 unreachable object
216 which is not
217 reachable
218 even from other unreachable objects; a dangling object has no references to it from any reference or
219 object
220 in the
221 repository\&.
224 dereference
225 .RS 4
226 Referring to a
227 symbolic ref: the action of accessing the
228 reference
229 pointed at by a symbolic ref\&. Recursive dereferencing involves repeating the aforementioned process on the resulting ref until a non\-symbolic reference is found\&.
231 Referring to a
232 tag object: the action of accessing the
233 object
234 a tag points at\&. Tags are recursively dereferenced by repeating the operation on the result object until the result has either a specified
235 object type
236 (where applicable) or any non\-"tag" object type\&. A synonym for "recursive dereference" in the context of tags is "peel"\&.
238 Referring to a
239 commit object: the action of accessing the commit\(cqs tree object\&. Commits cannot be dereferenced recursively\&.
241 Unless otherwise specified, "dereferencing" as it used in the context of Git commands or protocols is implicitly recursive\&.
244 detached HEAD
245 .RS 4
246 Normally the
247 HEAD
248 stores the name of a
249 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
250 check out
251 an arbitrary
252 commit
253 that isn\(cqt necessarily the tip of any particular branch\&. The HEAD in such a state is called "detached"\&.
255 Note that commands that operate on the history of the current branch (e\&.g\&.
256 \fBgit commit\fR
257 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
258 \fIabout\fR
259 the current branch (e\&.g\&.
260 \fBgit branch \-\-set\-upstream\-to\fR
261 that sets what remote\-tracking branch the current branch integrates with) obviously do not work, as there is no (real) current branch to ask about in this state\&.
264 directory
265 .RS 4
266 The list you get with "ls" :\-)
269 dirty
270 .RS 4
272 working tree
273 is said to be "dirty" if it contains modifications which have not been
274 committed
275 to the current
276 branch\&.
279 evil merge
280 .RS 4
281 An evil merge is a
282 merge
283 that introduces changes that do not appear in any
284 parent\&.
287 fast\-forward
288 .RS 4
289 A fast\-forward is a special type of
290 merge
291 where you have a
292 revision
293 and you are "merging" another
294 branch\*(Aqs changes that happen to be a descendant of what you have\&. In such a case, you do not make a new
295 merge
296 commit
297 but instead just update your branch to point at the same revision as the branch you are merging\&. This will happen frequently on a
298 remote\-tracking branch
299 of a remote
300 repository\&.
303 fetch
304 .RS 4
305 Fetching a
306 branch
307 means to get the branch\(cqs
308 head ref
309 from a remote
310 repository, to find out which objects are missing from the local
311 object database, and to get them, too\&. See also
312 \fBgit-fetch\fR(1)\&.
315 file system
316 .RS 4
317 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\&.
320 Git archive
321 .RS 4
322 Synonym for
323 repository
324 (for arch people)\&.
327 gitfile
328 .RS 4
329 A plain file
330 \fB\&.git\fR
331 at the root of a working tree that points at the directory that is the real repository\&. For proper use see
332 \fBgit-worktree\fR(1)
334 \fBgit-submodule\fR(1)\&. For syntax see
335 \fBgitrepository-layout\fR(5)\&.
338 grafts
339 .RS 4
340 Grafts enable 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
341 parents
343 commit
344 has is different from what was recorded when the commit was created\&. Configured via the
345 \fB\&.git/info/grafts\fR
346 file\&.
348 Note that the grafts mechanism is outdated and can lead to problems transferring objects between repositories; see
349 \fBgit-replace\fR(1)
350 for a more flexible and robust system to do the same thing\&.
353 hash
354 .RS 4
355 In Git\(cqs context, synonym for
356 object name\&.
359 head
360 .RS 4
362 named reference
363 to the
364 commit
365 at the tip of a
366 branch\&. Heads are stored in a file in
367 \fB$GIT_DIR/refs/heads/\fR
368 directory, except when using packed refs\&. (See
369 \fBgit-pack-refs\fR(1)\&.)
372 HEAD
373 .RS 4
374 The current
375 branch\&. In more detail: Your
376 working tree
377 is normally derived from the state of the tree referred to by HEAD\&. HEAD is a reference to one of the
378 heads
379 in your repository, except when using a
380 detached HEAD, in which case it directly references an arbitrary commit\&.
383 head ref
384 .RS 4
385 A synonym for
386 head\&.
389 hook
390 .RS 4
391 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
392 \fB$GIT_DIR/hooks/\fR
393 directory, and are enabled by simply removing the
394 \fB\&.sample\fR
395 suffix from the filename\&. In earlier versions of Git you had to make them executable\&.
398 index
399 .RS 4
400 A collection of files with stat information, whose contents are stored as objects\&. The index is a stored version of your
401 working tree\&. Truth be told, it can also contain a second, and even a third version of a working tree, which are used when
402 merging\&.
405 index entry
406 .RS 4
407 The information regarding a particular file, stored in the
408 index\&. An index entry can be unmerged, if a
409 merge
410 was started, but not yet finished (i\&.e\&. if the index contains multiple versions of that file)\&.
413 master
414 .RS 4
415 The default development
416 branch\&. Whenever you create a Git
417 repository, a branch named "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\&.
420 merge
421 .RS 4
422 As a verb: To bring the contents of another
423 branch
424 (possibly from an external
425 repository) into the current branch\&. In the case where the merged\-in branch is from a different repository, this is done by first
426 fetching
427 the remote branch and then merging the result into the current branch\&. This combination of fetch and merge operations is called a
428 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\&.
430 As a noun: unless it is a
431 fast\-forward, a successful merge results in the creation of a new
432 commit
433 representing the result of the merge, and having as
434 parents
435 the tips of the merged
436 branches\&. This commit is referred to as a "merge commit", or sometimes just a "merge"\&.
439 object
440 .RS 4
441 The unit of storage in Git\&. It is uniquely identified by the
442 SHA\-1
443 of its contents\&. Consequently, an object cannot be changed\&.
446 object database
447 .RS 4
448 Stores a set of "objects", and an individual
449 object
450 is identified by its
451 object name\&. The objects usually live in
452 \fB$GIT_DIR/objects/\fR\&.
455 object identifier (oid)
456 .RS 4
457 Synonym for
458 object name\&.
461 object name
462 .RS 4
463 The unique identifier of an
464 object\&. The object name is usually represented by a 40 character hexadecimal string\&. Also colloquially called
465 SHA\-1\&.
468 object type
469 .RS 4
470 One of the identifiers "commit", "tree", "tag" or "blob" describing the type of an
471 object\&.
474 octopus
475 .RS 4
477 merge
478 more than two
479 branches\&.
482 orphan
483 .RS 4
484 The act of getting on a
485 branch
486 that does not exist yet (i\&.e\&., an
487 unborn
488 branch)\&. After such an operation, the commit first created becomes a commit without a parent, starting a new history\&.
491 origin
492 .RS 4
493 The default upstream
494 repository\&. Most projects have at least one upstream project which they track\&. By default
495 \fIorigin\fR
496 is used for that purpose\&. New upstream updates will be fetched into
497 remote\-tracking branches
498 named origin/name\-of\-upstream\-branch, which you can see using
499 \fBgit branch \-r\fR\&.
502 overlay
503 .RS 4
504 Only update and add files to the working directory, but don\(cqt delete them, similar to how
505 \fIcp \-R\fR
506 would update the contents in the destination directory\&. This is the default mode in a
507 checkout
508 when checking out files from the
509 index
510 or a
511 tree\-ish\&. In contrast, no\-overlay mode also deletes tracked files not present in the source, similar to
512 \fIrsync \-\-delete\fR\&.
515 pack
516 .RS 4
517 A set of objects which have been compressed into one file (to save space or to transmit them efficiently)\&.
520 pack index
521 .RS 4
522 The list of identifiers, and other information, of the objects in a
523 pack, to assist in efficiently accessing the contents of a pack\&.
526 pathspec
527 .RS 4
528 Pattern used to limit paths in Git commands\&.
530 Pathspecs are used on the command line of "git ls\-files", "git ls\-tree", "git add", "git grep", "git diff", "git checkout", and many other commands to limit the scope of operations to some subset of the tree or working tree\&. See the documentation of each command for whether paths are relative to the current directory or toplevel\&. The pathspec syntax is as follows:
532 .RS 4
533 .ie n \{\
534 \h'-04'\(bu\h'+03'\c
536 .el \{\
537 .sp -1
538 .IP \(bu 2.3
540 any path matches itself
543 .RS 4
544 .ie n \{\
545 \h'-04'\(bu\h'+03'\c
547 .el \{\
548 .sp -1
549 .IP \(bu 2.3
551 the pathspec up to the last slash represents a directory prefix\&. The scope of that pathspec is limited to that subtree\&.
554 .RS 4
555 .ie n \{\
556 \h'-04'\(bu\h'+03'\c
558 .el \{\
559 .sp -1
560 .IP \(bu 2.3
562 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,
563 \fI*\fR
565 \fI?\fR
566 \fIcan\fR
567 match directory separators\&.
570 For example, Documentation/*\&.jpg will match all \&.jpg files in the Documentation subtree, including Documentation/chapter_1/figure_1\&.jpg\&.
572 A pathspec that begins with a colon
573 \fB:\fR
574 has special meaning\&. In the short form, the leading colon
575 \fB:\fR
576 is followed by zero or more "magic signature" letters (which optionally is terminated by another colon
577 \fB:\fR), and the remainder is the pattern to match against the path\&. The "magic signature" consists of ASCII symbols that are neither alphanumeric, glob, regex special characters nor colon\&. 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\&.
579 In the long form, the leading colon
580 \fB:\fR
581 is followed by an open parenthesis
582 \fB(\fR, a comma\-separated list of zero or more "magic words", and a close parentheses
583 \fB)\fR, and the remainder is the pattern to match against the path\&.
585 A pathspec with only a colon means "there is no pathspec"\&. This form should not be combined with other pathspec\&.
588 .RS 4
589 The magic word
590 \fBtop\fR
591 (magic signature:
592 \fB/\fR) makes the pattern match from the root of the working tree, even when you are running the command from inside a subdirectory\&.
595 literal
596 .RS 4
597 Wildcards in the pattern such as
598 \fB*\fR
600 \fB?\fR
601 are treated as literal characters\&.
604 icase
605 .RS 4
606 Case insensitive match\&.
609 glob
610 .RS 4
611 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/*\&.html" matches "Documentation/git\&.html" but not "Documentation/ppc/ppc\&.html" or "tools/perf/Documentation/perf\&.html"\&.
613 Two consecutive asterisks ("\fB**\fR") in patterns matched against full pathname may have special meaning:
615 .RS 4
616 .ie n \{\
617 \h'-04'\(bu\h'+03'\c
619 .el \{\
620 .sp -1
621 .IP \(bu 2.3
623 A leading "\fB**\fR" followed by a slash means match in all directories\&. For example, "\fB**/foo\fR" matches file or directory "\fBfoo\fR" anywhere, the same as pattern "\fBfoo\fR"\&. "\fB**/foo/bar\fR" matches file or directory "\fBbar\fR" anywhere that is directly under directory "\fBfoo\fR"\&.
626 .RS 4
627 .ie n \{\
628 \h'-04'\(bu\h'+03'\c
630 .el \{\
631 .sp -1
632 .IP \(bu 2.3
634 A trailing "\fB/**\fR" matches everything inside\&. For example, "\fBabc/**\fR" matches all files inside directory "abc", relative to the location of the
635 \fB\&.gitignore\fR
636 file, with infinite depth\&.
639 .RS 4
640 .ie n \{\
641 \h'-04'\(bu\h'+03'\c
643 .el \{\
644 .sp -1
645 .IP \(bu 2.3
647 A slash followed by two consecutive asterisks then a slash matches zero or more directories\&. For example, "\fBa/**/b\fR" matches "\fBa/b\fR", "\fBa/x/b\fR", "\fBa/x/y/b\fR" and so on\&.
650 .RS 4
651 .ie n \{\
652 \h'-04'\(bu\h'+03'\c
654 .el \{\
655 .sp -1
656 .IP \(bu 2.3
658 Other consecutive asterisks are considered invalid\&.
660 Glob magic is incompatible with literal magic\&.
664 attr
665 .RS 4
666 After
667 \fBattr:\fR
668 comes a space separated list of "attribute requirements", all of which must be met in order for the path to be considered a match; this is in addition to the usual non\-magic pathspec pattern matching\&. See
669 \fBgitattributes\fR(5)\&.
671 Each of the attribute requirements for the path takes one of these forms:
673 .RS 4
674 .ie n \{\
675 \h'-04'\(bu\h'+03'\c
677 .el \{\
678 .sp -1
679 .IP \(bu 2.3
681 "\fBATTR\fR" requires that the attribute
682 \fBATTR\fR
683 be set\&.
686 .RS 4
687 .ie n \{\
688 \h'-04'\(bu\h'+03'\c
690 .el \{\
691 .sp -1
692 .IP \(bu 2.3
694 "\fB\-ATTR\fR" requires that the attribute
695 \fBATTR\fR
696 be unset\&.
699 .RS 4
700 .ie n \{\
701 \h'-04'\(bu\h'+03'\c
703 .el \{\
704 .sp -1
705 .IP \(bu 2.3
707 "\fBATTR=VALUE\fR" requires that the attribute
708 \fBATTR\fR
709 be set to the string
710 \fBVALUE\fR\&.
713 .RS 4
714 .ie n \{\
715 \h'-04'\(bu\h'+03'\c
717 .el \{\
718 .sp -1
719 .IP \(bu 2.3
721 "\fB!ATTR\fR" requires that the attribute
722 \fBATTR\fR
723 be unspecified\&.
725 Note that when matching against a tree object, attributes are still obtained from working tree, not from the given tree object\&.
729 exclude
730 .RS 4
731 After a path matches any non\-exclude pathspec, it will be run through all exclude pathspecs (magic signature:
732 \fB!\fR
733 or its synonym
734 \fB^\fR)\&. If it matches, the path is ignored\&. When there is no non\-exclude pathspec, the exclusion is applied to the result set as if invoked without any pathspec\&.
738 parent
739 .RS 4
741 commit object
742 contains a (possibly empty) list of the logical predecessor(s) in the line of development, i\&.e\&. its parents\&.
745 peel
746 .RS 4
747 The action of recursively
748 dereferencing
750 tag object\&.
753 pickaxe
754 .RS 4
755 The term
756 pickaxe
757 refers to an option to the diffcore routines that help select changes that add or delete a given text string\&. With the
758 \fB\-\-pickaxe\-all\fR
759 option, it can be used to view the full
760 changeset
761 that introduced or removed, say, a particular line of text\&. See
762 \fBgit-diff\fR(1)\&.
765 plumbing
766 .RS 4
767 Cute name for
768 core Git\&.
771 porcelain
772 .RS 4
773 Cute name for programs and program suites depending on
774 core Git, presenting a high level access to core Git\&. Porcelains expose more of a
776 interface than the
777 plumbing\&.
780 per\-worktree ref
781 .RS 4
782 Refs that are per\-worktree, rather than global\&. This is presently only
783 HEAD
784 and any refs that start with
785 \fBrefs/bisect/\fR, but might later include other unusual refs\&.
788 pseudoref
789 .RS 4
790 Pseudorefs are a class of files under
791 \fB$GIT_DIR\fR
792 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
793 SHA\-1
794 followed by whitespace\&. So, HEAD is not a pseudoref, because it is sometimes a symbolic ref\&. They might optionally contain some additional data\&.
795 \fBMERGE_HEAD\fR
797 \fBCHERRY_PICK_HEAD\fR
798 are examples\&. Unlike
799 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
800 \fBgit rev\-parse MERGE_HEAD\fR
801 will work\&.
804 pull
805 .RS 4
806 Pulling a
807 branch
808 means to
809 fetch
810 it and
811 merge
812 it\&. See also
813 \fBgit-pull\fR(1)\&.
816 push
817 .RS 4
818 Pushing a
819 branch
820 means to get the branch\(cqs
821 head ref
822 from a remote
823 repository, find out if it is an ancestor to the branch\(cqs local head ref, and in that case, putting all objects, which are
824 reachable
825 from the local head ref, and which are missing from the remote repository, into the remote
826 object database, and updating the remote head ref\&. If the remote
827 head
828 is not an ancestor to the local head, the push fails\&.
831 reachable
832 .RS 4
833 All of the ancestors of a given
834 commit
835 are said to be "reachable" from that commit\&. More generally, one
836 object
837 is reachable from another if we can reach the one from the other by a
838 chain
839 that follows
840 tags
841 to whatever they tag,
842 commits
843 to their parents or trees, and
844 trees
845 to the trees or
846 blobs
847 that they contain\&.
850 reachability bitmaps
851 .RS 4
852 Reachability bitmaps store information about the
853 reachability
854 of a selected set of commits in a packfile, or a multi\-pack index (MIDX), to speed up object search\&. The bitmaps are stored in a "\&.bitmap" file\&. A repository may have at most one bitmap file in use\&. The bitmap file may belong to either one pack, or the repository\(cqs multi\-pack index (if it exists)\&.
857 rebase
858 .RS 4
859 To reapply a series of changes from a
860 branch
861 to a different base, and reset the
862 head
863 of that branch to the result\&.
867 .RS 4
868 A name that begins with
869 \fBrefs/\fR
870 (e\&.g\&.
871 \fBrefs/heads/master\fR) that points to an
872 object name
873 or another ref (the latter is called a
874 symbolic ref)\&. For convenience, a ref can sometimes be abbreviated when used as an argument to a Git command; see
875 \fBgitrevisions\fR(7)
876 for details\&. Refs are stored in the
877 repository\&.
879 The ref namespace is hierarchical\&. Different subhierarchies are used for different purposes (e\&.g\&. the
880 \fBrefs/heads/\fR
881 hierarchy is used to represent local branches)\&.
883 There are a few special\-purpose refs that do not begin with
884 \fBrefs/\fR\&. The most notable example is
885 \fBHEAD\fR\&.
888 reflog
889 .RS 4
890 A reflog shows the local "history" of a ref\&. In other words, it can tell you what the 3rd last revision in
891 \fIthis\fR
892 repository was, and what was the current state in
893 \fIthis\fR
894 repository, yesterday 9:14pm\&. See
895 \fBgit-reflog\fR(1)
896 for details\&.
899 refspec
900 .RS 4
901 A "refspec" is used by
902 fetch
904 push
905 to describe the mapping between remote
907 and local ref\&.
910 remote repository
911 .RS 4
913 repository
914 which is used to track the same project but resides somewhere else\&. To communicate with remotes, see
915 fetch
917 push\&.
920 remote\-tracking branch
921 .RS 4
924 that is used to follow changes from another
925 repository\&. It typically looks like
926 \fIrefs/remotes/foo/bar\fR
927 (indicating that it tracks a branch named
928 \fIbar\fR
929 in a remote named
930 \fIfoo\fR), and matches the right\-hand\-side of a configured fetch
931 refspec\&. A remote\-tracking branch should not contain direct modifications or have local commits made to it\&.
934 repository
935 .RS 4
936 A collection of
937 refs
938 together with an
939 object database
940 containing all objects which are
941 reachable
942 from the refs, possibly accompanied by meta data from one or more
943 porcelains\&. A repository can share an object database with other repositories via
944 alternates mechanism\&.
947 resolve
948 .RS 4
949 The action of fixing up manually what a failed automatic
950 merge
951 left behind\&.
954 revision
955 .RS 4
956 Synonym for
957 commit
958 (the noun)\&.
961 rewind
962 .RS 4
963 To throw away part of the development, i\&.e\&. to assign the
964 head
965 to an earlier
966 revision\&.
970 .RS 4
971 Source code management (tool)\&.
974 SHA\-1
975 .RS 4
976 "Secure Hash Algorithm 1"; a cryptographic hash function\&. In the context of Git used as a synonym for
977 object name\&.
980 shallow clone
981 .RS 4
982 Mostly a synonym to
983 shallow repository
984 but the phrase makes it more explicit that it was created by running
985 \fBgit clone \-\-depth=\&.\&.\&.\fR
986 command\&.
989 shallow repository
990 .RS 4
991 A shallow
992 repository
993 has an incomplete history some of whose
994 commits
995 have
996 parents
997 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
998 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 the
999 \fB\-\-depth\fR
1000 option to
1001 \fBgit-clone\fR(1), and its history can be later deepened with
1002 \fBgit-fetch\fR(1)\&.
1005 stash entry
1006 .RS 4
1008 object
1009 used to temporarily store the contents of a
1010 dirty
1011 working directory and the index for future reuse\&.
1014 special ref
1015 .RS 4
1016 A ref that has different semantics than normal refs\&. These refs can be accessed via normal Git commands but may not behave the same as a normal ref in some cases\&.
1018 The following special refs are known to Git:
1020 .RS 4
1021 .ie n \{\
1022 \h'-04'\(bu\h'+03'\c
1024 .el \{\
1025 .sp -1
1026 .IP \(bu 2.3
1028 "\fBFETCH_HEAD\fR" is written by
1029 \fBgit-fetch\fR(1)
1031 \fBgit-pull\fR(1)\&. It may refer to multiple object IDs\&. Each object ID is annotated with metadata indicating where it was fetched from and its fetch status\&.
1034 .RS 4
1035 .ie n \{\
1036 \h'-04'\(bu\h'+03'\c
1038 .el \{\
1039 .sp -1
1040 .IP \(bu 2.3
1042 "\fBMERGE_HEAD\fR" is written by
1043 \fBgit-merge\fR(1)
1044 when resolving merge conflicts\&. It contains all commit IDs which are being merged\&.
1048 submodule
1049 .RS 4
1051 repository
1052 that holds the history of a separate project inside another repository (the latter of which is called
1053 superproject)\&.
1056 superproject
1057 .RS 4
1059 repository
1060 that references repositories of other projects in its working tree as
1061 submodules\&. The superproject knows about the names of (but does not hold copies of) commit objects of the contained submodules\&.
1064 symref
1065 .RS 4
1066 Symbolic reference: instead of containing the
1067 SHA\-1
1068 id itself, it is of the format
1069 \fIref: refs/some/thing\fR
1070 and when referenced, it recursively
1071 dereferences
1072 to this reference\&.
1073 \fIHEAD\fR
1074 is a prime example of a symref\&. Symbolic references are manipulated with the
1075 \fBgit-symbolic-ref\fR(1)
1076 command\&.
1080 .RS 4
1083 under
1084 \fBrefs/tags/\fR
1085 namespace that points to an object of an arbitrary type (typically a tag points to either a
1087 or a
1088 commit object)\&. In contrast to a
1089 head, a tag is not updated by the
1090 \fBcommit\fR
1091 command\&. A Git tag has nothing to do with a Lisp tag (which would be called an
1092 object type
1093 in Git\(cqs context)\&. A tag is most typically used to mark a particular point in the commit ancestry
1094 chain\&.
1097 tag object
1098 .RS 4
1100 object
1101 containing a
1103 pointing to another object, which can contain a message just like a
1104 commit object\&. It can also contain a (PGP) signature, in which case it is called a "signed tag object"\&.
1107 topic branch
1108 .RS 4
1109 A regular Git
1110 branch
1111 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\&.
1114 tree
1115 .RS 4
1116 Either a
1117 working tree, or a
1118 tree object
1119 together with the dependent
1120 blob
1121 and tree objects (i\&.e\&. a stored representation of a working tree)\&.
1124 tree object
1125 .RS 4
1127 object
1128 containing a list of file names and modes along with refs to the associated blob and/or tree objects\&. A
1129 tree
1130 is equivalent to a
1131 directory\&.
1134 tree\-ish (also treeish)
1135 .RS 4
1137 tree object
1138 or an
1139 object
1140 that can be recursively
1141 dereferenced
1142 to a tree object\&. Dereferencing a
1143 commit object
1144 yields the tree object corresponding to the
1145 revision\*(Aqs top
1146 directory\&. The following are all tree\-ishes: a
1147 commit\-ish, a tree object, a
1148 tag object
1149 that points to a tree object, a tag object that points to a tag object that points to a tree object, etc\&.
1152 unborn
1153 .RS 4
1155 HEAD
1156 can point at a
1157 branch
1158 that does not yet exist and that does not have any commit on it yet, and such a branch is called an unborn branch\&. The most typical way users encounter an unborn branch is by creating a repository anew without cloning from elsewhere\&. The HEAD would point at the
1159 \fImain\fR
1161 \fImaster\fR, depending on your configuration) branch that is yet to be born\&. Also some operations can get you on an unborn branch with their
1162 orphan
1163 option\&.
1166 unmerged index
1167 .RS 4
1169 index
1170 which contains unmerged
1171 index entries\&.
1174 unreachable object
1175 .RS 4
1177 object
1178 which is not
1179 reachable
1180 from a
1181 branch,
1182 tag, or any other reference\&.
1185 upstream branch
1186 .RS 4
1187 The default
1188 branch
1189 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
1190 \fIA\fR
1192 \fIorigin/B\fR
1193 sometimes we say "\fIA\fR
1194 is tracking
1195 \fIorigin/B\fR"\&.
1198 working tree
1199 .RS 4
1200 The tree of actual checked out files\&. The working tree normally contains the contents of the
1201 HEAD
1202 commit\(cqs tree, plus any local changes that you have made but not yet committed\&.
1205 worktree
1206 .RS 4
1207 A repository can have zero (i\&.e\&. bare repository) or one or more worktrees attached to it\&. One "worktree" consists of a "working tree" and repository metadata, most of which are shared among other worktrees of a single repository, and some of which are maintained separately per worktree (e\&.g\&. the index, HEAD and pseudorefs like MERGE_HEAD, per\-worktree refs and per\-worktree configuration file)\&.
1209 .SH "SEE ALSO"
1211 \fBgittutorial\fR(7), \fBgittutorial-2\fR(7), \fBgitcvs-migration\fR(7), \fBgiteveryday\fR(7), \m[blue]\fBThe Git User\(cqs Manual\fR\m[]\&\s-2\u[1]\d\s+2
1212 .SH "GIT"
1214 Part of the \fBgit\fR(1) suite
1215 .SH "NOTES"
1216 .IP " 1." 4
1217 The Git User\(cqs Manual
1218 .RS 4
1219 \%git-htmldocs/user-manual.html