Google Git
Sign in
chromium / external / gitster / git-htmldocs / d7f343f3a5563a5c1b3f0c35659b84832df060b1 / . / gitrepository-layout.html
blob: 85990ecf911c7b1511ad6d4cc142f385619616c6 [file] [log] [blame]
Junio C Hamanof7c042d2008-06-06 22:50:53[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>
5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]6<meta name="generator" content="AsciiDoc 8.5.2" />
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]7<title>gitrepository-layout(5)</title>
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]8<style type="text/css">
9/* Debug borders */
10p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
11/*
12 border: 1px solid red;
13*/
14}
15
16body {
17 margin: 1em 5% 1em 5%;
18}
19
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]20a {
21 color: blue;
22 text-decoration: underline;
23}
24a:visited {
25 color: fuchsia;
26}
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]27
28em {
29 font-style: italic;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]30 color: navy;
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]31}
32
33strong {
34 font-weight: bold;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]35 color: #083194;
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]36}
37
38tt {
39 color: navy;
40}
41
42h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
48}
49
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]50h1, h2, h3 {
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]51 border-bottom: 2px solid silver;
52}
53h2 {
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]54 padding-top: 0.5em;
55}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]56h3 {
57 float: left;
58}
59h3 + * {
60 clear: left;
61}
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]62
63div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
66}
67
68hr {
69 border: 1px solid silver;
70}
71
72p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
75}
76
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]77ul, ol, li > p {
78 margin-top: 0;
79}
80
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]81pre {
82 padding: 0;
83 margin: 0;
84}
85
86span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]90 font-size: 1.1em;
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]91}
92span#email {
93}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]94span#revnumber, span#revdate, span#revremark {
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]95 font-family: sans-serif;
96}
97
98div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
104}
105div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
108}
109div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
112}
113
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]114div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
117}
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]118div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]121 margin-top: 1.0em;
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]122 margin-bottom: 1.5em;
123}
124div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]129}
130
131div.content { /* Block element content. */
132 padding: 0;
133}
134
135/* Block element titles. */
136div.title, caption.title {
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]137 color: #527bbd;
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
143}
144div.title + * {
145 margin-top: 0;
146}
147
148td div.title:first-child {
149 margin-top: 0.0em;
150}
151div.content div.title:first-child {
152 margin-top: 0.0em;
153}
154div.content + div.title {
155 margin-top: 0.0em;
156}
157
158div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
162}
163
164div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
168}
169
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]170div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]173 margin-right: 10%;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]174 border-left: 5px solid #dddddd;
175 color: #777777;
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]176}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]177
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]178div.quoteblock > div.attribution {
179 padding-top: 0.5em;
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]180 text-align: right;
181}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]182
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]183div.verseblock > div.content {
184 white-space: pre;
185}
186div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
189}
190/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]191div.verseblock + div.attribution {
192 text-align: left;
193}
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]194
195div.admonitionblock .icon {
196 vertical-align: top;
197 font-size: 1.1em;
198 font-weight: bold;
199 text-decoration: underline;
200 color: #527bbd;
201 padding-right: 0.5em;
202}
203div.admonitionblock td.content {
204 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]205 border-left: 3px solid #dddddd;
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]206}
207
208div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]211}
212
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]213div.imageblock div.content { padding-left: 0; }
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]214span.image img { border-style: none; }
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]215a.image:visited { color: white; }
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]216
217dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
220}
221dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]224 font-style: normal;
225 color: navy;
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]226}
227dd > *:first-child {
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]228 margin-top: 0.1em;
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]229}
230
231ul, ol {
232 list-style-position: outside;
233}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]234ol.arabic {
235 list-style-type: decimal;
236}
237ol.loweralpha {
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]238 list-style-type: lower-alpha;
239}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]240ol.upperalpha {
241 list-style-type: upper-alpha;
242}
243ol.lowerroman {
244 list-style-type: lower-roman;
245}
246ol.upperroman {
247 list-style-type: upper-roman;
248}
249
250div.compact ul, div.compact ol,
251div.compact p, div.compact p,
252div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
255}
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]256
257div.tableblock > table {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]258 border: 3px solid #527bbd;
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]259}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]260thead, p.table.header {
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]261 font-family: sans-serif;
262 font-weight: bold;
263}
264tfoot {
265 font-weight: bold;
266}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]267td > div.verse {
268 white-space: pre;
269}
270p.table {
271 margin-top: 0;
272}
273/* Because the table frame attribute is overriden by CSS in most browsers. */
274div.tableblock > table[frame="void"] {
275 border-style: none;
276}
277div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
280}
281div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
284}
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]285
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]286
287div.hdlist {
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
290}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]291div.hdlist tr {
292 padding-bottom: 15px;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]293}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]294dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
296}
297td.hdlist1 {
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]298 vertical-align: top;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]299 font-style: normal;
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]300 padding-right: 0.8em;
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]301 color: navy;
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]302}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]303td.hdlist2 {
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]304 vertical-align: top;
305}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]306div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
309}
310
311.comment {
312 background: yellow;
313}
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]314
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]315.footnote, .footnoteref {
316 font-size: 0.8em;
317}
318
319span.footnote, span.footnoteref {
320 vertical-align: super;
321}
322
323#footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
326}
327
328#footnotes div.footnote {
329 margin: 0 0 5px 0;
330}
331
332#footnotes hr {
333 border: none;
334 border-top: 1px solid silver;
335 height: 1px;
336 text-align: left;
337 margin-left: 0;
338 width: 20%;
339 min-width: 100px;
340}
341
342
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]343@media print {
344 div#footer-badges { display: none; }
345}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]346
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]347div#toc {
348 margin-bottom: 2.5em;
349}
350
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]351div#toctitle {
352 color: #527bbd;
353 font-family: sans-serif;
354 font-size: 1.1em;
355 font-weight: bold;
356 margin-top: 1.0em;
357 margin-bottom: 0.1em;
358}
359
360div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
363}
364div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
367}
368div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
371}
372div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
375}
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]376/* Overrides for manpage documents */
377h1 {
378 padding-top: 0.5em;
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver;
381 border-bottom: 2px solid silver;
382}
383h2 {
384 border-style: none;
385}
386div.sectionbody {
387 margin-left: 5%;
388}
389
390@media print {
391 div#toc { display: none; }
392}
393
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]394/* Workarounds for IE6's broken and incomplete CSS2. */
395
396div.sidebar-content {
397 background: #ffffee;
398 border: 1px solid silver;
399 padding: 0.5em;
400}
401div.sidebar-title, div.image-title {
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]402 color: #527bbd;
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]403 font-family: sans-serif;
404 font-weight: bold;
405 margin-top: 0.0em;
406 margin-bottom: 0.5em;
407}
408
409div.listingblock div.content {
410 border: 1px solid silver;
411 background: #f4f4f4;
412 padding: 0.5em;
413}
414
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]415div.quoteblock-attribution {
416 padding-top: 0.5em;
417 text-align: right;
418}
419
420div.verseblock-content {
421 white-space: pre;
422}
423div.verseblock-attribution {
424 padding-top: 0.75em;
425 text-align: left;
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]426}
427
428div.exampleblock-content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]429 border-left: 3px solid #dddddd;
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]430 padding-left: 0.5em;
431}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]432
433/* IE6 sets dynamically generated links as visited. */
434div#toc a:visited { color: blue; }
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]435</style>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]436<script type="text/javascript">
437/*<![CDATA[*/
438window.onload = function(){asciidoc.footnotes();}
439var asciidoc = { // Namespace.
440
441/////////////////////////////////////////////////////////////////////
442// Table Of Contents generator
443/////////////////////////////////////////////////////////////////////
444
445/* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
447 *
448 * Table Of Content generator
449 * Version: 0.4
450 *
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
453 */
454
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
457
458// toclevels = 1..4.
459toc: function (toclevels) {
460
461 function getText(el) {
462 var text = "";
463 for (var i = el.firstChild; i != null; i = i.nextSibling) {
464 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
465 text += i.data;
466 else if (i.firstChild != null)
467 text += getText(i);
468 }
469 return text;
470 }
471
472 function TocEntry(el, text, toclevel) {
473 this.element = el;
474 this.text = text;
475 this.toclevel = toclevel;
476 }
477
478 function tocEntries(el, toclevels) {
479 var result = new Array;
480 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
484 var iterate = function (el) {
485 for (var i = el.firstChild; i != null; i = i.nextSibling) {
486 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
487 var mo = re.exec(i.tagName);
488 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
489 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
490 }
491 iterate(i);
492 }
493 }
494 }
495 iterate(el);
496 return result;
497 }
498
499 var toc = document.getElementById("toc");
500 var entries = tocEntries(document.getElementById("content"), toclevels);
501 for (var i = 0; i < entries.length; ++i) {
502 var entry = entries[i];
503 if (entry.element.id == "")
504 entry.element.id = "_toc_" + i;
505 var a = document.createElement("a");
506 a.href = "#" + entry.element.id;
507 a.appendChild(document.createTextNode(entry.text));
508 var div = document.createElement("div");
509 div.appendChild(a);
510 div.className = "toclevel" + entry.toclevel;
511 toc.appendChild(div);
512 }
513 if (entries.length == 0)
514 toc.parentNode.removeChild(toc);
515},
516
517
518/////////////////////////////////////////////////////////////////////
519// Footnotes generator
520/////////////////////////////////////////////////////////////////////
521
522/* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
524 */
525
526footnotes: function () {
527 var cont = document.getElementById("content");
528 var noteholder = document.getElementById("footnotes");
529 var spans = cont.getElementsByTagName("span");
530 var refs = {};
531 var n = 0;
532 for (i=0; i<spans.length; i++) {
533 if (spans[i].className == "footnote") {
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder.innerHTML +=
539 "<div class='footnote' id='_footnote_" + n + "'>" +
540 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
541 n + "</a>. " + note + "</div>";
542 spans[i].innerHTML =
543 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
544 "' title='View footnote' class='footnote'>" + n + "</a>]";
545 var id =spans[i].getAttribute("id");
546 if (id != null) refs["#"+id] = n;
547 }
548 }
549 if (n == 0)
550 noteholder.parentNode.removeChild(noteholder);
551 else {
552 // Process footnoterefs.
553 for (i=0; i<spans.length; i++) {
554 if (spans[i].className == "footnoteref") {
555 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
556 href = href.match(/#.*/)[0]; // Because IE return full URL.
557 n = refs[href];
558 spans[i].innerHTML =
559 "[<a href='#_footnote_" + n +
560 "' title='View footnote' class='footnote'>" + n + "</a>]";
561 }
562 }
563 }
564}
565
566}
567/*]]>*/
568</script>
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]569</head>
570<body>
571<div id="header">
572<h1>
573gitrepository-layout(5) Manual Page
574</h1>
575<h2>NAME</h2>
576<div class="sectionbody">
577<p>gitrepository-layout -
578 Git Repository Layout
579</p>
580</div>
581</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]582<div id="content">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]583<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]584<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]585<div class="paragraph"><p>$GIT_DIR/*</p></div>
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]586</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]587<h2 id="_description">DESCRIPTION</h2>
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]588<div class="sectionbody">
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]589<div class="paragraph"><p>You may find these things in your git repository (<tt>.git</tt>
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]590directory for a repository associated with your working tree, or
591<tt>&lt;project&gt;.git</tt> directory for a public <em>bare</em> repository. It is
592also possible to have a working tree where <tt>.git</tt> is a plain
Junio C Hamano619596a2010-08-18 22:15:35[diff] [blame]593ASCII file containing <tt>gitdir: &lt;path&gt;</tt>, i.e. the path to the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]594real git repository).</p></div>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]595<div class="dlist"><dl>
596<dt class="hdlist1">
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]597objects
598</dt>
599<dd>
600<p>
601 Object store associated with this repository. Usually
602 an object store is self sufficient (i.e. all the objects
603 that are referred to by an object found in it are also
Junio C Hamano6e41cb32011-08-29 07:12:49[diff] [blame]604 found in it), but there are a few ways to violate it.
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]605</p>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]606<div class="olist arabic"><ol class="arabic">
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]607<li>
608<p>
Junio C Hamano6e41cb32011-08-29 07:12:49[diff] [blame]609You could have an incomplete but locally usable repository
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]610by creating a shallow clone. See <a href="git-clone.html">git-clone(1)</a>.
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]611</p>
612</li>
613<li>
614<p>
Junio C Hamano6e41cb32011-08-29 07:12:49[diff] [blame]615You could be using the <tt>objects/info/alternates</tt> or
616<tt>$GIT_ALTERNATE_OBJECT_DIRECTORIES</tt> mechanisms to <em>borrow</em>
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]617objects from other object stores. A repository with this kind
618of incomplete object store is not suitable to be published for
619use with dumb transports but otherwise is OK as long as
Junio C Hamano6e41cb32011-08-29 07:12:49[diff] [blame]620<tt>objects/info/alternates</tt> points at the object stores it
621borrows from.
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]622</p>
623</li>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]624</ol></div>
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]625</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]626<dt class="hdlist1">
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]627objects/[0-9a-f][0-9a-f]
628</dt>
629<dd>
630<p>
Junio C Hamano6e41cb32011-08-29 07:12:49[diff] [blame]631 A newly created object is stored in its own file.
632 The objects are splayed over 256 subdirectories using
633 the first two characters of the sha1 object name to
634 keep the number of directory entries in <tt>objects</tt>
635 itself to a manageable number. Objects found
636 here are often called <em>unpacked</em> (or <em>loose</em>) objects.
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]637</p>
638</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]639<dt class="hdlist1">
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]640objects/pack
641</dt>
642<dd>
643<p>
644 Packs (files that store many object in compressed form,
645 along with index files to allow them to be randomly
646 accessed) are found in this directory.
647</p>
648</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]649<dt class="hdlist1">
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]650objects/info
651</dt>
652<dd>
653<p>
654 Additional information about the object store is
655 recorded in this directory.
656</p>
657</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]658<dt class="hdlist1">
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]659objects/info/packs
660</dt>
661<dd>
662<p>
663 This file is to help dumb transports discover what packs
664 are available in this object store. Whenever a pack is
665 added or removed, <tt>git update-server-info</tt> should be run
666 to keep this file up-to-date if the repository is
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]667 published for dumb transports. <em>git repack</em> does this
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]668 by default.
669</p>
670</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]671<dt class="hdlist1">
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]672objects/info/alternates
673</dt>
674<dd>
675<p>
676 This file records paths to alternate object stores that
677 this object store borrows objects from, one pathname per
678 line. Note that not only native Git tools use it locally,
679 but the HTTP fetcher also tries to use it remotely; this
680 will usually work if you have relative paths (relative
681 to the object database, not to the repository!) in your
682 alternates file, but it will not work if you use absolute
683 paths unless the absolute path in filesystem and web URL
684 is the same. See also <em>objects/info/http-alternates</em>.
685</p>
686</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]687<dt class="hdlist1">
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]688objects/info/http-alternates
689</dt>
690<dd>
691<p>
692 This file records URLs to alternate object stores that
693 this object store borrows objects from, to be used when
694 the repository is fetched over HTTP.
695</p>
696</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]697<dt class="hdlist1">
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]698refs
699</dt>
700<dd>
701<p>
702 References are stored in subdirectories of this
Junio C Hamano6e41cb32011-08-29 07:12:49[diff] [blame]703 directory. The <em>git prune</em> command knows to preserve
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]704 objects reachable from refs found in this directory and
705 its subdirectories.
706</p>
707</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]708<dt class="hdlist1">
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]709refs/heads/<tt>name</tt>
710</dt>
711<dd>
712<p>
713 records tip-of-the-tree commit objects of branch <tt>name</tt>
714</p>
715</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]716<dt class="hdlist1">
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]717refs/tags/<tt>name</tt>
718</dt>
719<dd>
720<p>
721 records any object name (not necessarily a commit
722 object, or a tag object that points at a commit object).
723</p>
724</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]725<dt class="hdlist1">
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]726refs/remotes/<tt>name</tt>
727</dt>
728<dd>
729<p>
730 records tip-of-the-tree commit objects of branches copied
731 from a remote repository.
732</p>
733</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]734<dt class="hdlist1">
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]735packed-refs
736</dt>
737<dd>
738<p>
739 records the same information as refs/heads/, refs/tags/,
740 and friends record in a more efficient way. See
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]741 <a href="git-pack-refs.html">git-pack-refs(1)</a>.
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]742</p>
743</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]744<dt class="hdlist1">
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]745HEAD
746</dt>
747<dd>
748<p>
749 A symref (see glossary) to the <tt>refs/heads/</tt> namespace
750 describing the currently active branch. It does not mean
751 much if the repository is not associated with any working tree
752 (i.e. a <em>bare</em> repository), but a valid git repository
753 <strong>must</strong> have the HEAD file; some porcelains may use it to
754 guess the designated "default" branch of the repository
755 (usually <em>master</em>). It is legal if the named branch
756 <em>name</em> does not (yet) exist. In some legacy setups, it is
757 a symbolic link instead of a symref that points at the current
758 branch.
759</p>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]760<div class="paragraph"><p>HEAD can also record a specific commit directly, instead of
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]761being a symref to point at the current branch. Such a state
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]762is often called <em>detached HEAD.</em> See <a href="git-checkout.html">git-checkout(1)</a>
Junio C Hamano6e41cb32011-08-29 07:12:49[diff] [blame]763for details.</p></div>
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]764</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]765<dt class="hdlist1">
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]766branches
767</dt>
768<dd>
769<p>
770 A slightly deprecated way to store shorthands to be used
Junio C Hamano6e41cb32011-08-29 07:12:49[diff] [blame]771 to specify a URL to <em>git fetch</em>, <em>git pull</em> and <em>git push</em>.
772 A file can be stored as <tt>branches/&lt;name&gt;</tt> and then
773 <em>name</em> can be given to these commands in place of
774 <em>repository</em> argument. See the REMOTES section in
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]775 <a href="git-fetch.html">git-fetch(1)</a> for details. This mechanism is legacy
Junio C Hamano6e41cb32011-08-29 07:12:49[diff] [blame]776 and not likely to be found in modern repositories.
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]777</p>
778</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]779<dt class="hdlist1">
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]780hooks
781</dt>
782<dd>
783<p>
784 Hooks are customization scripts used by various git
785 commands. A handful of sample hooks are installed when
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]786 <em>git init</em> is run, but all of them are disabled by
Junio C Hamano116db352008-12-17 19:48:40[diff] [blame]787 default. To enable, the <tt>.sample</tt> suffix has to be
788 removed from the filename by renaming.
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]789 Read <a href="githooks.html">githooks(5)</a> for more details about
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]790 each hook.
791</p>
792</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]793<dt class="hdlist1">
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]794index
795</dt>
796<dd>
797<p>
798 The current index file for the repository. It is
799 usually not found in a bare repository.
800</p>
801</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]802<dt class="hdlist1">
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]803info
804</dt>
805<dd>
806<p>
807 Additional information about the repository is recorded
808 in this directory.
809</p>
810</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]811<dt class="hdlist1">
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]812info/refs
813</dt>
814<dd>
815<p>
816 This file helps dumb transports discover what refs are
817 available in this repository. If the repository is
818 published for dumb transports, this file should be
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]819 regenerated by <em>git update-server-info</em> every time a tag
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]820 or branch is created or modified. This is normally done
821 from the <tt>hooks/update</tt> hook, which is run by the
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]822 <em>git-receive-pack</em> command when you <em>git push</em> into the
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]823 repository.
824</p>
825</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]826<dt class="hdlist1">
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]827info/grafts
828</dt>
829<dd>
830<p>
831 This file records fake commit ancestry information, to
832 pretend the set of parents a commit has is different
833 from how the commit was actually created. One record
834 per line describes a commit and its fake parents by
835 listing their 40-byte hexadecimal object names separated
836 by a space and terminated by a newline.
837</p>
838</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]839<dt class="hdlist1">
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]840info/exclude
841</dt>
842<dd>
843<p>
844 This file, by convention among Porcelains, stores the
845 exclude pattern list. <tt>.gitignore</tt> is the per-directory
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]846 ignore file. <em>git status</em>, <em>git add</em>, <em>git rm</em> and
847 <em>git clean</em> look at it but the core git commands do not look
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]848 at it. See also: <a href="gitignore.html">gitignore(5)</a>.
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]849</p>
850</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]851<dt class="hdlist1">
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]852remotes
853</dt>
854<dd>
855<p>
Junio C Hamano6e41cb32011-08-29 07:12:49[diff] [blame]856 Stores shorthands for URL and default refnames for use
857 when interacting with remote repositories via <em>git fetch</em>,
858 <em>git pull</em> and <em>git push</em> commands. See the REMOTES section
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]859 in <a href="git-fetch.html">git-fetch(1)</a> for details. This mechanism is legacy
Junio C Hamano6e41cb32011-08-29 07:12:49[diff] [blame]860 and not likely to be found in modern repositories.
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]861</p>
862</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]863<dt class="hdlist1">
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]864logs
865</dt>
866<dd>
867<p>
868 Records of changes made to refs are stored in this
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]869 directory. See <a href="git-update-ref.html">git-update-ref(1)</a>
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]870 for more information.
871</p>
872</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]873<dt class="hdlist1">
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]874logs/refs/heads/<tt>name</tt>
875</dt>
876<dd>
877<p>
878 Records all changes made to the branch tip named <tt>name</tt>.
879</p>
880</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]881<dt class="hdlist1">
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]882logs/refs/tags/<tt>name</tt>
883</dt>
884<dd>
885<p>
886 Records all changes made to the tag named <tt>name</tt>.
887</p>
888</dd>
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]889<dt class="hdlist1">
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]890shallow
891</dt>
892<dd>
893<p>
894 This is similar to <tt>info/grafts</tt> but is internally used
895 and maintained by shallow clone mechanism. See <tt>--depth</tt>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]896 option to <a href="git-clone.html">git-clone(1)</a> and <a href="git-fetch.html">git-fetch(1)</a>.
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]897</p>
898</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]899</dl></div>
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]900</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]901<h2 id="_see_also">SEE ALSO</h2>
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]902<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]903<div class="paragraph"><p><a href="git-init.html">git-init(1)</a>,
904<a href="git-clone.html">git-clone(1)</a>,
905<a href="git-fetch.html">git-fetch(1)</a>,
906<a href="git-pack-refs.html">git-pack-refs(1)</a>,
907<a href="git-gc.html">git-gc(1)</a>,
908<a href="git-checkout.html">git-checkout(1)</a>,
909<a href="gitglossary.html">gitglossary(7)</a>,
Junio C Hamano103b5722011-01-31 05:03:45[diff] [blame]910<a href="user-manual.html">The Git User&#8217;s Manual</a></p></div>
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]911</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]912<h2 id="_git">GIT</h2>
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]913<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]914<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite.</p></div>
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]915</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]916</div>
917<div id="footnotes"><hr /></div>
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]918<div id="footer">
919<div id="footer-text">
Junio C Hamano02194af2011-11-17 20:33:59[diff] [blame]920Last updated 2011-11-15 13:45:02 PDT
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]921</div>
922</div>
923</body>
924</html>