Google Git
Sign in
chromium / external / gitster / git-htmldocs / 535c65caafa13821295c3b060a5acd98bd2557b7 / . / gittutorial-2.html
blob: ec0d28b4d1649192d8308d2556ee1e4aea11cc45 [file] [log] [blame]
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]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>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]5<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]6<meta name="generator" content="AsciiDoc 8.6.9" />
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]7<title>gittutorial-2(7)</title>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]8<style type="text/css">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]9/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
10
11/* Default font. */
12body {
13 font-family: Georgia,serif;
14}
15
16/* Title font. */
17h1, h2, h3, h4, h5, h6,
18div.title, caption.title,
19thead, p.table.header,
20#toctitle,
21#author, #revnumber, #revdate, #revremark,
22#footer {
23 font-family: Arial,Helvetica,sans-serif;
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]24}
25
26body {
27 margin: 1em 5% 1em 5%;
28}
29
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]30a {
31 color: blue;
32 text-decoration: underline;
33}
34a:visited {
35 color: fuchsia;
36}
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]37
38em {
39 font-style: italic;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]40 color: navy;
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]41}
42
43strong {
44 font-weight: bold;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]45 color: #083194;
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]46}
47
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]48h1, h2, h3, h4, h5, h6 {
49 color: #527bbd;
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]50 margin-top: 1.2em;
51 margin-bottom: 0.5em;
52 line-height: 1.3;
53}
54
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]55h1, h2, h3 {
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]56 border-bottom: 2px solid silver;
57}
58h2 {
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]59 padding-top: 0.5em;
60}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]61h3 {
62 float: left;
63}
64h3 + * {
65 clear: left;
66}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]67h5 {
68 font-size: 1.0em;
69}
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]70
71div.sectionbody {
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]72 margin-left: 0;
73}
74
75hr {
76 border: 1px solid silver;
77}
78
79p {
80 margin-top: 0.5em;
81 margin-bottom: 0.5em;
82}
83
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]84ul, ol, li > p {
85 margin-top: 0;
86}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]87ul > li { color: #aaa; }
88ul > li > * { color: black; }
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]89
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]90.monospaced, code, pre {
91 font-family: "Courier New", Courier, monospace;
92 font-size: inherit;
93 color: navy;
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]94 padding: 0;
95 margin: 0;
96}
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]97pre {
98 white-space: pre-wrap;
99}
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]100
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]101#author {
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]102 color: #527bbd;
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]103 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]104 font-size: 1.1em;
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]105}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]106#email {
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]107}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]108#revnumber, #revdate, #revremark {
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]109}
110
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]111#footer {
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]112 font-size: small;
113 border-top: 2px solid silver;
114 padding-top: 0.5em;
115 margin-top: 4.0em;
116}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]117#footer-text {
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]118 float: left;
119 padding-bottom: 0.5em;
120}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]121#footer-badges {
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]122 float: right;
123 padding-bottom: 0.5em;
124}
125
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]126#preamble {
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]127 margin-top: 1.5em;
128 margin-bottom: 1.5em;
129}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]130div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]131div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
132div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]133 margin-top: 1.0em;
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]134 margin-bottom: 1.5em;
135}
136div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]137 margin-top: 2.0em;
138 margin-bottom: 2.0em;
139 margin-right: 10%;
140 color: #606060;
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]141}
142
143div.content { /* Block element content. */
144 padding: 0;
145}
146
147/* Block element titles. */
148div.title, caption.title {
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]149 color: #527bbd;
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]150 font-weight: bold;
151 text-align: left;
152 margin-top: 1.0em;
153 margin-bottom: 0.5em;
154}
155div.title + * {
156 margin-top: 0;
157}
158
159td div.title:first-child {
160 margin-top: 0.0em;
161}
162div.content div.title:first-child {
163 margin-top: 0.0em;
164}
165div.content + div.title {
166 margin-top: 0.0em;
167}
168
169div.sidebarblock > div.content {
170 background: #ffffee;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]171 border: 1px solid #dddddd;
172 border-left: 4px solid #f0f0f0;
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]173 padding: 0.5em;
174}
175
176div.listingblock > div.content {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]177 border: 1px solid #dddddd;
178 border-left: 5px solid #f0f0f0;
179 background: #f8f8f8;
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]180 padding: 0.5em;
181}
182
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]183div.quoteblock, div.verseblock {
184 padding-left: 1.0em;
185 margin-left: 1.0em;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]186 margin-right: 10%;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]187 border-left: 5px solid #f0f0f0;
188 color: #888;
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]189}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]190
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]191div.quoteblock > div.attribution {
192 padding-top: 0.5em;
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]193 text-align: right;
194}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]195
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]196div.verseblock > pre.content {
197 font-family: inherit;
198 font-size: inherit;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]199}
200div.verseblock > div.attribution {
201 padding-top: 0.75em;
202 text-align: left;
203}
204/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]205div.verseblock + div.attribution {
206 text-align: left;
207}
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]208
209div.admonitionblock .icon {
210 vertical-align: top;
211 font-size: 1.1em;
212 font-weight: bold;
213 text-decoration: underline;
214 color: #527bbd;
215 padding-right: 0.5em;
216}
217div.admonitionblock td.content {
218 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]219 border-left: 3px solid #dddddd;
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]220}
221
222div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]223 border-left: 3px solid #dddddd;
224 padding-left: 0.5em;
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]225}
226
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]227div.imageblock div.content { padding-left: 0; }
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]228span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]229a.image:visited { color: white; }
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]230
231dl {
232 margin-top: 0.8em;
233 margin-bottom: 0.8em;
234}
235dt {
236 margin-top: 0.5em;
237 margin-bottom: 0;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]238 font-style: normal;
239 color: navy;
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]240}
241dd > *:first-child {
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]242 margin-top: 0.1em;
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]243}
244
245ul, ol {
246 list-style-position: outside;
247}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]248ol.arabic {
249 list-style-type: decimal;
250}
251ol.loweralpha {
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]252 list-style-type: lower-alpha;
253}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]254ol.upperalpha {
255 list-style-type: upper-alpha;
256}
257ol.lowerroman {
258 list-style-type: lower-roman;
259}
260ol.upperroman {
261 list-style-type: upper-roman;
262}
263
264div.compact ul, div.compact ol,
265div.compact p, div.compact p,
266div.compact div, div.compact div {
267 margin-top: 0.1em;
268 margin-bottom: 0.1em;
269}
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]270
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]271tfoot {
272 font-weight: bold;
273}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]274td > div.verse {
275 white-space: pre;
276}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]277
278div.hdlist {
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]279 margin-top: 0.8em;
280 margin-bottom: 0.8em;
281}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]282div.hdlist tr {
283 padding-bottom: 15px;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]284}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]285dt.hdlist1.strong, td.hdlist1.strong {
286 font-weight: bold;
287}
288td.hdlist1 {
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]289 vertical-align: top;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]290 font-style: normal;
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]291 padding-right: 0.8em;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]292 color: navy;
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]293}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]294td.hdlist2 {
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]295 vertical-align: top;
296}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]297div.hdlist.compact tr {
298 margin: 0;
299 padding-bottom: 0;
300}
301
302.comment {
303 background: yellow;
304}
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]305
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]306.footnote, .footnoteref {
307 font-size: 0.8em;
308}
309
310span.footnote, span.footnoteref {
311 vertical-align: super;
312}
313
314#footnotes {
315 margin: 20px 0 20px 0;
316 padding: 7px 0 0 0;
317}
318
319#footnotes div.footnote {
320 margin: 0 0 5px 0;
321}
322
323#footnotes hr {
324 border: none;
325 border-top: 1px solid silver;
326 height: 1px;
327 text-align: left;
328 margin-left: 0;
329 width: 20%;
330 min-width: 100px;
331}
332
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]333div.colist td {
334 padding-right: 0.5em;
335 padding-bottom: 0.3em;
336 vertical-align: top;
337}
338div.colist td img {
339 margin-top: 0.3em;
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]340}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]341
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]342@media print {
343 #footer-badges { display: none; }
344}
345
346#toc {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]347 margin-bottom: 2.5em;
348}
349
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]350#toctitle {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]351 color: #527bbd;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]352 font-size: 1.1em;
353 font-weight: bold;
354 margin-top: 1.0em;
355 margin-bottom: 0.1em;
356}
357
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]358div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]359 margin-top: 0;
360 margin-bottom: 0;
361}
362div.toclevel2 {
363 margin-left: 2em;
364 font-size: 0.9em;
365}
366div.toclevel3 {
367 margin-left: 4em;
368 font-size: 0.9em;
369}
370div.toclevel4 {
371 margin-left: 6em;
372 font-size: 0.9em;
373}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]374
375span.aqua { color: aqua; }
376span.black { color: black; }
377span.blue { color: blue; }
378span.fuchsia { color: fuchsia; }
379span.gray { color: gray; }
380span.green { color: green; }
381span.lime { color: lime; }
382span.maroon { color: maroon; }
383span.navy { color: navy; }
384span.olive { color: olive; }
385span.purple { color: purple; }
386span.red { color: red; }
387span.silver { color: silver; }
388span.teal { color: teal; }
389span.white { color: white; }
390span.yellow { color: yellow; }
391
392span.aqua-background { background: aqua; }
393span.black-background { background: black; }
394span.blue-background { background: blue; }
395span.fuchsia-background { background: fuchsia; }
396span.gray-background { background: gray; }
397span.green-background { background: green; }
398span.lime-background { background: lime; }
399span.maroon-background { background: maroon; }
400span.navy-background { background: navy; }
401span.olive-background { background: olive; }
402span.purple-background { background: purple; }
403span.red-background { background: red; }
404span.silver-background { background: silver; }
405span.teal-background { background: teal; }
406span.white-background { background: white; }
407span.yellow-background { background: yellow; }
408
409span.big { font-size: 2em; }
410span.small { font-size: 0.6em; }
411
412span.underline { text-decoration: underline; }
413span.overline { text-decoration: overline; }
414span.line-through { text-decoration: line-through; }
415
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]416div.unbreakable { page-break-inside: avoid; }
417
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]418
419/*
420 * xhtml11 specific
421 *
422 * */
423
424div.tableblock {
425 margin-top: 1.0em;
426 margin-bottom: 1.5em;
427}
428div.tableblock > table {
429 border: 3px solid #527bbd;
430}
431thead, p.table.header {
432 font-weight: bold;
433 color: #527bbd;
434}
435p.table {
436 margin-top: 0;
437}
438/* Because the table frame attribute is overriden by CSS in most browsers. */
439div.tableblock > table[frame="void"] {
440 border-style: none;
441}
442div.tableblock > table[frame="hsides"] {
443 border-left-style: none;
444 border-right-style: none;
445}
446div.tableblock > table[frame="vsides"] {
447 border-top-style: none;
448 border-bottom-style: none;
449}
450
451
452/*
453 * html5 specific
454 *
455 * */
456
457table.tableblock {
458 margin-top: 1.0em;
459 margin-bottom: 1.5em;
460}
461thead, p.tableblock.header {
462 font-weight: bold;
463 color: #527bbd;
464}
465p.tableblock {
466 margin-top: 0;
467}
468table.tableblock {
469 border-width: 3px;
470 border-spacing: 0px;
471 border-style: solid;
472 border-color: #527bbd;
473 border-collapse: collapse;
474}
475th.tableblock, td.tableblock {
476 border-width: 1px;
477 padding: 4px;
478 border-style: solid;
479 border-color: #527bbd;
480}
481
482table.tableblock.frame-topbot {
483 border-left-style: hidden;
484 border-right-style: hidden;
485}
486table.tableblock.frame-sides {
487 border-top-style: hidden;
488 border-bottom-style: hidden;
489}
490table.tableblock.frame-none {
491 border-style: hidden;
492}
493
494th.tableblock.halign-left, td.tableblock.halign-left {
495 text-align: left;
496}
497th.tableblock.halign-center, td.tableblock.halign-center {
498 text-align: center;
499}
500th.tableblock.halign-right, td.tableblock.halign-right {
501 text-align: right;
502}
503
504th.tableblock.valign-top, td.tableblock.valign-top {
505 vertical-align: top;
506}
507th.tableblock.valign-middle, td.tableblock.valign-middle {
508 vertical-align: middle;
509}
510th.tableblock.valign-bottom, td.tableblock.valign-bottom {
511 vertical-align: bottom;
512}
513
514
515/*
516 * manpage specific
517 *
518 * */
519
520body.manpage h1 {
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]521 padding-top: 0.5em;
522 padding-bottom: 0.5em;
523 border-top: 2px solid silver;
524 border-bottom: 2px solid silver;
525}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]526body.manpage h2 {
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]527 border-style: none;
528}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]529body.manpage div.sectionbody {
530 margin-left: 3em;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]531}
532
533@media print {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]534 body.manpage div#toc { display: none; }
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]535}
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]536
537
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]538</style>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]539<script type="text/javascript">
540/*<![CDATA[*/
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]541var asciidoc = { // Namespace.
542
543/////////////////////////////////////////////////////////////////////
544// Table Of Contents generator
545/////////////////////////////////////////////////////////////////////
546
547/* Author: Mihai Bazon, September 2002
548 * http://students.infoiasi.ro/~mishoo
549 *
550 * Table Of Content generator
551 * Version: 0.4
552 *
553 * Feel free to use this script under the terms of the GNU General Public
554 * License, as long as you do not remove or alter this notice.
555 */
556
557 /* modified by Troy D. Hanson, September 2006. License: GPL */
558 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
559
560// toclevels = 1..4.
561toc: function (toclevels) {
562
563 function getText(el) {
564 var text = "";
565 for (var i = el.firstChild; i != null; i = i.nextSibling) {
566 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
567 text += i.data;
568 else if (i.firstChild != null)
569 text += getText(i);
570 }
571 return text;
572 }
573
574 function TocEntry(el, text, toclevel) {
575 this.element = el;
576 this.text = text;
577 this.toclevel = toclevel;
578 }
579
580 function tocEntries(el, toclevels) {
581 var result = new Array;
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]582 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]583 // Function that scans the DOM tree for header elements (the DOM2
584 // nodeIterator API would be a better technique but not supported by all
585 // browsers).
586 var iterate = function (el) {
587 for (var i = el.firstChild; i != null; i = i.nextSibling) {
588 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
589 var mo = re.exec(i.tagName);
590 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
591 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
592 }
593 iterate(i);
594 }
595 }
596 }
597 iterate(el);
598 return result;
599 }
600
601 var toc = document.getElementById("toc");
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]602 if (!toc) {
603 return;
604 }
605
606 // Delete existing TOC entries in case we're reloading the TOC.
607 var tocEntriesToRemove = [];
608 var i;
609 for (i = 0; i < toc.childNodes.length; i++) {
610 var entry = toc.childNodes[i];
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]611 if (entry.nodeName.toLowerCase() == 'div'
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]612 && entry.getAttribute("class")
613 && entry.getAttribute("class").match(/^toclevel/))
614 tocEntriesToRemove.push(entry);
615 }
616 for (i = 0; i < tocEntriesToRemove.length; i++) {
617 toc.removeChild(tocEntriesToRemove[i]);
618 }
619
620 // Rebuild TOC entries.
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]621 var entries = tocEntries(document.getElementById("content"), toclevels);
622 for (var i = 0; i < entries.length; ++i) {
623 var entry = entries[i];
624 if (entry.element.id == "")
625 entry.element.id = "_toc_" + i;
626 var a = document.createElement("a");
627 a.href = "#" + entry.element.id;
628 a.appendChild(document.createTextNode(entry.text));
629 var div = document.createElement("div");
630 div.appendChild(a);
631 div.className = "toclevel" + entry.toclevel;
632 toc.appendChild(div);
633 }
634 if (entries.length == 0)
635 toc.parentNode.removeChild(toc);
636},
637
638
639/////////////////////////////////////////////////////////////////////
640// Footnotes generator
641/////////////////////////////////////////////////////////////////////
642
643/* Based on footnote generation code from:
644 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
645 */
646
647footnotes: function () {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]648 // Delete existing footnote entries in case we're reloading the footnodes.
649 var i;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]650 var noteholder = document.getElementById("footnotes");
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]651 if (!noteholder) {
652 return;
653 }
654 var entriesToRemove = [];
655 for (i = 0; i < noteholder.childNodes.length; i++) {
656 var entry = noteholder.childNodes[i];
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]657 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]658 entriesToRemove.push(entry);
659 }
660 for (i = 0; i < entriesToRemove.length; i++) {
661 noteholder.removeChild(entriesToRemove[i]);
662 }
663
664 // Rebuild footnote entries.
665 var cont = document.getElementById("content");
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]666 var spans = cont.getElementsByTagName("span");
667 var refs = {};
668 var n = 0;
669 for (i=0; i<spans.length; i++) {
670 if (spans[i].className == "footnote") {
671 n++;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]672 var note = spans[i].getAttribute("data-note");
673 if (!note) {
674 // Use [\s\S] in place of . so multi-line matches work.
675 // Because JavaScript has no s (dotall) regex flag.
676 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
677 spans[i].innerHTML =
678 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
679 "' title='View footnote' class='footnote'>" + n + "</a>]";
680 spans[i].setAttribute("data-note", note);
681 }
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]682 noteholder.innerHTML +=
683 "<div class='footnote' id='_footnote_" + n + "'>" +
684 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
685 n + "</a>. " + note + "</div>";
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]686 var id =spans[i].getAttribute("id");
687 if (id != null) refs["#"+id] = n;
688 }
689 }
690 if (n == 0)
691 noteholder.parentNode.removeChild(noteholder);
692 else {
693 // Process footnoterefs.
694 for (i=0; i<spans.length; i++) {
695 if (spans[i].className == "footnoteref") {
696 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
697 href = href.match(/#.*/)[0]; // Because IE return full URL.
698 n = refs[href];
699 spans[i].innerHTML =
700 "[<a href='#_footnote_" + n +
701 "' title='View footnote' class='footnote'>" + n + "</a>]";
702 }
703 }
704 }
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]705},
706
707install: function(toclevels) {
708 var timerId;
709
710 function reinstall() {
711 asciidoc.footnotes();
712 if (toclevels) {
713 asciidoc.toc(toclevels);
714 }
715 }
716
717 function reinstallAndRemoveTimer() {
718 clearInterval(timerId);
719 reinstall();
720 }
721
722 timerId = setInterval(reinstall, 500);
723 if (document.addEventListener)
724 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
725 else
726 window.onload = reinstallAndRemoveTimer;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]727}
728
729}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]730asciidoc.install();
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]731/*]]>*/
732</script>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]733</head>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]734<body class="manpage">
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]735<div id="header">
736<h1>
737gittutorial-2(7) Manual Page
738</h1>
739<h2>NAME</h2>
740<div class="sectionbody">
741<p>gittutorial-2 -
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]742 A tutorial introduction to Git: part two
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]743</p>
744</div>
745</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]746<div id="content">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]747<div class="sect1">
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]748<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]749<div class="sectionbody">
Junio C Hamano15567bc2011-07-23 00:51:59[diff] [blame]750<div class="verseblock">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]751<pre class="content">git *</pre>
752<div class="attribution">
Junio C Hamano15567bc2011-07-23 00:51:59[diff] [blame]753</div></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]754</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]755</div>
756<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]757<h2 id="_description">DESCRIPTION</h2>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]758<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]759<div class="paragraph"><p>You should work through <a href="gittutorial.html">gittutorial(7)</a> before reading this tutorial.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]760<div class="paragraph"><p>The goal of this tutorial is to introduce two fundamental pieces of
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]761Git&#8217;s architecture&#8212;the object database and the index file&#8212;and to
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]762provide the reader with everything necessary to understand the rest
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]763of the Git documentation.</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]764</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]765</div>
766<div class="sect1">
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]767<h2 id="_the_git_object_database">The Git object database</h2>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]768<div class="sectionbody">
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]769<div class="paragraph"><p>Let&#8217;s start a new project and create a small amount of history:</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]770<div class="listingblock">
771<div class="content">
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]772<pre><code>$ mkdir test-project
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]773$ cd test-project
774$ git init
775Initialized empty Git repository in .git/
776$ echo 'hello world' &gt; file.txt
777$ git add .
778$ git commit -a -m "initial commit"
Junio C Hamanobc4852e2009-01-21 10:51:14[diff] [blame]779[master (root-commit) 54196cc] initial commit
Junio C Hamanod3004032012-02-13 08:09:03[diff] [blame]780 1 file changed, 1 insertion(+)
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]781 create mode 100644 file.txt
782$ echo 'hello world!' &gt;file.txt
783$ git commit -a -m "add emphasis"
Junio C Hamanobc4852e2009-01-21 10:51:14[diff] [blame]784[master c4d59f3] add emphasis
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]785 1 file changed, 1 insertion(+), 1 deletion(-)</code></pre>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]786</div></div>
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]787<div class="paragraph"><p>What are the 7 digits of hex that Git responded to the commit with?</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]788<div class="paragraph"><p>We saw in part one of the tutorial that commits have names like this.
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]789It turns out that every object in the Git history is stored under
Junio C Hamanoe3f080d2013-04-22 02:27:13[diff] [blame]790a 40-digit hex name. That name is the SHA-1 hash of the object&#8217;s
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]791contents; among other things, this ensures that Git will never store
Junio C Hamanoe3f080d2013-04-22 02:27:13[diff] [blame]792the same data twice (since identical data is given an identical SHA-1
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]793name), and that the contents of a Git object will never change (since
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]794that would change the object&#8217;s name as well). The 7 char hex strings
Junio C Hamanoa2deec52008-10-18 18:58:09[diff] [blame]795here are simply the abbreviation of such 40 character long strings.
796Abbreviations can be used everywhere where the 40 character strings
797can be used, so long as they are unambiguous.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]798<div class="paragraph"><p>It is expected that the content of the commit object you created while
Junio C Hamanoe3f080d2013-04-22 02:27:13[diff] [blame]799following the example above generates a different SHA-1 hash than
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]800the one shown above because the commit object records the time when
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]801it was created and the name of the person performing the commit.</p></div>
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]802<div class="paragraph"><p>We can ask Git about this particular object with the <code>cat-file</code>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]803command. Don&#8217;t copy the 40 hex digits from this example but use those
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]804from your own version. Note that you can shorten it to only a few
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]805characters to save yourself typing all 40 hex digits:</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]806<div class="listingblock">
807<div class="content">
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]808<pre><code>$ git cat-file -t 54196cc2
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]809commit
Junio C Hamano432d8ee2008-06-27 08:26:43[diff] [blame]810$ git cat-file commit 54196cc2
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]811tree 92b8b694ffb1675e5975148e1121810081dbdffe
812author J. Bruce Fields &lt;bfields@puzzle.fieldses.org&gt; 1143414668 -0500
813committer J. Bruce Fields &lt;bfields@puzzle.fieldses.org&gt; 1143414668 -0500
814
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]815initial commit</code></pre>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]816</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]817<div class="paragraph"><p>A tree can refer to one or more "blob" objects, each corresponding to
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]818a file. In addition, a tree can also refer to other tree objects,
819thus creating a directory hierarchy. You can examine the contents of
820any tree using ls-tree (remember that a long enough initial portion
Junio C Hamanoe3f080d2013-04-22 02:27:13[diff] [blame]821of the SHA-1 will also work):</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]822<div class="listingblock">
823<div class="content">
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]824<pre><code>$ git ls-tree 92b8b694
825100644 blob 3b18e512dba79e4c8300dd08aeb37f8e728b8dad file.txt</code></pre>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]826</div></div>
Junio C Hamanoe3f080d2013-04-22 02:27:13[diff] [blame]827<div class="paragraph"><p>Thus we see that this tree has one file in it. The SHA-1 hash is a
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]828reference to that file&#8217;s data:</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]829<div class="listingblock">
830<div class="content">
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]831<pre><code>$ git cat-file -t 3b18e512
832blob</code></pre>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]833</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]834<div class="paragraph"><p>A "blob" is just file data, which we can also examine with cat-file:</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]835<div class="listingblock">
836<div class="content">
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]837<pre><code>$ git cat-file blob 3b18e512
838hello world</code></pre>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]839</div></div>
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]840<div class="paragraph"><p>Note that this is the old file data; so the object that Git named in
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]841its response to the initial tree was a tree with a snapshot of the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]842directory state that was recorded by the first commit.</p></div>
Junio C Hamanoe3f080d2013-04-22 02:27:13[diff] [blame]843<div class="paragraph"><p>All of these objects are stored under their SHA-1 names inside the Git
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]844directory:</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]845<div class="listingblock">
846<div class="content">
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]847<pre><code>$ find .git/objects/
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]848.git/objects/
849.git/objects/pack
850.git/objects/info
851.git/objects/3b
852.git/objects/3b/18e512dba79e4c8300dd08aeb37f8e728b8dad
853.git/objects/92
854.git/objects/92/b8b694ffb1675e5975148e1121810081dbdffe
855.git/objects/54
856.git/objects/54/196cc2703dc165cbd373a65a4dcf22d50ae7f7
857.git/objects/a0
858.git/objects/a0/423896973644771497bdc03eb99d5281615b51
859.git/objects/d0
860.git/objects/d0/492b368b66bdabf2ac1fd8c92b39d3db916e59
861.git/objects/c4
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]862.git/objects/c4/d59f390b9cfd4318117afde11d601c1085f241</code></pre>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]863</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]864<div class="paragraph"><p>and the contents of these files is just the compressed data plus a
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]865header identifying their length and their type. The type is either a
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]866blob, a tree, a commit, or a tag.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]867<div class="paragraph"><p>The simplest commit to find is the HEAD commit, which we can find
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]868from .git/HEAD:</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]869<div class="listingblock">
870<div class="content">
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]871<pre><code>$ cat .git/HEAD
872ref: refs/heads/master</code></pre>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]873</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]874<div class="paragraph"><p>As you can see, this tells us which branch we&#8217;re currently on, and it
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]875tells us this by naming a file under the .git directory, which itself
Junio C Hamanoe3f080d2013-04-22 02:27:13[diff] [blame]876contains a SHA-1 name referring to a commit object, which we can
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]877examine with cat-file:</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]878<div class="listingblock">
879<div class="content">
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]880<pre><code>$ cat .git/refs/heads/master
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]881c4d59f390b9cfd4318117afde11d601c1085f241
882$ git cat-file -t c4d59f39
883commit
884$ git cat-file commit c4d59f39
885tree d0492b368b66bdabf2ac1fd8c92b39d3db916e59
886parent 54196cc2703dc165cbd373a65a4dcf22d50ae7f7
887author J. Bruce Fields &lt;bfields@puzzle.fieldses.org&gt; 1143418702 -0500
888committer J. Bruce Fields &lt;bfields@puzzle.fieldses.org&gt; 1143418702 -0500
889
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]890add emphasis</code></pre>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]891</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]892<div class="paragraph"><p>The "tree" object here refers to the new state of the tree:</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]893<div class="listingblock">
894<div class="content">
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]895<pre><code>$ git ls-tree d0492b36
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]896100644 blob a0423896973644771497bdc03eb99d5281615b51 file.txt
897$ git cat-file blob a0423896
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]898hello world!</code></pre>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]899</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]900<div class="paragraph"><p>and the "parent" object refers to the previous commit:</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]901<div class="listingblock">
902<div class="content">
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]903<pre><code>$ git cat-file commit 54196cc2
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]904tree 92b8b694ffb1675e5975148e1121810081dbdffe
905author J. Bruce Fields &lt;bfields@puzzle.fieldses.org&gt; 1143414668 -0500
906committer J. Bruce Fields &lt;bfields@puzzle.fieldses.org&gt; 1143414668 -0500
907
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]908initial commit</code></pre>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]909</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]910<div class="paragraph"><p>The tree object is the tree we examined first, and this commit is
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]911unusual in that it lacks any parent.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]912<div class="paragraph"><p>Most commits have only one parent, but it is also common for a commit
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]913to have multiple parents. In that case the commit represents a
914merge, with the parent references pointing to the heads of the merged
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]915branches.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]916<div class="paragraph"><p>Besides blobs, trees, and commits, the only remaining type of object
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]917is a "tag", which we won&#8217;t discuss here; refer to <a href="git-tag.html">git-tag(1)</a>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]918for details.</p></div>
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]919<div class="paragraph"><p>So now we know how Git uses the object database to represent a
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]920project&#8217;s history:</p></div>
921<div class="ulist"><ul>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]922<li>
923<p>
924"commit" objects refer to "tree" objects representing the
925 snapshot of a directory tree at a particular point in the
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]926 history, and refer to "parent" commits to show how they&#8217;re
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]927 connected into the project history.
928</p>
929</li>
930<li>
931<p>
932"tree" objects represent the state of a single directory,
933 associating directory names to "blob" objects containing file
934 data and "tree" objects containing subdirectory information.
935</p>
936</li>
937<li>
938<p>
939"blob" objects contain file data without any other structure.
940</p>
941</li>
942<li>
943<p>
944References to commit objects at the head of each branch are
945 stored in files under .git/refs/heads/.
946</p>
947</li>
948<li>
949<p>
950The name of the current branch is stored in .git/HEAD.
951</p>
952</li>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]953</ul></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]954<div class="paragraph"><p>Note, by the way, that lots of commands take a tree as an argument.
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]955But as we can see above, a tree can be referred to in many different
Junio C Hamanoe3f080d2013-04-22 02:27:13[diff] [blame]956ways&#8212;by the SHA-1 name for that tree, by the name of a commit that
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]957refers to the tree, by the name of a branch whose head refers to that
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]958tree, etc.--and most such commands can accept any of these names.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]959<div class="paragraph"><p>In command synopses, the word "tree-ish" is sometimes used to
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]960designate such an argument.</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]961</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]962</div>
963<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]964<h2 id="_the_index_file">The index file</h2>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]965<div class="sectionbody">
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]966<div class="paragraph"><p>The primary tool we&#8217;ve been using to create commits is <code>git-commit
967-a</code>, which creates a commit including every change you&#8217;ve made to
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]968your working tree. But what if you want to commit changes only to
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]969certain files? Or only certain changes to certain files?</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]970<div class="paragraph"><p>If we look at the way commits are created under the cover, we&#8217;ll see
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]971that there are more flexible ways creating commits.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]972<div class="paragraph"><p>Continuing with our test-project, let&#8217;s modify file.txt again:</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]973<div class="listingblock">
974<div class="content">
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]975<pre><code>$ echo "hello world, again" &gt;&gt;file.txt</code></pre>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]976</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]977<div class="paragraph"><p>but this time instead of immediately making the commit, let&#8217;s take an
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]978intermediate step, and ask for diffs along the way to keep track of
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]979what&#8217;s happening:</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]980<div class="listingblock">
981<div class="content">
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]982<pre><code>$ git diff
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]983--- a/file.txt
984+++ b/file.txt
985@@ -1 +1,2 @@
986 hello world!
987+hello world, again
988$ git add file.txt
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]989$ git diff</code></pre>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]990</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]991<div class="paragraph"><p>The last diff is empty, but no new commits have been made, and the
992head still doesn&#8217;t contain the new line:</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]993<div class="listingblock">
994<div class="content">
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]995<pre><code>$ git diff HEAD
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]996diff --git a/file.txt b/file.txt
997index a042389..513feba 100644
998--- a/file.txt
999+++ b/file.txt
1000@@ -1 +1,2 @@
1001 hello world!
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]1002+hello world, again</code></pre>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1003</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]1004<div class="paragraph"><p>So <em>git diff</em> is comparing against something other than the head.
1005The thing that it&#8217;s comparing against is actually the index file,
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1006which is stored in .git/index in a binary format, but whose contents
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1007we can examine with ls-files:</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1008<div class="listingblock">
1009<div class="content">
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]1010<pre><code>$ git ls-files --stage
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1011100644 513feba2e53ebbd2532419ded848ba19de88ba00 0 file.txt
1012$ git cat-file -t 513feba2
1013blob
1014$ git cat-file blob 513feba2
1015hello world!
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]1016hello world, again</code></pre>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1017</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]1018<div class="paragraph"><p>So what our <em>git add</em> did was store a new blob and then put
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1019a reference to it in the index file. If we modify the file again,
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]1020we&#8217;ll see that the new modifications are reflected in the <em>git diff</em>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1021output:</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1022<div class="listingblock">
1023<div class="content">
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]1024<pre><code>$ echo 'again?' &gt;&gt;file.txt
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1025$ git diff
1026index 513feba..ba3da7b 100644
1027--- a/file.txt
1028+++ b/file.txt
1029@@ -1,2 +1,3 @@
1030 hello world!
1031 hello world, again
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]1032+again?</code></pre>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1033</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]1034<div class="paragraph"><p>With the right arguments, <em>git diff</em> can also show us the difference
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1035between the working directory and the last commit, or between the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1036index and the last commit:</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1037<div class="listingblock">
1038<div class="content">
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]1039<pre><code>$ git diff HEAD
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1040diff --git a/file.txt b/file.txt
1041index a042389..ba3da7b 100644
1042--- a/file.txt
1043+++ b/file.txt
1044@@ -1 +1,3 @@
1045 hello world!
1046+hello world, again
1047+again?
1048$ git diff --cached
1049diff --git a/file.txt b/file.txt
1050index a042389..513feba 100644
1051--- a/file.txt
1052+++ b/file.txt
1053@@ -1 +1,2 @@
1054 hello world!
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]1055+hello world, again</code></pre>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1056</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]1057<div class="paragraph"><p>At any time, we can create a new commit using <em>git commit</em> (without
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]1058the "-a" option), and verify that the state committed only includes the
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1059changes stored in the index file, not the additional change that is
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1060still only in our working tree:</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1061<div class="listingblock">
1062<div class="content">
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]1063<pre><code>$ git commit -m "repeat"
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1064$ git diff HEAD
1065diff --git a/file.txt b/file.txt
1066index 513feba..ba3da7b 100644
1067--- a/file.txt
1068+++ b/file.txt
1069@@ -1,2 +1,3 @@
1070 hello world!
1071 hello world, again
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]1072+again?</code></pre>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1073</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]1074<div class="paragraph"><p>So by default <em>git commit</em> uses the index to create the commit, not
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]1075the working tree; the "-a" option to commit tells it to first update
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1076the index with all changes in the working tree.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]1077<div class="paragraph"><p>Finally, it&#8217;s worth looking at the effect of <em>git add</em> on the index
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1078file:</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1079<div class="listingblock">
1080<div class="content">
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]1081<pre><code>$ echo "goodbye, world" &gt;closing.txt
1082$ git add closing.txt</code></pre>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1083</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]1084<div class="paragraph"><p>The effect of the <em>git add</em> was to add one entry to the index file:</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1085<div class="listingblock">
1086<div class="content">
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]1087<pre><code>$ git ls-files --stage
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1088100644 8b9743b20d4b15be3955fc8d5cd2b09cd2336138 0 closing.txt
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]1089100644 513feba2e53ebbd2532419ded848ba19de88ba00 0 file.txt</code></pre>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1090</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]1091<div class="paragraph"><p>And, as you can see with cat-file, this new entry refers to the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1092current contents of the file:</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1093<div class="listingblock">
1094<div class="content">
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]1095<pre><code>$ git cat-file blob 8b9743b2
1096goodbye, world</code></pre>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1097</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]1098<div class="paragraph"><p>The "status" command is a useful way to get a quick summary of the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1099situation:</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1100<div class="listingblock">
1101<div class="content">
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]1102<pre><code>$ git status
Junio C Hamano13220242014-11-19 23:06:27[diff] [blame]1103On branch master
1104Changes to be committed:
1105 (use "git reset HEAD &lt;file&gt;..." to unstage)
1106
1107 new file: closing.txt
1108
1109Changes not staged for commit:
1110 (use "git add &lt;file&gt;..." to update what will be committed)
1111 (use "git checkout -- &lt;file&gt;..." to discard changes in working directory)
1112
1113 modified: file.txt</code></pre>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1114</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]1115<div class="paragraph"><p>Since the current state of closing.txt is cached in the index file,
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1116it is listed as "Changes to be committed". Since file.txt has
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]1117changes in the working directory that aren&#8217;t reflected in the index,
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1118it is marked "changed but not updated". At this point, running "git
1119commit" would create a commit that added closing.txt (with its new
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]1120contents), but that didn&#8217;t modify file.txt.</p></div>
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]1121<div class="paragraph"><p>Also, note that a bare <code>git diff</code> shows the changes to file.txt, but
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1122not the addition of closing.txt, because the version of closing.txt
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1123in the index file is identical to the one in the working directory.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]1124<div class="paragraph"><p>In addition to being the staging area for new commits, the index file
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1125is also populated from the object database when checking out a
1126branch, and is used to hold the trees involved in a merge operation.
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]1127See <a href="gitcore-tutorial.html">gitcore-tutorial(7)</a> and the relevant man
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1128pages for details.</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1129</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1130</div>
1131<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1132<h2 id="_what_next">What next?</h2>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1133<div class="sectionbody">
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]1134<div class="paragraph"><p>At this point you should know everything necessary to read the man
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1135pages for any of the git commands; one good place to start would be
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]1136with the commands mentioned in <a href="giteveryday.html">giteveryday(7)</a>. You
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]1137should be able to find any unknown jargon in <a href="gitglossary.html">gitglossary(7)</a>.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]1138<div class="paragraph"><p>The <a href="user-manual.html">Git User&#8217;s Manual</a> provides a more
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]1139comprehensive introduction to Git.</p></div>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]1140<div class="paragraph"><p><a href="gitcvs-migration.html">gitcvs-migration(7)</a> explains how to
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]1141import a CVS repository into Git, and shows how to use Git in a
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1142CVS-like way.</p></div>
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]1143<div class="paragraph"><p>For some interesting examples of Git use, see the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1144<a href="howto-index.html">howtos</a>.</p></div>
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]1145<div class="paragraph"><p>For Git developers, <a href="gitcore-tutorial.html">gitcore-tutorial(7)</a> goes
1146into detail on the lower-level Git mechanisms involved in, for
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1147example, creating a new commit.</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1148</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1149</div>
1150<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1151<h2 id="_see_also">SEE ALSO</h2>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1152<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]1153<div class="paragraph"><p><a href="gittutorial.html">gittutorial(7)</a>,
1154<a href="gitcvs-migration.html">gitcvs-migration(7)</a>,
1155<a href="gitcore-tutorial.html">gitcore-tutorial(7)</a>,
1156<a href="gitglossary.html">gitglossary(7)</a>,
1157<a href="git-help.html">git-help(1)</a>,
Junio C Hamano446e30b2014-10-16 21:30:32[diff] [blame]1158<a href="giteveryday.html">giteveryday(7)</a>,
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]1159<a href="user-manual.html">The Git User&#8217;s Manual</a></p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1160</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1161</div>
1162<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1163<h2 id="_git">GIT</h2>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1164<div class="sectionbody">
Junio C Hamanoe89102f2017-02-15 23:18:15[diff] [blame]1165<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1166</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]1167</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1168</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]1169<div id="footnotes"><hr /></div>
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1170<div id="footer">
1171<div id="footer-text">
Junio C Hamano919d24f2017-05-09 14:51:22[diff] [blame]1172Last updated 2017-02-16 08:17:51 JST
Junio C Hamanodfccbb02008-05-26 01:16:14[diff] [blame]1173</div>
1174</div>
1175</body>
1176</html>