Google Git
Sign in
chromium / external / gitster / git-htmldocs / 5992a2548ff829b05d40f7c0f9aa6305cf199d87 / . / gitmodules.html
blob: f11853de186fe0e26557d94b76638d026c7a4007 [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>
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 Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]6<meta name="generator" content="AsciiDoc 8.6.9" />
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">
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 Hamano6926bef2007-06-16 09:54:05[diff] [blame]24}
25
26body {
27 margin: 1em 5% 1em 5%;
28}
29
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]30a {
31 color: blue;
32 text-decoration: underline;
33}
34a:visited {
35 color: fuchsia;
36}
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]37
38em {
39 font-style: italic;
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]40 color: navy;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]41}
42
43strong {
44 font-weight: bold;
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]45 color: #083194;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]46}
47
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]48h1, h2, h3, h4, h5, h6 {
49 color: #527bbd;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]50 margin-top: 1.2em;
51 margin-bottom: 0.5em;
52 line-height: 1.3;
53}
54
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]55h1, h2, h3 {
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]56 border-bottom: 2px solid silver;
57}
58h2 {
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]59 padding-top: 0.5em;
60}
Junio C Hamano17bd2272008-09-01 06:11:17[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 Hamano6926bef2007-06-16 09:54:05[diff] [blame]70
71div.sectionbody {
Junio C Hamano6926bef2007-06-16 09:54:05[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 Hamano0d75e872010-12-17 06:57:26[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 Hamano0d75e872010-12-17 06:57:26[diff] [blame]89
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]90.monospaced, code, pre {
91 font-family: "Courier New", Courier, monospace;
92 font-size: inherit;
93 color: navy;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]94 padding: 0;
95 margin: 0;
96}
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]97pre {
98 white-space: pre-wrap;
99}
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]100
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]101#author {
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]102 color: #527bbd;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]103 font-weight: bold;
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]104 font-size: 1.1em;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]105}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]106#email {
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]107}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]108#revnumber, #revdate, #revremark {
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]109}
110
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]111#footer {
Junio C Hamano6926bef2007-06-16 09:54:05[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 Hamano6926bef2007-06-16 09:54:05[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 Hamano6926bef2007-06-16 09:54:05[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 Hamano0d75e872010-12-17 06:57:26[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 Hamano6926bef2007-06-16 09:54:05[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 Hamano6926bef2007-06-16 09:54:05[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 Hamano6926bef2007-06-16 09:54:05[diff] [blame]141}
142
143div.content { /* Block element content. */
144 padding: 0;
145}
146
147/* Block element titles. */
148div.title, caption.title {
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]149 color: #527bbd;
Junio C Hamano6926bef2007-06-16 09:54:05[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 Hamano6926bef2007-06-16 09:54:05[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 Hamano6926bef2007-06-16 09:54:05[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 Hamano0d75e872010-12-17 06:57:26[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 Hamano6926bef2007-06-16 09:54:05[diff] [blame]189}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]190
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]191div.quoteblock > div.attribution {
192 padding-top: 0.5em;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]193 text-align: right;
194}
Junio C Hamano0d75e872010-12-17 06:57:26[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 Hamano0d75e872010-12-17 06:57:26[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 Hamano17bd2272008-09-01 06:11:17[diff] [blame]205div.verseblock + div.attribution {
206 text-align: left;
207}
Junio C Hamano6926bef2007-06-16 09:54:05[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 Hamano6926bef2007-06-16 09:54:05[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 Hamano6926bef2007-06-16 09:54:05[diff] [blame]225}
226
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]227div.imageblock div.content { padding-left: 0; }
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]228span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]229a.image:visited { color: white; }
Junio C Hamano6926bef2007-06-16 09:54:05[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 Hamano0d75e872010-12-17 06:57:26[diff] [blame]238 font-style: normal;
239 color: navy;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]240}
241dd > *:first-child {
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]242 margin-top: 0.1em;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]243}
244
245ul, ol {
246 list-style-position: outside;
247}
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]248ol.arabic {
249 list-style-type: decimal;
250}
251ol.loweralpha {
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]252 list-style-type: lower-alpha;
253}
Junio C Hamano0d75e872010-12-17 06:57:26[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 Hamano6926bef2007-06-16 09:54:05[diff] [blame]270
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]271tfoot {
272 font-weight: bold;
273}
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]274td > div.verse {
275 white-space: pre;
276}
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]277
278div.hdlist {
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]279 margin-top: 0.8em;
280 margin-bottom: 0.8em;
281}
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]282div.hdlist tr {
283 padding-bottom: 15px;
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]284}
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]285dt.hdlist1.strong, td.hdlist1.strong {
286 font-weight: bold;
287}
288td.hdlist1 {
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]289 vertical-align: top;
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]290 font-style: normal;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]291 padding-right: 0.8em;
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]292 color: navy;
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]293}
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]294td.hdlist2 {
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]295 vertical-align: top;
296}
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]297div.hdlist.compact tr {
298 margin: 0;
299 padding-bottom: 0;
300}
301
302.comment {
303 background: yellow;
304}
Junio C Hamano6926bef2007-06-16 09:54:05[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 Hamano6926bef2007-06-16 09:54:05[diff] [blame]340}
Junio C Hamano17bd2272008-09-01 06:11:17[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 Hamano17bd2272008-09-01 06:11:17[diff] [blame]351 color: #527bbd;
Junio C Hamano17bd2272008-09-01 06:11:17[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 Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]358div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamano17bd2272008-09-01 06:11:17[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 Hamanoc14e6ad2014-10-31 20:25:53[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 Hamano0d75e872010-12-17 06:57:26[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 Hamano0d75e872010-12-17 06:57:26[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 Hamano0d75e872010-12-17 06:57:26[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 Hamano0d75e872010-12-17 06:57:26[diff] [blame]535}
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]536
537
Junio C Hamano6926bef2007-06-16 09:54:05[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 Hamanoc14e6ad2014-10-31 20:25:53[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 Hamanoc14e6ad2014-10-31 20:25:53[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 Hamanoc14e6ad2014-10-31 20:25:53[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 Hamano6926bef2007-06-16 09:54:05[diff] [blame]733</head>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]734<body class="manpage">
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]735<div id="header">
736<h1>
737gitmodules(5) Manual Page
738</h1>
739<h2>NAME</h2>
740<div class="sectionbody">
741<p>gitmodules -
742 defining submodule properties
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 Hamano0d75e872010-12-17 06:57:26[diff] [blame]748<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]749<div class="sectionbody">
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]750<div class="paragraph"><p>$GIT_WORK_DIR/.gitmodules</p></div>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]751</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]752</div>
753<div class="sect1">
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]754<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]755<div class="sectionbody">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]756<div class="paragraph"><p>The <code>.gitmodules</code> file, located in the top-level directory of a Git
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]757working tree, is a text file with a syntax matching the requirements
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]758of <a href="git-config.html">git-config(1)</a>.</p></div>
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]759<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]760is the name of the submodule. The name is set to the path where the
761submodule has been added unless it was customized with the <em>--name</em>
762option of <em>git submodule add</em>. Each submodule section also contains the
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]763following required keys:</p></div>
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]764<div class="dlist"><dl>
765<dt class="hdlist1">
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]766submodule.&lt;name&gt;.path
767</dt>
768<dd>
769<p>
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]770 Defines the path, relative to the top-level directory of the Git
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]771 working tree, where the submodule is expected to be checked out.
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]772 The path name must not end with a <code>/</code>. All submodule paths must
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]773 be unique within the .gitmodules file.
774</p>
775</dd>
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]776<dt class="hdlist1">
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]777submodule.&lt;name&gt;.url
778</dt>
779<dd>
780<p>
Junio C Hamano0ff98162012-03-31 18:19:09[diff] [blame]781 Defines a URL from which the submodule repository can be cloned.
Junio C Hamano78e3a782010-07-15 22:24:45[diff] [blame]782 This may be either an absolute URL ready to be passed to
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]783 <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]784 relative to the superproject&#8217;s origin repository.
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]785</p>
786</dd>
Junio C Hamano9906f1f2014-01-06 22:24:17[diff] [blame]787</dl></div>
788<div class="paragraph"><p>In addition, there are a number of optional keys:</p></div>
789<div class="dlist"><dl>
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]790<dt class="hdlist1">
Junio C Hamano25e7ba62009-06-14 01:03:22[diff] [blame]791submodule.&lt;name&gt;.update
792</dt>
793<dd>
794<p>
Junio C Hamano6bf68cf2015-03-06 23:46:29[diff] [blame]795 Defines the default update procedure for the named submodule,
796 i.e. how the submodule is updated by "git submodule update"
797 command in the superproject. This is only used by <code>git
798 submodule init</code> to initialize the configuration variable of
799 the same name. Allowed values here are <em>checkout</em>, <em>rebase</em>,
800 <em>merge</em> or <em>none</em>. See description of <em>update</em> command in
801 <a href="git-submodule.html">git-submodule(1)</a> for their meaning. Note that the
802 <em>!command</em> form is intentionally ignored here for security
803 reasons.
Junio C Hamano25e7ba62009-06-14 01:03:22[diff] [blame]804</p>
805</dd>
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]806<dt class="hdlist1">
Junio C Hamanoabad6da2013-01-06 09:06:32[diff] [blame]807submodule.&lt;name&gt;.branch
808</dt>
809<dd>
810<p>
811 A remote branch name for tracking updates in the upstream submodule.
812 If the option is not specified, it defaults to <em>master</em>. See the
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]813 <code>--remote</code> documentation in <a href="git-submodule.html">git-submodule(1)</a> for details.
Junio C Hamanoabad6da2013-01-06 09:06:32[diff] [blame]814</p>
815</dd>
816<dt class="hdlist1">
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]817submodule.&lt;name&gt;.fetchRecurseSubmodules
818</dt>
819<dd>
820<p>
Junio C Hamano5cd15182011-04-05 00:21:10[diff] [blame]821 This option can be used to control recursive fetching of this
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]822 submodule. If this option is also present in the submodules entry in
823 .git/config of the superproject, the setting there will override the
824 one found in .gitmodules.
Junio C Hamano7165bf72011-01-04 22:06:18[diff] [blame]825 Both settings can be overridden on the command line by using the
Junio C Hamano5cd15182011-04-05 00:21:10[diff] [blame]826 "--[no-]recurse-submodules" option to "git fetch" and "git pull".
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]827</p>
828</dd>
829<dt class="hdlist1">
Junio C Hamano619596a2010-08-18 22:15:35[diff] [blame]830submodule.&lt;name&gt;.ignore
831</dt>
832<dd>
833<p>
834 Defines under what circumstances "git status" and the diff family show
835 a submodule as modified. When set to "all", it will never be considered
Junio C Hamanoc8c398a2014-06-16 21:14:05[diff] [blame]836 modified (but will nonetheless show up in the output of status and
837 commit when it has been staged), "dirty" will ignore all changes
838 to the submodules work tree and
Junio C Hamano619596a2010-08-18 22:15:35[diff] [blame]839 takes only differences between the HEAD of the submodule and the commit
840 recorded in the superproject into account. "untracked" will additionally
841 let submodules with modified tracked files in their work tree show up.
842 Using "none" (the default when this option is not set) also shows
843 submodules that have untracked files in their work tree as changed.
844 If this option is also present in the submodules entry in .git/config of
845 the superproject, the setting there will override the one found in
846 .gitmodules.
Junio C Hamanode9745c2010-08-23 17:10:18[diff] [blame]847 Both settings can be overridden on the command line by using the
Junio C Hamano369e3402013-10-15 18:40:25[diff] [blame]848 "--ignore-submodule" option. The <em>git submodule</em> commands are not
849 affected by this setting.
Junio C Hamano619596a2010-08-18 22:15:35[diff] [blame]850</p>
851</dd>
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]852</dl></div>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]853</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]854</div>
855<div class="sect1">
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]856<h2 id="_examples">EXAMPLES</h2>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]857<div class="sectionbody">
Junio C Hamano0d75e872010-12-17 06:57:26[diff] [blame]858<div class="paragraph"><p>Consider the following .gitmodules file:</p></div>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]859<div class="literalblock">
860<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]861<pre><code>[submodule "libfoo"]
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]862 path = include/foo
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]863 url = git://foo.com/git/lib.git</code></pre>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]864</div></div>
865<div class="literalblock">
866<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]867<pre><code>[submodule "libbar"]
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]868 path = include/bar
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]869 url = git://bar.com/git/lib.git</code></pre>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]870</div></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]871<div class="paragraph"><p>This defines two submodules, <code>libfoo</code> and <code>libbar</code>. These are expected to
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]872be 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]873submodules a URL is specified which can be used for cloning the submodules.</p></div>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]874</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]875</div>
876<div class="sect1">
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]877<h2 id="_see_also">SEE ALSO</h2>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]878<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]879<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]880</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]881</div>
882<div class="sect1">
Junio C Hamano17bd2272008-09-01 06:11:17[diff] [blame]883<h2 id="_git">GIT</h2>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]884<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]885<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]886</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]887</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]888</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]889<div id="footnotes"><hr /></div>
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]890<div id="footer">
891<div id="footer-text">
Junio C Hamano6bf68cf2015-03-06 23:46:29[diff] [blame]892Last updated 2015-03-06 15:45:51 PST
Junio C Hamano6926bef2007-06-16 09:54:05[diff] [blame]893</div>
894</div>
895</body>
896</html>