Google Git
Sign in
chromium / external / gitster / git-htmldocs / 5cd1518ba777d6d41a66941c1af682009f26138a / . / gitmodules.html
blob: 5763a27a6a10db7701d14d1a4399c9bb9f406179 [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 Hamano0d75e872010-12-17 06:57:26[diff] [blame]6<meta name="generator" content="AsciiDoc 8.4.5" />
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 Hamano6926bef2007-06-16 09:54:05[diff] [blame]121 margin-top: 1.5em;
122 margin-bottom: 1.5em;
123}
124div.admonitionblock {
125 margin-top: 2.5em;
126 margin-bottom: 2.5em;
127}
128
129div.content { /* Block element content. */
130 padding: 0;
131}
132
133/* Block element titles. */
134div.title, caption.title {
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]135 color: #527bbd;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]136 font-family: sans-serif;
137 font-weight: bold;
138 text-align: left;
139 margin-top: 1.0em;
140 margin-bottom: 0.5em;
141}
142div.title + * {
143 margin-top: 0;
144}
145
146td div.title:first-child {
147 margin-top: 0.0em;
148}
149div.content div.title:first-child {
150 margin-top: 0.0em;
151}
152div.content + div.title {
153 margin-top: 0.0em;
154}
155
156div.sidebarblock > div.content {
157 background: #ffffee;
158 border: 1px solid silver;
159 padding: 0.5em;
160}
161
162div.listingblock > div.content {
163 border: 1px solid silver;
164 background: #f4f4f4;
165 padding: 0.5em;
166}
167
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]168div.quoteblock {
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]169 padding-left: 2.0em;
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]170 margin-right: 10%;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]171}
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]172div.quoteblock > div.attribution {
173 padding-top: 0.5em;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]174 text-align: right;
175}
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]176
177div.verseblock {
178 padding-left: 2.0em;
179 margin-right: 10%;
180}
181div.verseblock > div.content {
182 white-space: pre;
183}
184div.verseblock > div.attribution {
185 padding-top: 0.75em;
186 text-align: left;
187}
188/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]189div.verseblock + div.attribution {
190 text-align: left;
191}
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]192
193div.admonitionblock .icon {
194 vertical-align: top;
195 font-size: 1.1em;
196 font-weight: bold;
197 text-decoration: underline;
198 color: #527bbd;
199 padding-right: 0.5em;
200}
201div.admonitionblock td.content {
202 padding-left: 0.5em;
203 border-left: 2px solid silver;
204}
205
206div.exampleblock > div.content {
207 border-left: 2px solid silver;
208 padding: 0.5em;
209}
210
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]211div.imageblock div.content { padding-left: 0; }
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]212span.image img { border-style: none; }
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]213a.image:visited { color: white; }
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]214
215dl {
216 margin-top: 0.8em;
217 margin-bottom: 0.8em;
218}
219dt {
220 margin-top: 0.5em;
221 margin-bottom: 0;
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]222 font-style: normal;
223 color: navy;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]224}
225dd > *:first-child {
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]226 margin-top: 0.1em;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]227}
228
229ul, ol {
230 list-style-position: outside;
231}
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]232ol.arabic {
233 list-style-type: decimal;
234}
235ol.loweralpha {
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]236 list-style-type: lower-alpha;
237}
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]238ol.upperalpha {
239 list-style-type: upper-alpha;
240}
241ol.lowerroman {
242 list-style-type: lower-roman;
243}
244ol.upperroman {
245 list-style-type: upper-roman;
246}
247
248div.compact ul, div.compact ol,
249div.compact p, div.compact p,
250div.compact div, div.compact div {
251 margin-top: 0.1em;
252 margin-bottom: 0.1em;
253}
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]254
255div.tableblock > table {
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]256 border: 3px solid #527bbd;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]257}
258thead {
259 font-family: sans-serif;
260 font-weight: bold;
261}
262tfoot {
263 font-weight: bold;
264}
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]265td > div.verse {
266 white-space: pre;
267}
268p.table {
269 margin-top: 0;
270}
271/* Because the table frame attribute is overriden by CSS in most browsers. */
272div.tableblock > table[frame="void"] {
273 border-style: none;
274}
275div.tableblock > table[frame="hsides"] {
276 border-left-style: none;
277 border-right-style: none;
278}
279div.tableblock > table[frame="vsides"] {
280 border-top-style: none;
281 border-bottom-style: none;
282}
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]283
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]284
285div.hdlist {
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]286 margin-top: 0.8em;
287 margin-bottom: 0.8em;
288}
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]289div.hdlist tr {
290 padding-bottom: 15px;
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]291}
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]292dt.hdlist1.strong, td.hdlist1.strong {
293 font-weight: bold;
294}
295td.hdlist1 {
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]296 vertical-align: top;
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]297 font-style: normal;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]298 padding-right: 0.8em;
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]299 color: navy;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]300}
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]301td.hdlist2 {
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]302 vertical-align: top;
303}
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]304div.hdlist.compact tr {
305 margin: 0;
306 padding-bottom: 0;
307}
308
309.comment {
310 background: yellow;
311}
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]312
313@media print {
314 div#footer-badges { display: none; }
315}
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]316
317div#toctitle {
318 color: #527bbd;
319 font-family: sans-serif;
320 font-size: 1.1em;
321 font-weight: bold;
322 margin-top: 1.0em;
323 margin-bottom: 0.1em;
324}
325
326div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
327 margin-top: 0;
328 margin-bottom: 0;
329}
330div.toclevel2 {
331 margin-left: 2em;
332 font-size: 0.9em;
333}
334div.toclevel3 {
335 margin-left: 4em;
336 font-size: 0.9em;
337}
338div.toclevel4 {
339 margin-left: 6em;
340 font-size: 0.9em;
341}
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]342/* Overrides for manpage documents */
343h1 {
344 padding-top: 0.5em;
345 padding-bottom: 0.5em;
346 border-top: 2px solid silver;
347 border-bottom: 2px solid silver;
348}
349h2 {
350 border-style: none;
351}
352div.sectionbody {
353 margin-left: 5%;
354}
355
356@media print {
357 div#toc { display: none; }
358}
359
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]360/* Workarounds for IE6's broken and incomplete CSS2. */
361
362div.sidebar-content {
363 background: #ffffee;
364 border: 1px solid silver;
365 padding: 0.5em;
366}
367div.sidebar-title, div.image-title {
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]368 color: #527bbd;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]369 font-family: sans-serif;
370 font-weight: bold;
371 margin-top: 0.0em;
372 margin-bottom: 0.5em;
373}
374
375div.listingblock div.content {
376 border: 1px solid silver;
377 background: #f4f4f4;
378 padding: 0.5em;
379}
380
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]381div.quoteblock-attribution {
382 padding-top: 0.5em;
383 text-align: right;
384}
385
386div.verseblock-content {
387 white-space: pre;
388}
389div.verseblock-attribution {
390 padding-top: 0.75em;
391 text-align: left;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]392}
393
394div.exampleblock-content {
395 border-left: 2px solid silver;
396 padding-left: 0.5em;
397}
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]398
399/* IE6 sets dynamically generated links as visited. */
400div#toc a:visited { color: blue; }
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]401</style>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]402</head>
403<body>
404<div id="header">
405<h1>
406gitmodules(5) Manual Page
407</h1>
408<h2>NAME</h2>
409<div class="sectionbody">
410<p>gitmodules -
411 defining submodule properties
412</p>
413</div>
414</div>
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]415<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]416<div class="sectionbody">
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]417<div class="paragraph"><p>$GIT_WORK_DIR/.gitmodules</p></div>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]418</div>
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]419<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]420<div class="sectionbody">
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]421<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]422working tree, is a text file with a syntax matching the requirements
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]423of <a href="git-config.html">git-config(1)</a>.</p></div>
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]424<div class="paragraph"><p>The file contains one subsection per submodule, and the subsection value
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]425is the name of the submodule. Each submodule section also contains the
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]426following required keys:</p></div>
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]427<div class="dlist"><dl>
428<dt class="hdlist1">
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]429submodule.&lt;name&gt;.path
430</dt>
431<dd>
432<p>
433 Defines the path, relative to the top-level directory of the git
434 working tree, where the submodule is expected to be checked out.
435 The path name must not end with a <tt>/</tt>. All submodule paths must
436 be unique within the .gitmodules file.
437</p>
438</dd>
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]439<dt class="hdlist1">
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]440submodule.&lt;name&gt;.url
441</dt>
442<dd>
443<p>
444 Defines an url from where the submodule repository can be cloned.
Junio C Hamano78e3a782010-07-15 22:24:45[diff] [blame]445 This may be either an absolute URL ready to be passed to
446 <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]447 relative to the superproject&#8217;s origin repository.
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]448</p>
449</dd>
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]450<dt class="hdlist1">
Junio C Hamano25e7ba62009-06-14 01:03:22[diff] [blame]451submodule.&lt;name&gt;.update
452</dt>
453<dd>
454<p>
455 Defines what to do when the submodule is updated by the superproject.
456 If <em>checkout</em> (the default), the new commit specified in the
457 superproject will be checked out in the submodule on a detached HEAD.
458 If <em>rebase</em>, the current branch of the submodule will be rebased onto
Junio C Hamano0e88f3e2009-06-21 08:03:25[diff] [blame]459 the commit specified in the superproject. If <em>merge</em>, the commit
460 specified in the superproject will be merged into the current branch
461 in the submodule.
Junio C Hamano25e7ba62009-06-14 01:03:22[diff] [blame]462 This config option is overridden if <em>git submodule update</em> is given
Junio C Hamano0e88f3e2009-06-21 08:03:25[diff] [blame]463 the <em>--merge</em> or <em>--rebase</em> options.
Junio C Hamano25e7ba62009-06-14 01:03:22[diff] [blame]464</p>
465</dd>
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]466<dt class="hdlist1">
467submodule.&lt;name&gt;.fetchRecurseSubmodules
468</dt>
469<dd>
470<p>
Junio C Hamano5cd15182011-04-05 00:21:10[diff] [blame^]471 This option can be used to control recursive fetching of this
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]472 submodule. If this option is also present in the submodules entry in
473 .git/config of the superproject, the setting there will override the
474 one found in .gitmodules.
Junio C Hamano7165bf72011-01-04 22:06:18[diff] [blame]475 Both settings can be overridden on the command line by using the
Junio C Hamano5cd15182011-04-05 00:21:10[diff] [blame^]476 "--[no-]recurse-submodules" option to "git fetch" and "git pull".
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]477</p>
478</dd>
479<dt class="hdlist1">
Junio C Hamano619596a2010-08-18 22:15:35[diff] [blame]480submodule.&lt;name&gt;.ignore
481</dt>
482<dd>
483<p>
484 Defines under what circumstances "git status" and the diff family show
485 a submodule as modified. When set to "all", it will never be considered
486 modified, "dirty" will ignore all changes to the submodules work tree and
487 takes only differences between the HEAD of the submodule and the commit
488 recorded in the superproject into account. "untracked" will additionally
489 let submodules with modified tracked files in their work tree show up.
490 Using "none" (the default when this option is not set) also shows
491 submodules that have untracked files in their work tree as changed.
492 If this option is also present in the submodules entry in .git/config of
493 the superproject, the setting there will override the one found in
494 .gitmodules.
Junio C Hamanode9745c2010-08-23 17:10:18[diff] [blame]495 Both settings can be overridden on the command line by using the
Junio C Hamano619596a2010-08-18 22:15:35[diff] [blame]496 "--ignore-submodule" option.
497</p>
498</dd>
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]499</dl></div>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]500</div>
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]501<h2 id="_examples">EXAMPLES</h2>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]502<div class="sectionbody">
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]503<div class="paragraph"><p>Consider the following .gitmodules file:</p></div>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]504<div class="literalblock">
505<div class="content">
506<pre><tt>[submodule "libfoo"]
507 path = include/foo
508 url = git://foo.com/git/lib.git</tt></pre>
509</div></div>
510<div class="literalblock">
511<div class="content">
512<pre><tt>[submodule "libbar"]
513 path = include/bar
514 url = git://bar.com/git/lib.git</tt></pre>
515</div></div>
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]516<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]517be checked out in the paths <em>include/foo</em> and <em>include/bar</em>, and for both
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]518submodules an url is specified which can be used for cloning the submodules.</p></div>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]519</div>
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]520<h2 id="_see_also">SEE ALSO</h2>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]521<div class="sectionbody">
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]522<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]523</div>
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]524<h2 id="_git">GIT</h2>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]525<div class="sectionbody">
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]526<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]527</div>
528<div id="footer">
529<div id="footer-text">
Junio C Hamano5cd15182011-04-05 00:21:10[diff] [blame^]530Last updated 2011-04-05 00:20:31 UTC
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]531</div>
532</div>
533</body>
534</html>