Autogenerated HTML docs for v1.7.6-rc1
[git/jnareb-git.git] / gitglossary.html
blob1383355373e4a0dee863d6e6db0cae728dd33372
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <meta name="generator" content="AsciiDoc 8.4.5" />
7 <title>gitglossary(7)</title>
8 <style type="text/css">
9 /* Debug borders */
10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
12 border: 1px solid red;
16 body {
17 margin: 1em 5% 1em 5%;
20 a {
21 color: blue;
22 text-decoration: underline;
24 a:visited {
25 color: fuchsia;
28 em {
29 font-style: italic;
30 color: navy;
33 strong {
34 font-weight: bold;
35 color: #083194;
38 tt {
39 color: navy;
42 h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
50 h1, h2, h3 {
51 border-bottom: 2px solid silver;
53 h2 {
54 padding-top: 0.5em;
56 h3 {
57 float: left;
59 h3 + * {
60 clear: left;
63 div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
68 hr {
69 border: 1px solid silver;
72 p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
77 ul, ol, li > p {
78 margin-top: 0;
81 pre {
82 padding: 0;
83 margin: 0;
86 span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
90 font-size: 1.1em;
92 span#email {
94 span#revnumber, span#revdate, span#revremark {
95 font-family: sans-serif;
98 div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
105 div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
109 div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
114 div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120 div.admonitionblock {
121 margin-top: 1.5em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.5em;
126 margin-bottom: 2.5em;
129 div.content { /* Block element content. */
130 padding: 0;
133 /* Block element titles. */
134 div.title, caption.title {
135 color: #527bbd;
136 font-family: sans-serif;
137 font-weight: bold;
138 text-align: left;
139 margin-top: 1.0em;
140 margin-bottom: 0.5em;
142 div.title + * {
143 margin-top: 0;
146 td div.title:first-child {
147 margin-top: 0.0em;
149 div.content div.title:first-child {
150 margin-top: 0.0em;
152 div.content + div.title {
153 margin-top: 0.0em;
156 div.sidebarblock > div.content {
157 background: #ffffee;
158 border: 1px solid silver;
159 padding: 0.5em;
162 div.listingblock > div.content {
163 border: 1px solid silver;
164 background: #f4f4f4;
165 padding: 0.5em;
168 div.quoteblock {
169 padding-left: 2.0em;
170 margin-right: 10%;
172 div.quoteblock > div.attribution {
173 padding-top: 0.5em;
174 text-align: right;
177 div.verseblock {
178 padding-left: 2.0em;
179 margin-right: 10%;
181 div.verseblock > div.content {
182 white-space: pre;
184 div.verseblock > div.attribution {
185 padding-top: 0.75em;
186 text-align: left;
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
189 div.verseblock + div.attribution {
190 text-align: left;
193 div.admonitionblock .icon {
194 vertical-align: top;
195 font-size: 1.1em;
196 font-weight: bold;
197 text-decoration: underline;
198 color: #527bbd;
199 padding-right: 0.5em;
201 div.admonitionblock td.content {
202 padding-left: 0.5em;
203 border-left: 2px solid silver;
206 div.exampleblock > div.content {
207 border-left: 2px solid silver;
208 padding: 0.5em;
211 div.imageblock div.content { padding-left: 0; }
212 span.image img { border-style: none; }
213 a.image:visited { color: white; }
215 dl {
216 margin-top: 0.8em;
217 margin-bottom: 0.8em;
219 dt {
220 margin-top: 0.5em;
221 margin-bottom: 0;
222 font-style: normal;
223 color: navy;
225 dd > *:first-child {
226 margin-top: 0.1em;
229 ul, ol {
230 list-style-position: outside;
232 ol.arabic {
233 list-style-type: decimal;
235 ol.loweralpha {
236 list-style-type: lower-alpha;
238 ol.upperalpha {
239 list-style-type: upper-alpha;
241 ol.lowerroman {
242 list-style-type: lower-roman;
244 ol.upperroman {
245 list-style-type: upper-roman;
248 div.compact ul, div.compact ol,
249 div.compact p, div.compact p,
250 div.compact div, div.compact div {
251 margin-top: 0.1em;
252 margin-bottom: 0.1em;
255 div.tableblock > table {
256 border: 3px solid #527bbd;
258 thead {
259 font-family: sans-serif;
260 font-weight: bold;
262 tfoot {
263 font-weight: bold;
265 td > div.verse {
266 white-space: pre;
268 p.table {
269 margin-top: 0;
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
272 div.tableblock > table[frame="void"] {
273 border-style: none;
275 div.tableblock > table[frame="hsides"] {
276 border-left-style: none;
277 border-right-style: none;
279 div.tableblock > table[frame="vsides"] {
280 border-top-style: none;
281 border-bottom-style: none;
285 div.hdlist {
286 margin-top: 0.8em;
287 margin-bottom: 0.8em;
289 div.hdlist tr {
290 padding-bottom: 15px;
292 dt.hdlist1.strong, td.hdlist1.strong {
293 font-weight: bold;
295 td.hdlist1 {
296 vertical-align: top;
297 font-style: normal;
298 padding-right: 0.8em;
299 color: navy;
301 td.hdlist2 {
302 vertical-align: top;
304 div.hdlist.compact tr {
305 margin: 0;
306 padding-bottom: 0;
309 .comment {
310 background: yellow;
313 @media print {
314 div#footer-badges { display: none; }
317 div#toctitle {
318 color: #527bbd;
319 font-family: sans-serif;
320 font-size: 1.1em;
321 font-weight: bold;
322 margin-top: 1.0em;
323 margin-bottom: 0.1em;
326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
327 margin-top: 0;
328 margin-bottom: 0;
330 div.toclevel2 {
331 margin-left: 2em;
332 font-size: 0.9em;
334 div.toclevel3 {
335 margin-left: 4em;
336 font-size: 0.9em;
338 div.toclevel4 {
339 margin-left: 6em;
340 font-size: 0.9em;
342 /* Overrides for manpage documents */
343 h1 {
344 padding-top: 0.5em;
345 padding-bottom: 0.5em;
346 border-top: 2px solid silver;
347 border-bottom: 2px solid silver;
349 h2 {
350 border-style: none;
352 div.sectionbody {
353 margin-left: 5%;
356 @media print {
357 div#toc { display: none; }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
362 div.sidebar-content {
363 background: #ffffee;
364 border: 1px solid silver;
365 padding: 0.5em;
367 div.sidebar-title, div.image-title {
368 color: #527bbd;
369 font-family: sans-serif;
370 font-weight: bold;
371 margin-top: 0.0em;
372 margin-bottom: 0.5em;
375 div.listingblock div.content {
376 border: 1px solid silver;
377 background: #f4f4f4;
378 padding: 0.5em;
381 div.quoteblock-attribution {
382 padding-top: 0.5em;
383 text-align: right;
386 div.verseblock-content {
387 white-space: pre;
389 div.verseblock-attribution {
390 padding-top: 0.75em;
391 text-align: left;
394 div.exampleblock-content {
395 border-left: 2px solid silver;
396 padding-left: 0.5em;
399 /* IE6 sets dynamically generated links as visited. */
400 div#toc a:visited { color: blue; }
401 </style>
402 </head>
403 <body>
404 <div id="header">
405 <h1>
406 gitglossary(7) Manual Page
407 </h1>
408 <h2>NAME</h2>
409 <div class="sectionbody">
410 <p>gitglossary -
411 A GIT Glossary
412 </p>
413 </div>
414 </div>
415 <h2 id="_synopsis">SYNOPSIS</h2>
416 <div class="sectionbody">
417 <div class="paragraph"><p>*</p></div>
418 </div>
419 <h2 id="_description">DESCRIPTION</h2>
420 <div class="sectionbody">
421 <div class="dlist"><dl>
422 <dt class="hdlist1">
423 <a id="def_alternate_object_database"></a>alternate object database
424 </dt>
425 <dd>
427 Via the alternates mechanism, a <a href="#def_repository">repository</a>
428 can inherit part of its <a href="#def_object_database">object database</a>
429 from another object database, which is called "alternate".
430 </p>
431 </dd>
432 <dt class="hdlist1">
433 <a id="def_bare_repository"></a>bare repository
434 </dt>
435 <dd>
437 A bare repository is normally an appropriately
438 named <a href="#def_directory">directory</a> with a <tt>.git</tt> suffix that does not
439 have a locally checked-out copy of any of the files under
440 revision control. That is, all of the <tt>git</tt>
441 administrative and control files that would normally be present in the
442 hidden <tt>.git</tt> sub-directory are directly present in the
443 <tt>repository.git</tt> directory instead,
444 and no other files are present and checked out. Usually publishers of
445 public repositories make bare repositories available.
446 </p>
447 </dd>
448 <dt class="hdlist1">
449 <a id="def_blob_object"></a>blob object
450 </dt>
451 <dd>
453 Untyped <a href="#def_object">object</a>, e.g. the contents of a file.
454 </p>
455 </dd>
456 <dt class="hdlist1">
457 <a id="def_branch"></a>branch
458 </dt>
459 <dd>
461 A "branch" is an active line of development. The most recent
462 <a href="#def_commit">commit</a> on a branch is referred to as the tip of
463 that branch. The tip of the branch is referenced by a branch
464 <a href="#def_head">head</a>, which moves forward as additional development
465 is done on the branch. A single git
466 <a href="#def_repository">repository</a> can track an arbitrary number of
467 branches, but your <a href="#def_working_tree">working tree</a> is
468 associated with just one of them (the "current" or "checked out"
469 branch), and <a href="#def_HEAD">HEAD</a> points to that branch.
470 </p>
471 </dd>
472 <dt class="hdlist1">
473 <a id="def_cache"></a>cache
474 </dt>
475 <dd>
477 Obsolete for: <a href="#def_index">index</a>.
478 </p>
479 </dd>
480 <dt class="hdlist1">
481 <a id="def_chain"></a>chain
482 </dt>
483 <dd>
485 A list of objects, where each <a href="#def_object">object</a> in the list contains
486 a reference to its successor (for example, the successor of a
487 <a href="#def_commit">commit</a> could be one of its <a href="#def_parent">parents</a>).
488 </p>
489 </dd>
490 <dt class="hdlist1">
491 <a id="def_changeset"></a>changeset
492 </dt>
493 <dd>
495 BitKeeper/cvsps speak for "<a href="#def_commit">commit</a>". Since git does not
496 store changes, but states, it really does not make sense to use the term
497 "changesets" with git.
498 </p>
499 </dd>
500 <dt class="hdlist1">
501 <a id="def_checkout"></a>checkout
502 </dt>
503 <dd>
505 The action of updating all or part of the
506 <a href="#def_working_tree">working tree</a> with a <a href="#def_tree_object">tree object</a>
507 or <a href="#def_blob_object">blob</a> from the
508 <a href="#def_object_database">object database</a>, and updating the
509 <a href="#def_index">index</a> and <a href="#def_HEAD">HEAD</a> if the whole working tree has
510 been pointed at a new <a href="#def_branch">branch</a>.
511 </p>
512 </dd>
513 <dt class="hdlist1">
514 <a id="def_cherry-picking"></a>cherry-picking
515 </dt>
516 <dd>
518 In <a href="#def_SCM">SCM</a> jargon, "cherry pick" means to choose a subset of
519 changes out of a series of changes (typically commits) and record them
520 as a new series of changes on top of a different codebase. In GIT, this is
521 performed by the "git cherry-pick" command to extract the change introduced
522 by an existing <a href="#def_commit">commit</a> and to record it based on the tip
523 of the current <a href="#def_branch">branch</a> as a new commit.
524 </p>
525 </dd>
526 <dt class="hdlist1">
527 <a id="def_clean"></a>clean
528 </dt>
529 <dd>
531 A <a href="#def_working_tree">working tree</a> is clean, if it
532 corresponds to the <a href="#def_revision">revision</a> referenced by the current
533 <a href="#def_head">head</a>. Also see "<a href="#def_dirty">dirty</a>".
534 </p>
535 </dd>
536 <dt class="hdlist1">
537 <a id="def_commit"></a>commit
538 </dt>
539 <dd>
541 As a noun: A single point in the
542 git history; the entire history of a project is represented as a
543 set of interrelated commits. The word "commit" is often
544 used by git in the same places other revision control systems
545 use the words "revision" or "version". Also used as a short
546 hand for <a href="#def_commit_object">commit object</a>.
547 </p>
548 <div class="paragraph"><p>As a verb: The action of storing a new snapshot of the project&#8217;s
549 state in the git history, by creating a new commit representing the current
550 state of the <a href="#def_index">index</a> and advancing <a href="#def_HEAD">HEAD</a>
551 to point at the new commit.</p></div>
552 </dd>
553 <dt class="hdlist1">
554 <a id="def_commit_object"></a>commit object
555 </dt>
556 <dd>
558 An <a href="#def_object">object</a> which contains the information about a
559 particular <a href="#def_revision">revision</a>, such as <a href="#def_parent">parents</a>, committer,
560 author, date and the <a href="#def_tree_object">tree object</a> which corresponds
561 to the top <a href="#def_directory">directory</a> of the stored
562 revision.
563 </p>
564 </dd>
565 <dt class="hdlist1">
566 <a id="def_core_git"></a>core git
567 </dt>
568 <dd>
570 Fundamental data structures and utilities of git. Exposes only limited
571 source code management tools.
572 </p>
573 </dd>
574 <dt class="hdlist1">
575 <a id="def_DAG"></a>DAG
576 </dt>
577 <dd>
579 Directed acyclic graph. The <a href="#def_commit_object">commit objects</a> form a
580 directed acyclic graph, because they have parents (directed), and the
581 graph of commit objects is acyclic (there is no <a href="#def_chain">chain</a>
582 which begins and ends with the same <a href="#def_object">object</a>).
583 </p>
584 </dd>
585 <dt class="hdlist1">
586 <a id="def_dangling_object"></a>dangling object
587 </dt>
588 <dd>
590 An <a href="#def_unreachable_object">unreachable object</a> which is not
591 <a href="#def_reachable">reachable</a> even from other unreachable objects; a
592 dangling object has no references to it from any
593 reference or <a href="#def_object">object</a> in the <a href="#def_repository">repository</a>.
594 </p>
595 </dd>
596 <dt class="hdlist1">
597 <a id="def_detached_HEAD"></a>detached HEAD
598 </dt>
599 <dd>
601 Normally the <a href="#def_HEAD">HEAD</a> stores the name of a
602 <a href="#def_branch">branch</a>. However, git also allows you to <a href="#def_checkout">check out</a>
603 an arbitrary <a href="#def_commit">commit</a> that isn&#8217;t necessarily the tip of any
604 particular branch. In this case HEAD is said to be "detached".
605 </p>
606 </dd>
607 <dt class="hdlist1">
608 <a id="def_dircache"></a>dircache
609 </dt>
610 <dd>
612 You are <strong>waaaaay</strong> behind. See <a href="#def_index">index</a>.
613 </p>
614 </dd>
615 <dt class="hdlist1">
616 <a id="def_directory"></a>directory
617 </dt>
618 <dd>
620 The list you get with "ls" :-)
621 </p>
622 </dd>
623 <dt class="hdlist1">
624 <a id="def_dirty"></a>dirty
625 </dt>
626 <dd>
628 A <a href="#def_working_tree">working tree</a> is said to be "dirty" if
629 it contains modifications which have not been <a href="#def_commit">committed</a> to the current
630 <a href="#def_branch">branch</a>.
631 </p>
632 </dd>
633 <dt class="hdlist1">
634 <a id="def_ent"></a>ent
635 </dt>
636 <dd>
638 Favorite synonym to "<a href="#def_tree-ish">tree-ish</a>" by some total geeks. See
639 <tt>http://en.wikipedia.org/wiki/Ent_(Middle-earth)</tt> for an in-depth
640 explanation. Avoid this term, not to confuse people.
641 </p>
642 </dd>
643 <dt class="hdlist1">
644 <a id="def_evil_merge"></a>evil merge
645 </dt>
646 <dd>
648 An evil merge is a <a href="#def_merge">merge</a> that introduces changes that
649 do not appear in any <a href="#def_parent">parent</a>.
650 </p>
651 </dd>
652 <dt class="hdlist1">
653 <a id="def_fast_forward"></a>fast-forward
654 </dt>
655 <dd>
657 A fast-forward is a special type of <a href="#def_merge">merge</a> where you have a
658 <a href="#def_revision">revision</a> and you are "merging" another
659 <a href="#def_branch">branch</a>'s changes that happen to be a descendant of what
660 you have. In such these cases, you do not make a new <a href="#def_merge">merge</a>
661 <a href="#def_commit">commit</a> but instead just update to his
662 revision. This will happen frequently on a
663 <a href="#def_remote_tracking_branch">remote-tracking branch</a> of a remote
664 <a href="#def_repository">repository</a>.
665 </p>
666 </dd>
667 <dt class="hdlist1">
668 <a id="def_fetch"></a>fetch
669 </dt>
670 <dd>
672 Fetching a <a href="#def_branch">branch</a> means to get the
673 branch&#8217;s <a href="#def_head_ref">head ref</a> from a remote
674 <a href="#def_repository">repository</a>, to find out which objects are
675 missing from the local <a href="#def_object_database">object database</a>,
676 and to get them, too. See also <a href="git-fetch.html">git-fetch(1)</a>.
677 </p>
678 </dd>
679 <dt class="hdlist1">
680 <a id="def_file_system"></a>file system
681 </dt>
682 <dd>
684 Linus Torvalds originally designed git to be a user space file system,
685 i.e. the infrastructure to hold files and directories. That ensured the
686 efficiency and speed of git.
687 </p>
688 </dd>
689 <dt class="hdlist1">
690 <a id="def_git_archive"></a>git archive
691 </dt>
692 <dd>
694 Synonym for <a href="#def_repository">repository</a> (for arch people).
695 </p>
696 </dd>
697 <dt class="hdlist1">
698 <a id="def_grafts"></a>grafts
699 </dt>
700 <dd>
702 Grafts enables two otherwise different lines of development to be joined
703 together by recording fake ancestry information for commits. This way
704 you can make git pretend the set of <a href="#def_parent">parents</a> a <a href="#def_commit">commit</a> has
705 is different from what was recorded when the commit was
706 created. Configured via the <tt>.git/info/grafts</tt> file.
707 </p>
708 </dd>
709 <dt class="hdlist1">
710 <a id="def_hash"></a>hash
711 </dt>
712 <dd>
714 In git&#8217;s context, synonym to <a href="#def_object_name">object name</a>.
715 </p>
716 </dd>
717 <dt class="hdlist1">
718 <a id="def_head"></a>head
719 </dt>
720 <dd>
722 A <a href="#def_ref">named reference</a> to the <a href="#def_commit">commit</a> at the tip of a
723 <a href="#def_branch">branch</a>. Heads are stored in
724 <tt>$GIT_DIR/refs/heads/</tt>, except when using packed refs. (See
725 <a href="git-pack-refs.html">git-pack-refs(1)</a>.)
726 </p>
727 </dd>
728 <dt class="hdlist1">
729 <a id="def_HEAD"></a>HEAD
730 </dt>
731 <dd>
733 The current <a href="#def_branch">branch</a>. In more detail: Your <a href="#def_working_tree">working tree</a> is normally derived from the state of the tree
734 referred to by HEAD. HEAD is a reference to one of the
735 <a href="#def_head">heads</a> in your repository, except when using a
736 <a href="#def_detached_HEAD">detached HEAD</a>, in which case it may
737 reference an arbitrary commit.
738 </p>
739 </dd>
740 <dt class="hdlist1">
741 <a id="def_head_ref"></a>head ref
742 </dt>
743 <dd>
745 A synonym for <a href="#def_head">head</a>.
746 </p>
747 </dd>
748 <dt class="hdlist1">
749 <a id="def_hook"></a>hook
750 </dt>
751 <dd>
753 During the normal execution of several git commands, call-outs are made
754 to optional scripts that allow a developer to add functionality or
755 checking. Typically, the hooks allow for a command to be pre-verified
756 and potentially aborted, and allow for a post-notification after the
757 operation is done. The hook scripts are found in the
758 <tt>$GIT_DIR/hooks/</tt> directory, and are enabled by simply
759 removing the <tt>.sample</tt> suffix from the filename. In earlier versions
760 of git you had to make them executable.
761 </p>
762 </dd>
763 <dt class="hdlist1">
764 <a id="def_index"></a>index
765 </dt>
766 <dd>
768 A collection of files with stat information, whose contents are stored
769 as objects. The index is a stored version of your
770 <a href="#def_working_tree">working tree</a>. Truth be told, it can also contain a second, and even
771 a third version of a working tree, which are used
772 when <a href="#def_merge">merging</a>.
773 </p>
774 </dd>
775 <dt class="hdlist1">
776 <a id="def_index_entry"></a>index entry
777 </dt>
778 <dd>
780 The information regarding a particular file, stored in the
781 <a href="#def_index">index</a>. An index entry can be unmerged, if a
782 <a href="#def_merge">merge</a> was started, but not yet finished (i.e. if
783 the index contains multiple versions of that file).
784 </p>
785 </dd>
786 <dt class="hdlist1">
787 <a id="def_master"></a>master
788 </dt>
789 <dd>
791 The default development <a href="#def_branch">branch</a>. Whenever you
792 create a git <a href="#def_repository">repository</a>, a branch named
793 "master" is created, and becomes the active branch. In most
794 cases, this contains the local development, though that is
795 purely by convention and is not required.
796 </p>
797 </dd>
798 <dt class="hdlist1">
799 <a id="def_merge"></a>merge
800 </dt>
801 <dd>
803 As a verb: To bring the contents of another
804 <a href="#def_branch">branch</a> (possibly from an external
805 <a href="#def_repository">repository</a>) into the current branch. In the
806 case where the merged-in branch is from a different repository,
807 this is done by first <a href="#def_fetch">fetching</a> the remote branch
808 and then merging the result into the current branch. This
809 combination of fetch and merge operations is called a
810 <a href="#def_pull">pull</a>. Merging is performed by an automatic process
811 that identifies changes made since the branches diverged, and
812 then applies all those changes together. In cases where changes
813 conflict, manual intervention may be required to complete the
814 merge.
815 </p>
816 <div class="paragraph"><p>As a noun: unless it is a <a href="#def_fast_forward">fast-forward</a>, a
817 successful merge results in the creation of a new <a href="#def_commit">commit</a>
818 representing the result of the merge, and having as
819 <a href="#def_parent">parents</a> the tips of the merged <a href="#def_branch">branches</a>.
820 This commit is referred to as a "merge commit", or sometimes just a
821 "merge".</p></div>
822 </dd>
823 <dt class="hdlist1">
824 <a id="def_object"></a>object
825 </dt>
826 <dd>
828 The unit of storage in git. It is uniquely identified by the
829 <a href="#def_SHA1">SHA1</a> of its contents. Consequently, an
830 object can not be changed.
831 </p>
832 </dd>
833 <dt class="hdlist1">
834 <a id="def_object_database"></a>object database
835 </dt>
836 <dd>
838 Stores a set of "objects", and an individual <a href="#def_object">object</a> is
839 identified by its <a href="#def_object_name">object name</a>. The objects usually
840 live in <tt>$GIT_DIR/objects/</tt>.
841 </p>
842 </dd>
843 <dt class="hdlist1">
844 <a id="def_object_identifier"></a>object identifier
845 </dt>
846 <dd>
848 Synonym for <a href="#def_object_name">object name</a>.
849 </p>
850 </dd>
851 <dt class="hdlist1">
852 <a id="def_object_name"></a>object name
853 </dt>
854 <dd>
856 The unique identifier of an <a href="#def_object">object</a>. The <a href="#def_hash">hash</a>
857 of the object&#8217;s contents using the Secure Hash Algorithm
858 1 and usually represented by the 40 character hexadecimal encoding of
859 the <a href="#def_hash">hash</a> of the object.
860 </p>
861 </dd>
862 <dt class="hdlist1">
863 <a id="def_object_type"></a>object type
864 </dt>
865 <dd>
867 One of the identifiers "<a href="#def_commit_object">commit</a>",
868 "<a href="#def_tree_object">tree</a>", "<a href="#def_tag_object">tag</a>" or
869 "<a href="#def_blob_object">blob</a>" describing the type of an
870 <a href="#def_object">object</a>.
871 </p>
872 </dd>
873 <dt class="hdlist1">
874 <a id="def_octopus"></a>octopus
875 </dt>
876 <dd>
878 To <a href="#def_merge">merge</a> more than two <a href="#def_branch">branches</a>. Also denotes an
879 intelligent predator.
880 </p>
881 </dd>
882 <dt class="hdlist1">
883 <a id="def_origin"></a>origin
884 </dt>
885 <dd>
887 The default upstream <a href="#def_repository">repository</a>. Most projects have
888 at least one upstream project which they track. By default
889 <em>origin</em> is used for that purpose. New upstream updates
890 will be fetched into remote <a href="#def_remote_tracking_branch">remote-tracking branches</a> named
891 origin/name-of-upstream-branch, which you can see using
892 <tt>git branch -r</tt>.
893 </p>
894 </dd>
895 <dt class="hdlist1">
896 <a id="def_pack"></a>pack
897 </dt>
898 <dd>
900 A set of objects which have been compressed into one file (to save space
901 or to transmit them efficiently).
902 </p>
903 </dd>
904 <dt class="hdlist1">
905 <a id="def_pack_index"></a>pack index
906 </dt>
907 <dd>
909 The list of identifiers, and other information, of the objects in a
910 <a href="#def_pack">pack</a>, to assist in efficiently accessing the contents of a
911 pack.
912 </p>
913 </dd>
914 <dt class="hdlist1">
915 <a id="def_pathspec"></a>pathspec
916 </dt>
917 <dd>
919 Pattern used to specify paths.
920 </p>
921 <div class="paragraph"><p>Pathspecs are used on the command line of "git ls-files", "git
922 ls-tree", "git add", "git grep", "git diff", "git checkout",
923 and many other commands to
924 limit the scope of operations to some subset of the tree or
925 worktree. See the documentation of each command for whether
926 paths are relative to the current directory or toplevel. The
927 pathspec syntax is as follows:</p></div>
928 <div class="ulist"><ul>
929 <li>
931 any path matches itself
932 </p>
933 </li>
934 <li>
936 the pathspec up to the last slash represents a
937 directory prefix. The scope of that pathspec is
938 limited to that subtree.
939 </p>
940 </li>
941 <li>
943 the rest of the pathspec is a pattern for the remainder
944 of the pathname. Paths relative to the directory
945 prefix will be matched against that pattern using fnmatch(3);
946 in particular, <em>*</em> and <em>?</em> <em>can</em> match directory separators.
947 </p>
948 <div class="paragraph"><p>For example, Documentation/*.jpg will match all .jpg files
949 in the Documentation subtree,
950 including Documentation/chapter_1/figure_1.jpg.</p></div>
951 </li>
952 </ul></div>
953 <div class="paragraph"><p>A pathspec that begins with a colon <tt>:</tt> has special meaning. In the
954 short form, the leading colon <tt>:</tt> is followed by zero or more "magic
955 signature" letters (which optionally is terminated by another colon <tt>:</tt>),
956 and the remainder is the pattern to match against the path. The optional
957 colon that terminates the "magic signature" can be omitted if the pattern
958 begins with a character that cannot be a "magic signature" and is not a
959 colon.</p></div>
960 <div class="paragraph"><p>In the long form, the leading colon <tt>:</tt> is followed by a open
961 parenthesis <tt>(</tt>, a comma-separated list of zero or more "magic words",
962 and a close parentheses <tt>)</tt>, and the remainder is the pattern to match
963 against the path.</p></div>
964 <div class="paragraph"><p>The "magic signature" consists of an ASCII symbol that is not
965 alphanumeric.</p></div>
966 <div class="dlist"><dl>
967 <dt class="hdlist1">
968 top <tt>/</tt>
969 </dt>
970 <dd>
972 The magic word <tt>top</tt> (mnemonic: <tt>/</tt>) makes the pattern match
973 from the root of the working tree, even when you are running
974 the command from inside a subdirectory.
975 </p>
976 </dd>
977 </dl></div>
978 <div class="paragraph"><p>Currently only the slash <tt>/</tt> is recognized as the "magic signature",
979 but it is envisioned that we will support more types of magic in later
980 versions of git.</p></div>
981 <div class="paragraph"><p>A pathspec with only a colon means "there is no pathspec". This form
982 should not be combined with other pathspec.</p></div>
983 </dd>
984 <dt class="hdlist1">
985 <a id="def_parent"></a>parent
986 </dt>
987 <dd>
989 A <a href="#def_commit_object">commit object</a> contains a (possibly empty) list
990 of the logical predecessor(s) in the line of development, i.e. its
991 parents.
992 </p>
993 </dd>
994 <dt class="hdlist1">
995 <a id="def_pickaxe"></a>pickaxe
996 </dt>
997 <dd>
999 The term <a href="#def_pickaxe">pickaxe</a> refers to an option to the diffcore
1000 routines that help select changes that add or delete a given text
1001 string. With the <tt>--pickaxe-all</tt> option, it can be used to view the full
1002 <a href="#def_changeset">changeset</a> that introduced or removed, say, a
1003 particular line of text. See <a href="git-diff.html">git-diff(1)</a>.
1004 </p>
1005 </dd>
1006 <dt class="hdlist1">
1007 <a id="def_plumbing"></a>plumbing
1008 </dt>
1009 <dd>
1011 Cute name for <a href="#def_core_git">core git</a>.
1012 </p>
1013 </dd>
1014 <dt class="hdlist1">
1015 <a id="def_porcelain"></a>porcelain
1016 </dt>
1017 <dd>
1019 Cute name for programs and program suites depending on
1020 <a href="#def_core_git">core git</a>, presenting a high level access to
1021 core git. Porcelains expose more of a <a href="#def_SCM">SCM</a>
1022 interface than the <a href="#def_plumbing">plumbing</a>.
1023 </p>
1024 </dd>
1025 <dt class="hdlist1">
1026 <a id="def_pull"></a>pull
1027 </dt>
1028 <dd>
1030 Pulling a <a href="#def_branch">branch</a> means to <a href="#def_fetch">fetch</a> it and
1031 <a href="#def_merge">merge</a> it. See also <a href="git-pull.html">git-pull(1)</a>.
1032 </p>
1033 </dd>
1034 <dt class="hdlist1">
1035 <a id="def_push"></a>push
1036 </dt>
1037 <dd>
1039 Pushing a <a href="#def_branch">branch</a> means to get the branch&#8217;s
1040 <a href="#def_head_ref">head ref</a> from a remote <a href="#def_repository">repository</a>,
1041 find out if it is a direct ancestor to the branch&#8217;s local
1042 head ref, and in that case, putting all
1043 objects, which are <a href="#def_reachable">reachable</a> from the local
1044 head ref, and which are missing from the remote
1045 repository, into the remote
1046 <a href="#def_object_database">object database</a>, and updating the remote
1047 head ref. If the remote <a href="#def_head">head</a> is not an
1048 ancestor to the local head, the push fails.
1049 </p>
1050 </dd>
1051 <dt class="hdlist1">
1052 <a id="def_reachable"></a>reachable
1053 </dt>
1054 <dd>
1056 All of the ancestors of a given <a href="#def_commit">commit</a> are said to be
1057 "reachable" from that commit. More
1058 generally, one <a href="#def_object">object</a> is reachable from
1059 another if we can reach the one from the other by a <a href="#def_chain">chain</a>
1060 that follows <a href="#def_tag">tags</a> to whatever they tag,
1061 <a href="#def_commit_object">commits</a> to their parents or trees, and
1062 <a href="#def_tree_object">trees</a> to the trees or <a href="#def_blob_object">blobs</a>
1063 that they contain.
1064 </p>
1065 </dd>
1066 <dt class="hdlist1">
1067 <a id="def_rebase"></a>rebase
1068 </dt>
1069 <dd>
1071 To reapply a series of changes from a <a href="#def_branch">branch</a> to a
1072 different base, and reset the <a href="#def_head">head</a> of that branch
1073 to the result.
1074 </p>
1075 </dd>
1076 <dt class="hdlist1">
1077 <a id="def_ref"></a>ref
1078 </dt>
1079 <dd>
1081 A 40-byte hex representation of a <a href="#def_SHA1">SHA1</a> or a name that
1082 denotes a particular <a href="#def_object">object</a>. These may be stored in
1083 <tt>$GIT_DIR/refs/</tt>.
1084 </p>
1085 </dd>
1086 <dt class="hdlist1">
1087 <a id="def_reflog"></a>reflog
1088 </dt>
1089 <dd>
1091 A reflog shows the local "history" of a ref. In other words,
1092 it can tell you what the 3rd last revision in <em>this</em> repository
1093 was, and what was the current state in <em>this</em> repository,
1094 yesterday 9:14pm. See <a href="git-reflog.html">git-reflog(1)</a> for details.
1095 </p>
1096 </dd>
1097 <dt class="hdlist1">
1098 <a id="def_refspec"></a>refspec
1099 </dt>
1100 <dd>
1102 A "refspec" is used by <a href="#def_fetch">fetch</a> and
1103 <a href="#def_push">push</a> to describe the mapping between remote
1104 <a href="#def_ref">ref</a> and local ref. They are combined with a colon in
1105 the format &lt;src&gt;:&lt;dst&gt;, preceded by an optional plus sign, +.
1106 For example: <tt>git fetch $URL
1107 refs/heads/master:refs/heads/origin</tt> means "grab the master
1108 <a href="#def_branch">branch</a> <a href="#def_head">head</a> from the $URL and store
1109 it as my origin branch head". And <tt>git push
1110 $URL refs/heads/master:refs/heads/to-upstream</tt> means "publish my
1111 master branch head as to-upstream branch at $URL". See also
1112 <a href="git-push.html">git-push(1)</a>.
1113 </p>
1114 </dd>
1115 <dt class="hdlist1">
1116 <a id="def_remote_tracking_branch"></a>remote-tracking branch
1117 </dt>
1118 <dd>
1120 A regular git <a href="#def_branch">branch</a> that is used to follow changes from
1121 another <a href="#def_repository">repository</a>. A remote-tracking
1122 branch should not contain direct modifications or have local commits
1123 made to it. A remote-tracking branch can usually be
1124 identified as the right-hand-side <a href="#def_ref">ref</a> in a Pull:
1125 <a href="#def_refspec">refspec</a>.
1126 </p>
1127 </dd>
1128 <dt class="hdlist1">
1129 <a id="def_repository"></a>repository
1130 </dt>
1131 <dd>
1133 A collection of <a href="#def_ref">refs</a> together with an
1134 <a href="#def_object_database">object database</a> containing all objects
1135 which are <a href="#def_reachable">reachable</a> from the refs, possibly
1136 accompanied by meta data from one or more <a href="#def_porcelain">porcelains</a>. A
1137 repository can share an object database with other repositories
1138 via <a href="#def_alternate_object_database">alternates mechanism</a>.
1139 </p>
1140 </dd>
1141 <dt class="hdlist1">
1142 <a id="def_resolve"></a>resolve
1143 </dt>
1144 <dd>
1146 The action of fixing up manually what a failed automatic
1147 <a href="#def_merge">merge</a> left behind.
1148 </p>
1149 </dd>
1150 <dt class="hdlist1">
1151 <a id="def_revision"></a>revision
1152 </dt>
1153 <dd>
1155 A particular state of files and directories which was stored in the
1156 <a href="#def_object_database">object database</a>. It is referenced by a
1157 <a href="#def_commit_object">commit object</a>.
1158 </p>
1159 </dd>
1160 <dt class="hdlist1">
1161 <a id="def_rewind"></a>rewind
1162 </dt>
1163 <dd>
1165 To throw away part of the development, i.e. to assign the
1166 <a href="#def_head">head</a> to an earlier <a href="#def_revision">revision</a>.
1167 </p>
1168 </dd>
1169 <dt class="hdlist1">
1170 <a id="def_SCM"></a>SCM
1171 </dt>
1172 <dd>
1174 Source code management (tool).
1175 </p>
1176 </dd>
1177 <dt class="hdlist1">
1178 <a id="def_SHA1"></a>SHA1
1179 </dt>
1180 <dd>
1182 Synonym for <a href="#def_object_name">object name</a>.
1183 </p>
1184 </dd>
1185 <dt class="hdlist1">
1186 <a id="def_shallow_repository"></a>shallow repository
1187 </dt>
1188 <dd>
1190 A shallow <a href="#def_repository">repository</a> has an incomplete
1191 history some of whose <a href="#def_commit">commits</a> have <a href="#def_parent">parents</a> cauterized away (in other
1192 words, git is told to pretend that these commits do not have the
1193 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
1194 recent history of a project even though the real history recorded in the
1195 upstream is much larger. A shallow repository
1196 is created by giving the <tt>--depth</tt> option to <a href="git-clone.html">git-clone(1)</a>, and
1197 its history can be later deepened with <a href="git-fetch.html">git-fetch(1)</a>.
1198 </p>
1199 </dd>
1200 <dt class="hdlist1">
1201 <a id="def_symref"></a>symref
1202 </dt>
1203 <dd>
1205 Symbolic reference: instead of containing the <a href="#def_SHA1">SHA1</a>
1206 id itself, it is of the format <em>ref: refs/some/thing</em> and when
1207 referenced, it recursively dereferences to this reference.
1208 <em><a href="#def_HEAD">HEAD</a></em> is a prime example of a symref. Symbolic
1209 references are manipulated with the <a href="git-symbolic-ref.html">git-symbolic-ref(1)</a>
1210 command.
1211 </p>
1212 </dd>
1213 <dt class="hdlist1">
1214 <a id="def_tag"></a>tag
1215 </dt>
1216 <dd>
1218 A <a href="#def_ref">ref</a> pointing to a <a href="#def_tag_object">tag</a> or
1219 <a href="#def_commit_object">commit object</a>. In contrast to a <a href="#def_head">head</a>,
1220 a tag is not changed by a <a href="#def_commit">commit</a>. Tags (not
1221 <a href="#def_tag_object">tag objects</a>) are stored in <tt>$GIT_DIR/refs/tags/</tt>. A
1222 git tag has nothing to do with a Lisp tag (which would be
1223 called an <a href="#def_object_type">object type</a> in git&#8217;s context). A
1224 tag is most typically used to mark a particular point in the
1225 commit ancestry <a href="#def_chain">chain</a>.
1226 </p>
1227 </dd>
1228 <dt class="hdlist1">
1229 <a id="def_tag_object"></a>tag object
1230 </dt>
1231 <dd>
1233 An <a href="#def_object">object</a> containing a <a href="#def_ref">ref</a> pointing to
1234 another object, which can contain a message just like a
1235 <a href="#def_commit_object">commit object</a>. It can also contain a (PGP)
1236 signature, in which case it is called a "signed tag object".
1237 </p>
1238 </dd>
1239 <dt class="hdlist1">
1240 <a id="def_topic_branch"></a>topic branch
1241 </dt>
1242 <dd>
1244 A regular git <a href="#def_branch">branch</a> that is used by a developer to
1245 identify a conceptual line of development. Since branches are very easy
1246 and inexpensive, it is often desirable to have several small branches
1247 that each contain very well defined concepts or small incremental yet
1248 related changes.
1249 </p>
1250 </dd>
1251 <dt class="hdlist1">
1252 <a id="def_tree"></a>tree
1253 </dt>
1254 <dd>
1256 Either a <a href="#def_working_tree">working tree</a>, or a <a href="#def_tree_object">tree object</a> together with the dependent <a href="#def_blob_object">blob</a> and tree objects
1257 (i.e. a stored representation of a working tree).
1258 </p>
1259 </dd>
1260 <dt class="hdlist1">
1261 <a id="def_tree_object"></a>tree object
1262 </dt>
1263 <dd>
1265 An <a href="#def_object">object</a> containing a list of file names and modes along
1266 with refs to the associated blob and/or tree objects. A
1267 <a href="#def_tree">tree</a> is equivalent to a <a href="#def_directory">directory</a>.
1268 </p>
1269 </dd>
1270 <dt class="hdlist1">
1271 <a id="def_tree-ish"></a>tree-ish
1272 </dt>
1273 <dd>
1275 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 tag or commit or tree object.
1276 </p>
1277 </dd>
1278 <dt class="hdlist1">
1279 <a id="def_unmerged_index"></a>unmerged index
1280 </dt>
1281 <dd>
1283 An <a href="#def_index">index</a> which contains unmerged
1284 <a href="#def_index_entry">index entries</a>.
1285 </p>
1286 </dd>
1287 <dt class="hdlist1">
1288 <a id="def_unreachable_object"></a>unreachable object
1289 </dt>
1290 <dd>
1292 An <a href="#def_object">object</a> which is not <a href="#def_reachable">reachable</a> from a
1293 <a href="#def_branch">branch</a>, <a href="#def_tag">tag</a>, or any other reference.
1294 </p>
1295 </dd>
1296 <dt class="hdlist1">
1297 <a id="def_upstream_branch"></a>upstream branch
1298 </dt>
1299 <dd>
1301 The default <a href="#def_branch">branch</a> that is merged into the branch in
1302 question (or the branch in question is rebased onto). It is configured
1303 via branch.&lt;name&gt;.remote and branch.&lt;name&gt;.merge. If the upstream branch
1304 of <em>A</em> is <em>origin/B</em> sometimes we say "<em>A</em> is tracking <em>origin/B</em>".
1305 </p>
1306 </dd>
1307 <dt class="hdlist1">
1308 <a id="def_working_tree"></a>working tree
1309 </dt>
1310 <dd>
1312 The tree of actual checked out files. The working tree normally
1313 contains the contents of the <a href="#def_HEAD">HEAD</a> commit&#8217;s tree,
1314 plus any local changes that you have made but not yet committed.
1315 </p>
1316 </dd>
1317 </dl></div>
1318 </div>
1319 <h2 id="_see_also">SEE ALSO</h2>
1320 <div class="sectionbody">
1321 <div class="paragraph"><p><a href="gittutorial.html">gittutorial(7)</a>,
1322 <a href="gittutorial-2.html">gittutorial-2(7)</a>,
1323 <a href="gitcvs-migration.html">gitcvs-migration(7)</a>,
1324 <a href="everyday.html">Everyday git</a>,
1325 <a href="user-manual.html">The Git User&#8217;s Manual</a></p></div>
1326 </div>
1327 <h2 id="_git">GIT</h2>
1328 <div class="sectionbody">
1329 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite.</p></div>
1330 </div>
1331 <div id="footer">
1332 <div id="footer-text">
1333 Last updated 2008-11-15 08:07:36 UTC
1334 </div>
1335 </div>
1336 </body>
1337 </html>