| blob | 1c2ac2640089d89447ebb6dfddaf84b95105c243 |
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">\r
3 \r
4 <article lang="en" id="gitglossary(7)">\r
5 <articleinfo>\r
6 <title>gitglossary(7)</title>\r
7 <indexterm>\r
8 <primary>gitglossary(7)</primary>\r
9 </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>gitglossary - A GIT Glossary</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <simpara>*</simpara>\r
18 </simplesect>\r
19 <simplesect id="_description">\r
20 <title>DESCRIPTION</title>\r
21 <variablelist>\r
22 <varlistentry>\r
23 <term>\r
24 <anchor id="def_alternate_object_database" xreflabel="[def_alternate_object_database]"/>alternate object database\r
25 </term>\r
26 <listitem>\r
27 <simpara>\r
28 Via the alternates mechanism, a <link linkend="def_repository">repository</link>\r
29 can inherit part of its <link linkend="def_object_database">object database</link>\r
30 from another object database, which is called "alternate".\r
31 </simpara>\r
32 </listitem>\r
33 </varlistentry>\r
34 <varlistentry>\r
35 <term>\r
36 <anchor id="def_bare_repository" xreflabel="[def_bare_repository]"/>bare repository\r
37 </term>\r
38 <listitem>\r
39 <simpara>\r
40 A bare repository is normally an appropriately\r
41 named <link linkend="def_directory">directory</link> with a <emphasis>.git</emphasis> suffix that does not\r
42 have a locally checked-out copy of any of the files under\r
43 revision control. That is, all of the <emphasis>git</emphasis>\r
44 administrative and control files that would normally be present in the\r
45 hidden <emphasis>.git</emphasis> sub-directory are directly present in the\r
46 <emphasis>repository.git</emphasis> directory instead,\r
47 and no other files are present and checked out. Usually publishers of\r
48 public repositories make bare repositories available.\r
49 </simpara>\r
50 </listitem>\r
51 </varlistentry>\r
52 <varlistentry>\r
53 <term>\r
54 <anchor id="def_blob_object" xreflabel="[def_blob_object]"/>blob object\r
55 </term>\r
56 <listitem>\r
57 <simpara>\r
58 Untyped <link linkend="def_object">object</link>, e.g. the contents of a file.\r
59 </simpara>\r
60 </listitem>\r
61 </varlistentry>\r
62 <varlistentry>\r
63 <term>\r
64 <anchor id="def_branch" xreflabel="[def_branch]"/>branch\r
65 </term>\r
66 <listitem>\r
67 <simpara>\r
68 A "branch" is an active line of development. The most recent\r
69 <link linkend="def_commit">commit</link> on a branch is referred to as the tip of\r
70 that branch. The tip of the branch is referenced by a branch\r
71 <link linkend="def_head">head</link>, which moves forward as additional development\r
72 is done on the branch. A single git\r
73 <link linkend="def_repository">repository</link> can track an arbitrary number of\r
74 branches, but your <link linkend="def_working_tree">working tree</link> is\r
75 associated with just one of them (the "current" or "checked out"\r
76 branch), and <link linkend="def_HEAD">HEAD</link> points to that branch.\r
77 </simpara>\r
78 </listitem>\r
79 </varlistentry>\r
80 <varlistentry>\r
81 <term>\r
82 <anchor id="def_cache" xreflabel="[def_cache]"/>cache\r
83 </term>\r
84 <listitem>\r
85 <simpara>\r
86 Obsolete for: <link linkend="def_index">index</link>.\r
87 </simpara>\r
88 </listitem>\r
89 </varlistentry>\r
90 <varlistentry>\r
91 <term>\r
92 <anchor id="def_chain" xreflabel="[def_chain]"/>chain\r
93 </term>\r
94 <listitem>\r
95 <simpara>\r
96 A list of objects, where each <link linkend="def_object">object</link> in the list contains\r
97 a reference to its successor (for example, the successor of a\r
98 <link linkend="def_commit">commit</link> could be one of its <link linkend="def_parent">parents</link>).\r
99 </simpara>\r
100 </listitem>\r
101 </varlistentry>\r
102 <varlistentry>\r
103 <term>\r
104 <anchor id="def_changeset" xreflabel="[def_changeset]"/>changeset\r
105 </term>\r
106 <listitem>\r
107 <simpara>\r
108 BitKeeper/cvsps speak for "<link linkend="def_commit">commit</link>". Since git does not\r
109 store changes, but states, it really does not make sense to use the term\r
110 "changesets" with git.\r
111 </simpara>\r
112 </listitem>\r
113 </varlistentry>\r
114 <varlistentry>\r
115 <term>\r
116 <anchor id="def_checkout" xreflabel="[def_checkout]"/>checkout\r
117 </term>\r
118 <listitem>\r
119 <simpara>\r
120 The action of updating all or part of the\r
121 <link linkend="def_working_tree">working tree</link> with a <link linkend="def_tree_object">tree object</link>\r
122 or <link linkend="def_blob_object">blob</link> from the\r
123 <link linkend="def_object_database">object database</link>, and updating the\r
124 <link linkend="def_index">index</link> and <link linkend="def_HEAD">HEAD</link> if the whole working tree has\r
125 been pointed at a new <link linkend="def_branch">branch</link>.\r
126 </simpara>\r
127 </listitem>\r
128 </varlistentry>\r
129 <varlistentry>\r
130 <term>\r
131 <anchor id="def_cherry-picking" xreflabel="[def_cherry-picking]"/>cherry-picking\r
132 </term>\r
133 <listitem>\r
134 <simpara>\r
135 In <link linkend="def_SCM">SCM</link> jargon, "cherry pick" means to choose a subset of\r
136 changes out of a series of changes (typically commits) and record them\r
137 as a new series of changes on top of a different codebase. In GIT, this is\r
138 performed by the "git cherry-pick" command to extract the change introduced\r
139 by an existing <link linkend="def_commit">commit</link> and to record it based on the tip\r
140 of the current <link linkend="def_branch">branch</link> as a new commit.\r
141 </simpara>\r
142 </listitem>\r
143 </varlistentry>\r
144 <varlistentry>\r
145 <term>\r
146 <anchor id="def_clean" xreflabel="[def_clean]"/>clean\r
147 </term>\r
148 <listitem>\r
149 <simpara>\r
150 A <link linkend="def_working_tree">working tree</link> is clean, if it\r
151 corresponds to the <link linkend="def_revision">revision</link> referenced by the current\r
152 <link linkend="def_head">head</link>. Also see "<link linkend="def_dirty">dirty</link>".\r
153 </simpara>\r
154 </listitem>\r
155 </varlistentry>\r
156 <varlistentry>\r
157 <term>\r
158 <anchor id="def_commit" xreflabel="[def_commit]"/>commit\r
159 </term>\r
160 <listitem>\r
161 <simpara>\r
162 As a noun: A single point in the\r
163 git history; the entire history of a project is represented as a\r
164 set of interrelated commits. The word "commit" is often\r
165 used by git in the same places other revision control systems\r
166 use the words "revision" or "version". Also used as a short\r
167 hand for <link linkend="def_commit_object">commit object</link>.\r
168 </simpara>\r
169 <simpara>As a verb: The action of storing a new snapshot of the project's\r
170 state in the git history, by creating a new commit representing the current\r
171 state of the <link linkend="def_index">index</link> and advancing <link linkend="def_HEAD">HEAD</link>\r
172 to point at the new commit.</simpara>\r
173 </listitem>\r
174 </varlistentry>\r
175 <varlistentry>\r
176 <term>\r
177 <anchor id="def_commit_object" xreflabel="[def_commit_object]"/>commit object\r
178 </term>\r
179 <listitem>\r
180 <simpara>\r
181 An <link linkend="def_object">object</link> which contains the information about a\r
182 particular <link linkend="def_revision">revision</link>, such as <link linkend="def_parent">parents</link>, committer,\r
183 author, date and the <link linkend="def_tree_object">tree object</link> which corresponds\r
184 to the top <link linkend="def_directory">directory</link> of the stored\r
185 revision.\r
186 </simpara>\r
187 </listitem>\r
188 </varlistentry>\r
189 <varlistentry>\r
190 <term>\r
191 <anchor id="def_core_git" xreflabel="[def_core_git]"/>core git\r
192 </term>\r
193 <listitem>\r
194 <simpara>\r
195 Fundamental data structures and utilities of git. Exposes only limited\r
196 source code management tools.\r
197 </simpara>\r
198 </listitem>\r
199 </varlistentry>\r
200 <varlistentry>\r
201 <term>\r
202 <anchor id="def_DAG" xreflabel="[def_DAG]"/>DAG\r
203 </term>\r
204 <listitem>\r
205 <simpara>\r
206 Directed acyclic graph. The <link linkend="def_commit_object">commit objects</link> form a\r
207 directed acyclic graph, because they have parents (directed), and the\r
208 graph of commit objects is acyclic (there is no <link linkend="def_chain">chain</link>\r
209 which begins and ends with the same <link linkend="def_object">object</link>).\r
210 </simpara>\r
211 </listitem>\r
212 </varlistentry>\r
213 <varlistentry>\r
214 <term>\r
215 <anchor id="def_dangling_object" xreflabel="[def_dangling_object]"/>dangling object\r
216 </term>\r
217 <listitem>\r
218 <simpara>\r
219 An <link linkend="def_unreachable_object">unreachable object</link> which is not\r
220 <link linkend="def_reachable">reachable</link> even from other unreachable objects; a\r
221 dangling object has no references to it from any\r
222 reference or <link linkend="def_object">object</link> in the <link linkend="def_repository">repository</link>.\r
223 </simpara>\r
224 </listitem>\r
225 </varlistentry>\r
226 <varlistentry>\r
227 <term>\r
228 <anchor id="def_detached_HEAD" xreflabel="[def_detached_HEAD]"/>detached HEAD\r
229 </term>\r
230 <listitem>\r
231 <simpara>\r
232 Normally the <link linkend="def_HEAD">HEAD</link> stores the name of a\r
233 <link linkend="def_branch">branch</link>. However, git also allows you to <link linkend="def_checkout">check out</link>\r
234 an arbitrary <link linkend="def_commit">commit</link> that isn't necessarily the tip of any\r
235 particular branch. In this case HEAD is said to be "detached".\r
236 </simpara>\r
237 </listitem>\r
238 </varlistentry>\r
239 <varlistentry>\r
240 <term>\r
241 <anchor id="def_dircache" xreflabel="[def_dircache]"/>dircache\r
242 </term>\r
243 <listitem>\r
244 <simpara>\r
245 You are <emphasis role="strong">waaaaay</emphasis> behind. See <link linkend="def_index">index</link>.\r
246 </simpara>\r
247 </listitem>\r
248 </varlistentry>\r
249 <varlistentry>\r
250 <term>\r
251 <anchor id="def_directory" xreflabel="[def_directory]"/>directory\r
252 </term>\r
253 <listitem>\r
254 <simpara>\r
255 The list you get with "ls" :-)\r
256 </simpara>\r
257 </listitem>\r
258 </varlistentry>\r
259 <varlistentry>\r
260 <term>\r
261 <anchor id="def_dirty" xreflabel="[def_dirty]"/>dirty\r
262 </term>\r
263 <listitem>\r
264 <simpara>\r
265 A <link linkend="def_working_tree">working tree</link> is said to be "dirty" if\r
266 it contains modifications which have not been <link linkend="def_commit">committed</link> to the current\r
267 <link linkend="def_branch">branch</link>.\r
268 </simpara>\r
269 </listitem>\r
270 </varlistentry>\r
271 <varlistentry>\r
272 <term>\r
273 <anchor id="def_ent" xreflabel="[def_ent]"/>ent\r
274 </term>\r
275 <listitem>\r
276 <simpara>\r
277 Favorite synonym to "<link linkend="def_tree-ish">tree-ish</link>" by some total geeks. See\r
278 <emphasis>http://en.wikipedia.org/wiki/Ent_(Middle-earth)</emphasis> for an in-depth\r
279 explanation. Avoid this term, not to confuse people.\r
280 </simpara>\r
281 </listitem>\r
282 </varlistentry>\r
283 <varlistentry>\r
284 <term>\r
285 <anchor id="def_evil_merge" xreflabel="[def_evil_merge]"/>evil merge\r
286 </term>\r
287 <listitem>\r
288 <simpara>\r
289 An evil merge is a <link linkend="def_merge">merge</link> that introduces changes that\r
290 do not appear in any <link linkend="def_parent">parent</link>.\r
291 </simpara>\r
292 </listitem>\r
293 </varlistentry>\r
294 <varlistentry>\r
295 <term>\r
296 <anchor id="def_fast_forward" xreflabel="[def_fast_forward]"/>fast-forward\r
297 </term>\r
298 <listitem>\r
299 <simpara>\r
300 A fast-forward is a special type of <link linkend="def_merge">merge</link> where you have a\r
301 <link linkend="def_revision">revision</link> and you are "merging" another\r
302 <link linkend="def_branch">branch</link>'s changes that happen to be a descendant of what\r
303 you have. In such these cases, you do not make a new <link linkend="def_merge">merge</link>\r
304 <link linkend="def_commit">commit</link> but instead just update to his\r
305 revision. This will happen frequently on a\r
306 <link linkend="def_remote_tracking_branch">remote-tracking branch</link> of a remote\r
307 <link linkend="def_repository">repository</link>.\r
308 </simpara>\r
309 </listitem>\r
310 </varlistentry>\r
311 <varlistentry>\r
312 <term>\r
313 <anchor id="def_fetch" xreflabel="[def_fetch]"/>fetch\r
314 </term>\r
315 <listitem>\r
316 <simpara>\r
317 Fetching a <link linkend="def_branch">branch</link> means to get the\r
318 branch's <link linkend="def_head_ref">head ref</link> from a remote\r
319 <link linkend="def_repository">repository</link>, to find out which objects are\r
320 missing from the local <link linkend="def_object_database">object database</link>,\r
321 and to get them, too. See also <xref linkend="git-fetch(1)" />.\r
322 </simpara>\r
323 </listitem>\r
324 </varlistentry>\r
325 <varlistentry>\r
326 <term>\r
327 <anchor id="def_file_system" xreflabel="[def_file_system]"/>file system\r
328 </term>\r
329 <listitem>\r
330 <simpara>\r
331 Linus Torvalds originally designed git to be a user space file system,\r
332 i.e. the infrastructure to hold files and directories. That ensured the\r
333 efficiency and speed of git.\r
334 </simpara>\r
335 </listitem>\r
336 </varlistentry>\r
337 <varlistentry>\r
338 <term>\r
339 <anchor id="def_git_archive" xreflabel="[def_git_archive]"/>git archive\r
340 </term>\r
341 <listitem>\r
342 <simpara>\r
343 Synonym for <link linkend="def_repository">repository</link> (for arch people).\r
344 </simpara>\r
345 </listitem>\r
346 </varlistentry>\r
347 <varlistentry>\r
348 <term>\r
349 <anchor id="def_grafts" xreflabel="[def_grafts]"/>grafts\r
350 </term>\r
351 <listitem>\r
352 <simpara>\r
353 Grafts enables two otherwise different lines of development to be joined\r
354 together by recording fake ancestry information for commits. This way\r
355 you can make git pretend the set of <link linkend="def_parent">parents</link> a <link linkend="def_commit">commit</link> has\r
356 is different from what was recorded when the commit was\r
357 created. Configured via the <emphasis>.git/info/grafts</emphasis> file.\r
358 </simpara>\r
359 </listitem>\r
360 </varlistentry>\r
361 <varlistentry>\r
362 <term>\r
363 <anchor id="def_hash" xreflabel="[def_hash]"/>hash\r
364 </term>\r
365 <listitem>\r
366 <simpara>\r
367 In git's context, synonym to <link linkend="def_object_name">object name</link>.\r
368 </simpara>\r
369 </listitem>\r
370 </varlistentry>\r
371 <varlistentry>\r
372 <term>\r
373 <anchor id="def_head" xreflabel="[def_head]"/>head\r
374 </term>\r
375 <listitem>\r
376 <simpara>\r
377 A <link linkend="def_ref">named reference</link> to the <link linkend="def_commit">commit</link> at the tip of a\r
378 <link linkend="def_branch">branch</link>. Heads are stored in a file in\r
379 <emphasis>$GIT_DIR/refs/heads/</emphasis> directory, except when using packed refs. (See\r
380 <xref linkend="git-pack-refs(1)" />.)\r
381 </simpara>\r
382 </listitem>\r
383 </varlistentry>\r
384 <varlistentry>\r
385 <term>\r
386 <anchor id="def_HEAD" xreflabel="[def_HEAD]"/>HEAD\r
387 </term>\r
388 <listitem>\r
389 <simpara>\r
390 The current <link linkend="def_branch">branch</link>. In more detail: Your <link linkend="def_working_tree">working tree</link> is normally derived from the state of the tree\r
391 referred to by HEAD. HEAD is a reference to one of the\r
392 <link linkend="def_head">heads</link> in your repository, except when using a\r
393 <link linkend="def_detached_HEAD">detached HEAD</link>, in which case it directly\r
394 references an arbitrary commit.\r
395 </simpara>\r
396 </listitem>\r
397 </varlistentry>\r
398 <varlistentry>\r
399 <term>\r
400 <anchor id="def_head_ref" xreflabel="[def_head_ref]"/>head ref\r
401 </term>\r
402 <listitem>\r
403 <simpara>\r
404 A synonym for <link linkend="def_head">head</link>.\r
405 </simpara>\r
406 </listitem>\r
407 </varlistentry>\r
408 <varlistentry>\r
409 <term>\r
410 <anchor id="def_hook" xreflabel="[def_hook]"/>hook\r
411 </term>\r
412 <listitem>\r
413 <simpara>\r
414 During the normal execution of several git commands, call-outs are made\r
415 to optional scripts that allow a developer to add functionality or\r
416 checking. Typically, the hooks allow for a command to be pre-verified\r
417 and potentially aborted, and allow for a post-notification after the\r
418 operation is done. The hook scripts are found in the\r
419 <emphasis>$GIT_DIR/hooks/</emphasis> directory, and are enabled by simply\r
420 removing the <emphasis>.sample</emphasis> suffix from the filename. In earlier versions\r
421 of git you had to make them executable.\r
422 </simpara>\r
423 </listitem>\r
424 </varlistentry>\r
425 <varlistentry>\r
426 <term>\r
427 <anchor id="def_index" xreflabel="[def_index]"/>index\r
428 </term>\r
429 <listitem>\r
430 <simpara>\r
431 A collection of files with stat information, whose contents are stored\r
432 as objects. The index is a stored version of your\r
433 <link linkend="def_working_tree">working tree</link>. Truth be told, it can also contain a second, and even\r
434 a third version of a working tree, which are used\r
435 when <link linkend="def_merge">merging</link>.\r
436 </simpara>\r
437 </listitem>\r
438 </varlistentry>\r
439 <varlistentry>\r
440 <term>\r
441 <anchor id="def_index_entry" xreflabel="[def_index_entry]"/>index entry\r
442 </term>\r
443 <listitem>\r
444 <simpara>\r
445 The information regarding a particular file, stored in the\r
446 <link linkend="def_index">index</link>. An index entry can be unmerged, if a\r
447 <link linkend="def_merge">merge</link> was started, but not yet finished (i.e. if\r
448 the index contains multiple versions of that file).\r
449 </simpara>\r
450 </listitem>\r
451 </varlistentry>\r
452 <varlistentry>\r
453 <term>\r
454 <anchor id="def_master" xreflabel="[def_master]"/>master\r
455 </term>\r
456 <listitem>\r
457 <simpara>\r
458 The default development <link linkend="def_branch">branch</link>. Whenever you\r
459 create a git <link linkend="def_repository">repository</link>, a branch named\r
460 "master" is created, and becomes the active branch. In most\r
461 cases, this contains the local development, though that is\r
462 purely by convention and is not required.\r
463 </simpara>\r
464 </listitem>\r
465 </varlistentry>\r
466 <varlistentry>\r
467 <term>\r
468 <anchor id="def_merge" xreflabel="[def_merge]"/>merge\r
469 </term>\r
470 <listitem>\r
471 <simpara>\r
472 As a verb: To bring the contents of another\r
473 <link linkend="def_branch">branch</link> (possibly from an external\r
474 <link linkend="def_repository">repository</link>) into the current branch. In the\r
475 case where the merged-in branch is from a different repository,\r
476 this is done by first <link linkend="def_fetch">fetching</link> the remote branch\r
477 and then merging the result into the current branch. This\r
478 combination of fetch and merge operations is called a\r
479 <link linkend="def_pull">pull</link>. Merging is performed by an automatic process\r
480 that identifies changes made since the branches diverged, and\r
481 then applies all those changes together. In cases where changes\r
482 conflict, manual intervention may be required to complete the\r
483 merge.\r
484 </simpara>\r
485 <simpara>As a noun: unless it is a <link linkend="def_fast_forward">fast-forward</link>, a\r
486 successful merge results in the creation of a new <link linkend="def_commit">commit</link>\r
487 representing the result of the merge, and having as\r
488 <link linkend="def_parent">parents</link> the tips of the merged <link linkend="def_branch">branches</link>.\r
489 This commit is referred to as a "merge commit", or sometimes just a\r
490 "merge".</simpara>\r
491 </listitem>\r
492 </varlistentry>\r
493 <varlistentry>\r
494 <term>\r
495 <anchor id="def_object" xreflabel="[def_object]"/>object\r
496 </term>\r
497 <listitem>\r
498 <simpara>\r
499 The unit of storage in git. It is uniquely identified by the\r
500 <link linkend="def_SHA1">SHA1</link> of its contents. Consequently, an\r
501 object can not be changed.\r
502 </simpara>\r
503 </listitem>\r
504 </varlistentry>\r
505 <varlistentry>\r
506 <term>\r
507 <anchor id="def_object_database" xreflabel="[def_object_database]"/>object database\r
508 </term>\r
509 <listitem>\r
510 <simpara>\r
511 Stores a set of "objects", and an individual <link linkend="def_object">object</link> is\r
512 identified by its <link linkend="def_object_name">object name</link>. The objects usually\r
513 live in <emphasis>$GIT_DIR/objects/</emphasis>.\r
514 </simpara>\r
515 </listitem>\r
516 </varlistentry>\r
517 <varlistentry>\r
518 <term>\r
519 <anchor id="def_object_identifier" xreflabel="[def_object_identifier]"/>object identifier\r
520 </term>\r
521 <listitem>\r
522 <simpara>\r
523 Synonym for <link linkend="def_object_name">object name</link>.\r
524 </simpara>\r
525 </listitem>\r
526 </varlistentry>\r
527 <varlistentry>\r
528 <term>\r
529 <anchor id="def_object_name" xreflabel="[def_object_name]"/>object name\r
530 </term>\r
531 <listitem>\r
532 <simpara>\r
533 The unique identifier of an <link linkend="def_object">object</link>. The <link linkend="def_hash">hash</link>\r
534 of the object's contents using the Secure Hash Algorithm\r
535 1 and usually represented by the 40 character hexadecimal encoding of\r
536 the <link linkend="def_hash">hash</link> of the object.\r
537 </simpara>\r
538 </listitem>\r
539 </varlistentry>\r
540 <varlistentry>\r
541 <term>\r
542 <anchor id="def_object_type" xreflabel="[def_object_type]"/>object type\r
543 </term>\r
544 <listitem>\r
545 <simpara>\r
546 One of the identifiers "<link linkend="def_commit_object">commit</link>",\r
547 "<link linkend="def_tree_object">tree</link>", "<link linkend="def_tag_object">tag</link>" or\r
548 "<link linkend="def_blob_object">blob</link>" describing the type of an\r
549 <link linkend="def_object">object</link>.\r
550 </simpara>\r
551 </listitem>\r
552 </varlistentry>\r
553 <varlistentry>\r
554 <term>\r
555 <anchor id="def_octopus" xreflabel="[def_octopus]"/>octopus\r
556 </term>\r
557 <listitem>\r
558 <simpara>\r
559 To <link linkend="def_merge">merge</link> more than two <link linkend="def_branch">branches</link>. Also denotes an\r
560 intelligent predator.\r
561 </simpara>\r
562 </listitem>\r
563 </varlistentry>\r
564 <varlistentry>\r
565 <term>\r
566 <anchor id="def_origin" xreflabel="[def_origin]"/>origin\r
567 </term>\r
568 <listitem>\r
569 <simpara>\r
570 The default upstream <link linkend="def_repository">repository</link>. Most projects have\r
571 at least one upstream project which they track. By default\r
572 <emphasis>origin</emphasis> is used for that purpose. New upstream updates\r
573 will be fetched into remote <link linkend="def_remote_tracking_branch">remote-tracking branches</link> named\r
574 origin/name-of-upstream-branch, which you can see using\r
575 <emphasis>git branch -r</emphasis>.\r
576 </simpara>\r
577 </listitem>\r
578 </varlistentry>\r
579 <varlistentry>\r
580 <term>\r
581 <anchor id="def_pack" xreflabel="[def_pack]"/>pack\r
582 </term>\r
583 <listitem>\r
584 <simpara>\r
585 A set of objects which have been compressed into one file (to save space\r
586 or to transmit them efficiently).\r
587 </simpara>\r
588 </listitem>\r
589 </varlistentry>\r
590 <varlistentry>\r
591 <term>\r
592 <anchor id="def_pack_index" xreflabel="[def_pack_index]"/>pack index\r
593 </term>\r
594 <listitem>\r
595 <simpara>\r
596 The list of identifiers, and other information, of the objects in a\r
597 <link linkend="def_pack">pack</link>, to assist in efficiently accessing the contents of a\r
598 pack.\r
599 </simpara>\r
600 </listitem>\r
601 </varlistentry>\r
602 <varlistentry>\r
603 <term>\r
604 <anchor id="def_pathspec" xreflabel="[def_pathspec]"/>pathspec\r
605 </term>\r
606 <listitem>\r
607 <simpara>\r
608 Pattern used to specify paths.\r
609 </simpara>\r
610 <simpara>Pathspecs are used on the command line of "git ls-files", "git\r
611 ls-tree", "git add", "git grep", "git diff", "git checkout",\r
612 and many other commands to\r
613 limit the scope of operations to some subset of the tree or\r
614 worktree. See the documentation of each command for whether\r
615 paths are relative to the current directory or toplevel. The\r
616 pathspec syntax is as follows:</simpara>\r
617 <itemizedlist>\r
618 <listitem>\r
619 <simpara>\r
620 any path matches itself\r
621 </simpara>\r
622 </listitem>\r
623 <listitem>\r
624 <simpara>\r
625 the pathspec up to the last slash represents a\r
626 directory prefix. The scope of that pathspec is\r
627 limited to that subtree.\r
628 </simpara>\r
629 </listitem>\r
630 <listitem>\r
631 <simpara>\r
632 the rest of the pathspec is a pattern for the remainder\r
633 of the pathname. Paths relative to the directory\r
634 prefix will be matched against that pattern using fnmatch(3);\r
635 in particular, <emphasis>*</emphasis> and <emphasis>?</emphasis> <emphasis>can</emphasis> match directory separators.\r
636 </simpara>\r
637 <simpara>For example, Documentation/*.jpg will match all .jpg files\r
638 in the Documentation subtree,\r
639 including Documentation/chapter_1/figure_1.jpg.</simpara>\r
640 </listitem>\r
641 </itemizedlist>\r
642 <simpara>A pathspec that begins with a colon <emphasis>:</emphasis> has special meaning. In the\r
643 short form, the leading colon <emphasis>:</emphasis> is followed by zero or more "magic\r
644 signature" letters (which optionally is terminated by another colon <emphasis>:</emphasis>),\r
645 and the remainder is the pattern to match against the path. The optional\r
646 colon that terminates the "magic signature" can be omitted if the pattern\r
647 begins with a character that cannot be a "magic signature" and is not a\r
648 colon.</simpara>\r
649 <simpara>In the long form, the leading colon <emphasis>:</emphasis> is followed by a open\r
650 parenthesis <emphasis>(</emphasis>, a comma-separated list of zero or more "magic words",\r
651 and a close parentheses <emphasis>)</emphasis>, and the remainder is the pattern to match\r
652 against the path.</simpara>\r
653 <simpara>The "magic signature" consists of an ASCII symbol that is not\r
654 alphanumeric.</simpara>\r
655 <variablelist>\r
656 <varlistentry>\r
657 <term>\r
658 top <emphasis>/</emphasis>\r
659 </term>\r
660 <listitem>\r
661 <simpara>\r
662 The magic word <emphasis>top</emphasis> (mnemonic: <emphasis>/</emphasis>) makes the pattern match\r
663 from the root of the working tree, even when you are running\r
664 the command from inside a subdirectory.\r
665 </simpara>\r
666 </listitem>\r
667 </varlistentry>\r
668 </variablelist>\r
669 <simpara>Currently only the slash <emphasis>/</emphasis> is recognized as the "magic signature",\r
670 but it is envisioned that we will support more types of magic in later\r
671 versions of git.</simpara>\r
672 <simpara>A pathspec with only a colon means "there is no pathspec". This form\r
673 should not be combined with other pathspec.</simpara>\r
674 </listitem>\r
675 </varlistentry>\r
676 <varlistentry>\r
677 <term>\r
678 <anchor id="def_parent" xreflabel="[def_parent]"/>parent\r
679 </term>\r
680 <listitem>\r
681 <simpara>\r
682 A <link linkend="def_commit_object">commit object</link> contains a (possibly empty) list\r
683 of the logical predecessor(s) in the line of development, i.e. its\r
684 parents.\r
685 </simpara>\r
686 </listitem>\r
687 </varlistentry>\r
688 <varlistentry>\r
689 <term>\r
690 <anchor id="def_pickaxe" xreflabel="[def_pickaxe]"/>pickaxe\r
691 </term>\r
692 <listitem>\r
693 <simpara>\r
694 The term <link linkend="def_pickaxe">pickaxe</link> refers to an option to the diffcore\r
695 routines that help select changes that add or delete a given text\r
696 string. With the <emphasis>--pickaxe-all</emphasis> option, it can be used to view the full\r
697 <link linkend="def_changeset">changeset</link> that introduced or removed, say, a\r
698 particular line of text. See <xref linkend="git-diff(1)" />.\r
699 </simpara>\r
700 </listitem>\r
701 </varlistentry>\r
702 <varlistentry>\r
703 <term>\r
704 <anchor id="def_plumbing" xreflabel="[def_plumbing]"/>plumbing\r
705 </term>\r
706 <listitem>\r
707 <simpara>\r
708 Cute name for <link linkend="def_core_git">core git</link>.\r
709 </simpara>\r
710 </listitem>\r
711 </varlistentry>\r
712 <varlistentry>\r
713 <term>\r
714 <anchor id="def_porcelain" xreflabel="[def_porcelain]"/>porcelain\r
715 </term>\r
716 <listitem>\r
717 <simpara>\r
718 Cute name for programs and program suites depending on\r
719 <link linkend="def_core_git">core git</link>, presenting a high level access to\r
720 core git. Porcelains expose more of a <link linkend="def_SCM">SCM</link>\r
721 interface than the <link linkend="def_plumbing">plumbing</link>.\r
722 </simpara>\r
723 </listitem>\r
724 </varlistentry>\r
725 <varlistentry>\r
726 <term>\r
727 <anchor id="def_pull" xreflabel="[def_pull]"/>pull\r
728 </term>\r
729 <listitem>\r
730 <simpara>\r
731 Pulling a <link linkend="def_branch">branch</link> means to <link linkend="def_fetch">fetch</link> it and\r
732 <link linkend="def_merge">merge</link> it. See also <xref linkend="git-pull(1)" />.\r
733 </simpara>\r
734 </listitem>\r
735 </varlistentry>\r
736 <varlistentry>\r
737 <term>\r
738 <anchor id="def_push" xreflabel="[def_push]"/>push\r
739 </term>\r
740 <listitem>\r
741 <simpara>\r
742 Pushing a <link linkend="def_branch">branch</link> means to get the branch's\r
743 <link linkend="def_head_ref">head ref</link> from a remote <link linkend="def_repository">repository</link>,\r
744 find out if it is a direct ancestor to the branch's local\r
745 head ref, and in that case, putting all\r
746 objects, which are <link linkend="def_reachable">reachable</link> from the local\r
747 head ref, and which are missing from the remote\r
748 repository, into the remote\r
749 <link linkend="def_object_database">object database</link>, and updating the remote\r
750 head ref. If the remote <link linkend="def_head">head</link> is not an\r
751 ancestor to the local head, the push fails.\r
752 </simpara>\r
753 </listitem>\r
754 </varlistentry>\r
755 <varlistentry>\r
756 <term>\r
757 <anchor id="def_reachable" xreflabel="[def_reachable]"/>reachable\r
758 </term>\r
759 <listitem>\r
760 <simpara>\r
761 All of the ancestors of a given <link linkend="def_commit">commit</link> are said to be\r
762 "reachable" from that commit. More\r
763 generally, one <link linkend="def_object">object</link> is reachable from\r
764 another if we can reach the one from the other by a <link linkend="def_chain">chain</link>\r
765 that follows <link linkend="def_tag">tags</link> to whatever they tag,\r
766 <link linkend="def_commit_object">commits</link> to their parents or trees, and\r
767 <link linkend="def_tree_object">trees</link> to the trees or <link linkend="def_blob_object">blobs</link>\r
768 that they contain.\r
769 </simpara>\r
770 </listitem>\r
771 </varlistentry>\r
772 <varlistentry>\r
773 <term>\r
774 <anchor id="def_rebase" xreflabel="[def_rebase]"/>rebase\r
775 </term>\r
776 <listitem>\r
777 <simpara>\r
778 To reapply a series of changes from a <link linkend="def_branch">branch</link> to a\r
779 different base, and reset the <link linkend="def_head">head</link> of that branch\r
780 to the result.\r
781 </simpara>\r
782 </listitem>\r
783 </varlistentry>\r
784 <varlistentry>\r
785 <term>\r
786 <anchor id="def_ref" xreflabel="[def_ref]"/>ref\r
787 </term>\r
788 <listitem>\r
789 <simpara>\r
790 A 40-byte hex representation of a <link linkend="def_SHA1">SHA1</link> or a name that\r
791 denotes a particular <link linkend="def_object">object</link>. They may be stored in\r
792 a file under <emphasis>$GIT_DIR/refs/</emphasis> directory, or\r
793 in the <emphasis>$GIT_DIR/packed-refs</emphasis> file.\r
794 </simpara>\r
795 </listitem>\r
796 </varlistentry>\r
797 <varlistentry>\r
798 <term>\r
799 <anchor id="def_reflog" xreflabel="[def_reflog]"/>reflog\r
800 </term>\r
801 <listitem>\r
802 <simpara>\r
803 A reflog shows the local "history" of a ref. In other words,\r
804 it can tell you what the 3rd last revision in <emphasis>this</emphasis> repository\r
805 was, and what was the current state in <emphasis>this</emphasis> repository,\r
806 yesterday 9:14pm. See <xref linkend="git-reflog(1)" /> for details.\r
807 </simpara>\r
808 </listitem>\r
809 </varlistentry>\r
810 <varlistentry>\r
811 <term>\r
812 <anchor id="def_refspec" xreflabel="[def_refspec]"/>refspec\r
813 </term>\r
814 <listitem>\r
815 <simpara>\r
816 A "refspec" is used by <link linkend="def_fetch">fetch</link> and\r
817 <link linkend="def_push">push</link> to describe the mapping between remote\r
818 <link linkend="def_ref">ref</link> and local ref. They are combined with a colon in\r
819 the format <src>:<dst>, preceded by an optional plus sign, +.\r
820 For example: <emphasis>git fetch $URL\r
821 refs/heads/master:refs/heads/origin</emphasis> means "grab the master\r
822 <link linkend="def_branch">branch</link> <link linkend="def_head">head</link> from the $URL and store\r
823 it as my origin branch head". And <emphasis>git push\r
824 $URL refs/heads/master:refs/heads/to-upstream</emphasis> means "publish my\r
825 master branch head as to-upstream branch at $URL". See also\r
826 <xref linkend="git-push(1)" />.\r
827 </simpara>\r
828 </listitem>\r
829 </varlistentry>\r
830 <varlistentry>\r
831 <term>\r
832 <anchor id="def_remote_tracking_branch" xreflabel="[def_remote_tracking_branch]"/>remote-tracking branch\r
833 </term>\r
834 <listitem>\r
835 <simpara>\r
836 A regular git <link linkend="def_branch">branch</link> that is used to follow changes from\r
837 another <link linkend="def_repository">repository</link>. A remote-tracking\r
838 branch should not contain direct modifications or have local commits\r
839 made to it. A remote-tracking branch can usually be\r
840 identified as the right-hand-side <link linkend="def_ref">ref</link> in a Pull:\r
841 <link linkend="def_refspec">refspec</link>.\r
842 </simpara>\r
843 </listitem>\r
844 </varlistentry>\r
845 <varlistentry>\r
846 <term>\r
847 <anchor id="def_repository" xreflabel="[def_repository]"/>repository\r
848 </term>\r
849 <listitem>\r
850 <simpara>\r
851 A collection of <link linkend="def_ref">refs</link> together with an\r
852 <link linkend="def_object_database">object database</link> containing all objects\r
853 which are <link linkend="def_reachable">reachable</link> from the refs, possibly\r
854 accompanied by meta data from one or more <link linkend="def_porcelain">porcelains</link>. A\r
855 repository can share an object database with other repositories\r
856 via <link linkend="def_alternate_object_database">alternates mechanism</link>.\r
857 </simpara>\r
858 </listitem>\r
859 </varlistentry>\r
860 <varlistentry>\r
861 <term>\r
862 <anchor id="def_resolve" xreflabel="[def_resolve]"/>resolve\r
863 </term>\r
864 <listitem>\r
865 <simpara>\r
866 The action of fixing up manually what a failed automatic\r
867 <link linkend="def_merge">merge</link> left behind.\r
868 </simpara>\r
869 </listitem>\r
870 </varlistentry>\r
871 <varlistentry>\r
872 <term>\r
873 <anchor id="def_revision" xreflabel="[def_revision]"/>revision\r
874 </term>\r
875 <listitem>\r
876 <simpara>\r
877 A particular state of files and directories which was stored in the\r
878 <link linkend="def_object_database">object database</link>. It is referenced by a\r
879 <link linkend="def_commit_object">commit object</link>.\r
880 </simpara>\r
881 </listitem>\r
882 </varlistentry>\r
883 <varlistentry>\r
884 <term>\r
885 <anchor id="def_rewind" xreflabel="[def_rewind]"/>rewind\r
886 </term>\r
887 <listitem>\r
888 <simpara>\r
889 To throw away part of the development, i.e. to assign the\r
890 <link linkend="def_head">head</link> to an earlier <link linkend="def_revision">revision</link>.\r
891 </simpara>\r
892 </listitem>\r
893 </varlistentry>\r
894 <varlistentry>\r
895 <term>\r
896 <anchor id="def_SCM" xreflabel="[def_SCM]"/>SCM\r
897 </term>\r
898 <listitem>\r
899 <simpara>\r
900 Source code management (tool).\r
901 </simpara>\r
902 </listitem>\r
903 </varlistentry>\r
904 <varlistentry>\r
905 <term>\r
906 <anchor id="def_SHA1" xreflabel="[def_SHA1]"/>SHA1\r
907 </term>\r
908 <listitem>\r
909 <simpara>\r
910 Synonym for <link linkend="def_object_name">object name</link>.\r
911 </simpara>\r
912 </listitem>\r
913 </varlistentry>\r
914 <varlistentry>\r
915 <term>\r
916 <anchor id="def_shallow_repository" xreflabel="[def_shallow_repository]"/>shallow repository\r
917 </term>\r
918 <listitem>\r
919 <simpara>\r
920 A shallow <link linkend="def_repository">repository</link> has an incomplete\r
921 history some of whose <link linkend="def_commit">commits</link> have <link linkend="def_parent">parents</link> cauterized away (in other\r
922 words, git is told to pretend that these commits do not have the\r
923 parents, even though they are recorded in the <link linkend="def_commit_object">commit object</link>). This is sometimes useful when you are interested only in the\r
924 recent history of a project even though the real history recorded in the\r
925 upstream is much larger. A shallow repository\r
926 is created by giving the <emphasis>--depth</emphasis> option to <xref linkend="git-clone(1)" />, and\r
927 its history can be later deepened with <xref linkend="git-fetch(1)" />.\r
928 </simpara>\r
929 </listitem>\r
930 </varlistentry>\r
931 <varlistentry>\r
932 <term>\r
933 <anchor id="def_symref" xreflabel="[def_symref]"/>symref\r
934 </term>\r
935 <listitem>\r
936 <simpara>\r
937 Symbolic reference: instead of containing the <link linkend="def_SHA1">SHA1</link>\r
938 id itself, it is of the format <emphasis>ref: refs/some/thing</emphasis> and when\r
939 referenced, it recursively dereferences to this reference.\r
940 <emphasis><link linkend="def_HEAD">HEAD</link></emphasis> is a prime example of a symref. Symbolic\r
941 references are manipulated with the <xref linkend="git-symbolic-ref(1)" />\r
942 command.\r
943 </simpara>\r
944 </listitem>\r
945 </varlistentry>\r
946 <varlistentry>\r
947 <term>\r
948 <anchor id="def_tag" xreflabel="[def_tag]"/>tag\r
949 </term>\r
950 <listitem>\r
951 <simpara>\r
952 A <link linkend="def_ref">ref</link> under <emphasis>refs/tags/</emphasis> namespace that points to an\r
953 object of an arbitrary type (typically a tag points to either a\r
954 <link linkend="def_tag_object">tag</link> or a <link linkend="def_commit_object">commit object</link>).\r
955 In contrast to a <link linkend="def_head">head</link>, a tag is not updated by\r
956 the <emphasis>commit</emphasis> command. A git tag has nothing to do with a Lisp\r
957 tag (which would be called an <link linkend="def_object_type">object type</link>\r
958 in git's context). A tag is most typically used to mark a particular\r
959 point in the commit ancestry <link linkend="def_chain">chain</link>.\r
960 </simpara>\r
961 </listitem>\r
962 </varlistentry>\r
963 <varlistentry>\r
964 <term>\r
965 <anchor id="def_tag_object" xreflabel="[def_tag_object]"/>tag object\r
966 </term>\r
967 <listitem>\r
968 <simpara>\r
969 An <link linkend="def_object">object</link> containing a <link linkend="def_ref">ref</link> pointing to\r
970 another object, which can contain a message just like a\r
971 <link linkend="def_commit_object">commit object</link>. It can also contain a (PGP)\r
972 signature, in which case it is called a "signed tag object".\r
973 </simpara>\r
974 </listitem>\r
975 </varlistentry>\r
976 <varlistentry>\r
977 <term>\r
978 <anchor id="def_topic_branch" xreflabel="[def_topic_branch]"/>topic branch\r
979 </term>\r
980 <listitem>\r
981 <simpara>\r
982 A regular git <link linkend="def_branch">branch</link> that is used by a developer to\r
983 identify a conceptual line of development. Since branches are very easy\r
984 and inexpensive, it is often desirable to have several small branches\r
985 that each contain very well defined concepts or small incremental yet\r
986 related changes.\r
987 </simpara>\r
988 </listitem>\r
989 </varlistentry>\r
990 <varlistentry>\r
991 <term>\r
992 <anchor id="def_tree" xreflabel="[def_tree]"/>tree\r
993 </term>\r
994 <listitem>\r
995 <simpara>\r
996 Either a <link linkend="def_working_tree">working tree</link>, or a <link linkend="def_tree_object">tree object</link> together with the dependent <link linkend="def_blob_object">blob</link> and tree objects\r
997 (i.e. a stored representation of a working tree).\r
998 </simpara>\r
999 </listitem>\r
1000 </varlistentry>\r
1001 <varlistentry>\r
1002 <term>\r
1003 <anchor id="def_tree_object" xreflabel="[def_tree_object]"/>tree object\r
1004 </term>\r
1005 <listitem>\r
1006 <simpara>\r
1007 An <link linkend="def_object">object</link> containing a list of file names and modes along\r
1008 with refs to the associated blob and/or tree objects. A\r
1009 <link linkend="def_tree">tree</link> is equivalent to a <link linkend="def_directory">directory</link>.\r
1010 </simpara>\r
1011 </listitem>\r
1012 </varlistentry>\r
1013 <varlistentry>\r
1014 <term>\r
1015 <anchor id="def_tree-ish" xreflabel="[def_tree-ish]"/>tree-ish\r
1016 </term>\r
1017 <listitem>\r
1018 <simpara>\r
1019 A <link linkend="def_ref">ref</link> pointing to either a <link linkend="def_commit_object">commit object</link>, a <link linkend="def_tree_object">tree object</link>, or a <link linkend="def_tag_object">tag object</link> pointing to a tag or commit or tree object.\r
1020 </simpara>\r
1021 </listitem>\r
1022 </varlistentry>\r
1023 <varlistentry>\r
1024 <term>\r
1025 <anchor id="def_unmerged_index" xreflabel="[def_unmerged_index]"/>unmerged index\r
1026 </term>\r
1027 <listitem>\r
1028 <simpara>\r
1029 An <link linkend="def_index">index</link> which contains unmerged\r
1030 <link linkend="def_index_entry">index entries</link>.\r
1031 </simpara>\r
1032 </listitem>\r
1033 </varlistentry>\r
1034 <varlistentry>\r
1035 <term>\r
1036 <anchor id="def_unreachable_object" xreflabel="[def_unreachable_object]"/>unreachable object\r
1037 </term>\r
1038 <listitem>\r
1039 <simpara>\r
1040 An <link linkend="def_object">object</link> which is not <link linkend="def_reachable">reachable</link> from a\r
1041 <link linkend="def_branch">branch</link>, <link linkend="def_tag">tag</link>, or any other reference.\r
1042 </simpara>\r
1043 </listitem>\r
1044 </varlistentry>\r
1045 <varlistentry>\r
1046 <term>\r
1047 <anchor id="def_upstream_branch" xreflabel="[def_upstream_branch]"/>upstream branch\r
1048 </term>\r
1049 <listitem>\r
1050 <simpara>\r
1051 The default <link linkend="def_branch">branch</link> that is merged into the branch in\r
1052 question (or the branch in question is rebased onto). It is configured\r
1053 via branch.<name>.remote and branch.<name>.merge. If the upstream branch\r
1054 of <emphasis>A</emphasis> is <emphasis>origin/B</emphasis> sometimes we say "<emphasis>A</emphasis> is tracking <emphasis>origin/B</emphasis>".\r
1055 </simpara>\r
1056 </listitem>\r
1057 </varlistentry>\r
1058 <varlistentry>\r
1059 <term>\r
1060 <anchor id="def_working_tree" xreflabel="[def_working_tree]"/>working tree\r
1061 </term>\r
1062 <listitem>\r
1063 <simpara>\r
1064 The tree of actual checked out files. The working tree normally\r
1065 contains the contents of the <link linkend="def_HEAD">HEAD</link> commit's tree,\r
1066 plus any local changes that you have made but not yet committed.\r
1067 </simpara>\r
1068 </listitem>\r
1069 </varlistentry>\r
1070 </variablelist>\r
1071 </simplesect>\r
1072 <simplesect id="_see_also">\r
1073 <title>SEE ALSO</title>\r
1074 <simpara><xref linkend="gittutorial(7)" />,\r
1075 <xref linkend="gittutorial-2(7)" />,\r
1076 <xref linkend="gitcvs-migration(7)" />,\r
1077 link:everyday.html[Everyday git],\r
1078 link:user-manual.html[The Git User's Manual]</simpara>\r
1079 </simplesect>\r
1080 <simplesect id="_git">\r
1081 <title>GIT</title>\r
1082 <simpara>Part of the <xref linkend="git(1)" /> suite.</simpara>\r
1083 </simplesect>\r
1084 </article>\r