Google Git
Sign in
chromium / external / gitster / git-htmldocs / a129545d44f1f0fe9976ed87b9a7331bf239b7d8 / . / gitmodules.html
blob: f0ac62bf828127cd594b6e0c33e04cc1a57f1e26 [file] [log] [blame]
Junio C Hamano6926bef2007-06-16 09:54:05[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 Hamano0d75e872010-12-17 06:57:26[diff] [blame]7<title>gitmodules(5)</title>
Junio C Hamano6926bef2007-06-16 09:54:05[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 Hamano17bd2272008-09-01 06:11:17[diff] [blame]20a {
21 color: blue;
22 text-decoration: underline;
23}
24a:visited {
25 color: fuchsia;
26}
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]27
28em {
29 font-style: italic;
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]30 color: navy;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]31}
32
33strong {
34 font-weight: bold;
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]35 color: #083194;
Junio C Hamano6926bef2007-06-16 09:54:05[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 Hamano17bd2272008-09-01 06:11:17[diff] [blame]50h1, h2, h3 {
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]51 border-bottom: 2px solid silver;
52}
53h2 {
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]54 padding-top: 0.5em;
55}
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]56h3 {
57 float: left;
58}
59h3 + * {
60 clear: left;
61}
Junio C Hamano6926bef2007-06-16 09:54:05[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 Hamano0d75e872010-12-17 06:57:26[diff] [blame]77ul, ol, li > p {
78 margin-top: 0;
79}
80
Junio C Hamano6926bef2007-06-16 09:54:05[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 Hamano17bd2272008-09-01 06:11:17[diff] [blame]90 font-size: 1.1em;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]91}
92span#email {
93}
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]94span#revnumber, span#revdate, span#revremark {
Junio C Hamano6926bef2007-06-16 09:54:05[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 Hamano0d75e872010-12-17 06:57:26[diff] [blame]114div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
117}
Junio C Hamano6926bef2007-06-16 09:54:05[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 Hamano6926bef2007-06-16 09:54:05[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 Hamano6926bef2007-06-16 09:54:05[diff] [blame]129}
130
131div.content { /* Block element content. */
132 padding: 0;
133}
134
135/* Block element titles. */
136div.title, caption.title {
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]137 color: #527bbd;
Junio C Hamano6926bef2007-06-16 09:54:05[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 Hamano0d75e872010-12-17 06:57:26[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 Hamano6926bef2007-06-16 09:54:05[diff] [blame]176}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]177
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]178div.quoteblock > div.attribution {
179 padding-top: 0.5em;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]180 text-align: right;
181}
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]182
Junio C Hamano0d75e872010-12-17 06:57:26[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 Hamano17bd2272008-09-01 06:11:17[diff] [blame]191div.verseblock + div.attribution {
192 text-align: left;
193}
Junio C Hamano6926bef2007-06-16 09:54:05[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 Hamano6926bef2007-06-16 09:54:05[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 Hamano6926bef2007-06-16 09:54:05[diff] [blame]211}
212
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]213div.imageblock div.content { padding-left: 0; }
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]214span.image img { border-style: none; }
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]215a.image:visited { color: white; }
Junio C Hamano6926bef2007-06-16 09:54:05[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 Hamano0d75e872010-12-17 06:57:26[diff] [blame]224 font-style: normal;
225 color: navy;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]226}
227dd > *:first-child {
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]228 margin-top: 0.1em;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]229}
230
231ul, ol {
232 list-style-position: outside;
233}
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]234ol.arabic {
235 list-style-type: decimal;
236}
237ol.loweralpha {
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]238 list-style-type: lower-alpha;
239}
Junio C Hamano0d75e872010-12-17 06:57:26[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 Hamano6926bef2007-06-16 09:54:05[diff] [blame]256
257div.tableblock > table {
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]258 border: 3px solid #527bbd;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]259}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]260thead, p.table.header {
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]261 font-family: sans-serif;
262 font-weight: bold;
263}
264tfoot {
265 font-weight: bold;
266}
Junio C Hamano0d75e872010-12-17 06:57:26[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 Hamano6926bef2007-06-16 09:54:05[diff] [blame]285
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]286
287div.hdlist {
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
290}
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]291div.hdlist tr {
292 padding-bottom: 15px;
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]293}
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]294dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
296}
297td.hdlist1 {
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]298 vertical-align: top;
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]299 font-style: normal;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]300 padding-right: 0.8em;
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]301 color: navy;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]302}
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]303td.hdlist2 {
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]304 vertical-align: top;
305}
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]306div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
309}
310
311.comment {
312 background: yellow;
313}
Junio C Hamano6926bef2007-06-16 09:54:05[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 Hamano6926bef2007-06-16 09:54:05[diff] [blame]343@media print {
344 div#footer-badges { display: none; }
345}
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]346
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]347div#toc {
348 margin-bottom: 2.5em;
349}
350
Junio C Hamano17bd2272008-09-01 06:11:17[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 Hamano0d75e872010-12-17 06:57:26[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 Hamano6926bef2007-06-16 09:54:05[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 Hamano0d75e872010-12-17 06:57:26[diff] [blame]402 color: #527bbd;
Junio C Hamano6926bef2007-06-16 09:54:05[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 Hamano0d75e872010-12-17 06:57:26[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 Hamano6926bef2007-06-16 09:54:05[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 Hamano6926bef2007-06-16 09:54:05[diff] [blame]430 padding-left: 0.5em;
431}
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]432
433/* IE6 sets dynamically generated links as visited. */
434div#toc a:visited { color: blue; }
Junio C Hamano6926bef2007-06-16 09:54:05[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 Hamano6926bef2007-06-16 09:54:05[diff] [blame]569</head>
570<body>
571<div id="header">
572<h1>
573gitmodules(5) Manual Page
574</h1>
575<h2>NAME</h2>
576<div class="sectionbody">
577<p>gitmodules -
578 defining submodule properties
579</p>
580</div>
581</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]582<div id="content">
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]583<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]584<div class="sectionbody">
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]585<div class="paragraph"><p>$GIT_WORK_DIR/.gitmodules</p></div>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]586</div>
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]587<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]588<div class="sectionbody">
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]589<div class="paragraph"><p>The <tt>.gitmodules</tt> file, located in the top-level directory of a git
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]590working tree, is a text file with a syntax matching the requirements
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]591of <a href="git-config.html">git-config(1)</a>.</p></div>
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]592<div class="paragraph"><p>The file contains one subsection per submodule, and the subsection value
Junio C Hamanoa1295452012-11-13 22:32:04[diff] [blame^]593is the name of the submodule. The name is set to the path where the
594submodule has been added unless it was customized with the <em>--name</em>
595option of <em>git submodule add</em>. Each submodule section also contains the
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]596following required keys:</p></div>
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]597<div class="dlist"><dl>
598<dt class="hdlist1">
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]599submodule.&lt;name&gt;.path
600</dt>
601<dd>
602<p>
603 Defines the path, relative to the top-level directory of the git
604 working tree, where the submodule is expected to be checked out.
605 The path name must not end with a <tt>/</tt>. All submodule paths must
606 be unique within the .gitmodules file.
607</p>
608</dd>
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]609<dt class="hdlist1">
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]610submodule.&lt;name&gt;.url
611</dt>
612<dd>
613<p>
Junio C Hamano0ff98162012-03-31 18:19:09[diff] [blame]614 Defines a URL from which the submodule repository can be cloned.
Junio C Hamano78e3a782010-07-15 22:24:45[diff] [blame]615 This may be either an absolute URL ready to be passed to
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]616 <a href="git-clone.html">git-clone(1)</a> or (if it begins with ./ or ../) a location
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]617 relative to the superproject&#8217;s origin repository.
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]618</p>
619</dd>
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]620<dt class="hdlist1">
Junio C Hamano25e7ba62009-06-14 01:03:22[diff] [blame]621submodule.&lt;name&gt;.update
622</dt>
623<dd>
624<p>
625 Defines what to do when the submodule is updated by the superproject.
626 If <em>checkout</em> (the default), the new commit specified in the
627 superproject will be checked out in the submodule on a detached HEAD.
628 If <em>rebase</em>, the current branch of the submodule will be rebased onto
Junio C Hamano0e88f3e2009-06-21 08:03:25[diff] [blame]629 the commit specified in the superproject. If <em>merge</em>, the commit
630 specified in the superproject will be merged into the current branch
631 in the submodule.
Junio C Hamano4fdb4d62012-05-11 20:03:49[diff] [blame]632 If <em>none</em>, the submodule with name <tt>$name</tt> will not be updated
633 by default.
Junio C Hamano25e7ba62009-06-14 01:03:22[diff] [blame]634</p>
Junio C Hamano4fdb4d62012-05-11 20:03:49[diff] [blame]635<div class="literalblock">
636<div class="content">
637<pre><tt>This config option is overridden if 'git submodule update' is given
638the '--merge', '--rebase' or '--checkout' options.</tt></pre>
639</div></div>
Junio C Hamano25e7ba62009-06-14 01:03:22[diff] [blame]640</dd>
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]641<dt class="hdlist1">
642submodule.&lt;name&gt;.fetchRecurseSubmodules
643</dt>
644<dd>
645<p>
Junio C Hamano5cd15182011-04-05 00:21:10[diff] [blame]646 This option can be used to control recursive fetching of this
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]647 submodule. If this option is also present in the submodules entry in
648 .git/config of the superproject, the setting there will override the
649 one found in .gitmodules.
Junio C Hamano7165bf72011-01-04 22:06:18[diff] [blame]650 Both settings can be overridden on the command line by using the
Junio C Hamano5cd15182011-04-05 00:21:10[diff] [blame]651 "--[no-]recurse-submodules" option to "git fetch" and "git pull".
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]652</p>
653</dd>
654<dt class="hdlist1">
Junio C Hamano619596a2010-08-18 22:15:35[diff] [blame]655submodule.&lt;name&gt;.ignore
656</dt>
657<dd>
658<p>
659 Defines under what circumstances "git status" and the diff family show
660 a submodule as modified. When set to "all", it will never be considered
661 modified, "dirty" will ignore all changes to the submodules work tree and
662 takes only differences between the HEAD of the submodule and the commit
663 recorded in the superproject into account. "untracked" will additionally
664 let submodules with modified tracked files in their work tree show up.
665 Using "none" (the default when this option is not set) also shows
666 submodules that have untracked files in their work tree as changed.
667 If this option is also present in the submodules entry in .git/config of
668 the superproject, the setting there will override the one found in
669 .gitmodules.
Junio C Hamanode9745c2010-08-23 17:10:18[diff] [blame]670 Both settings can be overridden on the command line by using the
Junio C Hamano619596a2010-08-18 22:15:35[diff] [blame]671 "--ignore-submodule" option.
672</p>
673</dd>
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]674</dl></div>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]675</div>
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]676<h2 id="_examples">EXAMPLES</h2>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]677<div class="sectionbody">
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]678<div class="paragraph"><p>Consider the following .gitmodules file:</p></div>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]679<div class="literalblock">
680<div class="content">
681<pre><tt>[submodule "libfoo"]
682 path = include/foo
683 url = git://foo.com/git/lib.git</tt></pre>
684</div></div>
685<div class="literalblock">
686<div class="content">
687<pre><tt>[submodule "libbar"]
688 path = include/bar
689 url = git://bar.com/git/lib.git</tt></pre>
690</div></div>
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]691<div class="paragraph"><p>This defines two submodules, <tt>libfoo</tt> and <tt>libbar</tt>. These are expected to
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]692be checked out in the paths <em>include/foo</em> and <em>include/bar</em>, and for both
Junio C Hamano0ff98162012-03-31 18:19:09[diff] [blame]693submodules a URL is specified which can be used for cloning the submodules.</p></div>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]694</div>
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]695<h2 id="_see_also">SEE ALSO</h2>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]696<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]697<div class="paragraph"><p><a href="git-submodule.html">git-submodule(1)</a> <a href="git-config.html">git-config(1)</a></p></div>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]698</div>
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]699<h2 id="_git">GIT</h2>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]700<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]701<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]702</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]703</div>
704<div id="footnotes"><hr /></div>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]705<div id="footer">
706<div id="footer-text">
Junio C Hamanoa1295452012-11-13 22:32:04[diff] [blame^]707Last updated 2012-11-13 14:31:09 PDT
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]708</div>
709</div>
710</body>
711</html>