Google Git
Sign in
chromium / external / gitster / git-htmldocs / cf7310088e7328f8aa7ea2c5de767ef9499b5d78 / . / gitsubmodules.html
blob: d1d10cb2462de9a08def2a898e77a85e05eaa245 [file] [log] [blame]
Junio C Hamano944ce252018-05-30 22:25:26[diff] [blame]1<?xml version="1.0" encoding="UTF-8"?>
Junio C Hamano387ce232017-07-12 23:01:13[diff] [blame]2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
5<head>
6<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamano944ce252018-05-30 22:25:26[diff] [blame]7<meta name="generator" content="AsciiDoc 8.6.10" />
Junio C Hamano387ce232017-07-12 23:01:13[diff] [blame]8<title>gitsubmodules(7)</title>
9<style type="text/css">
10/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
11
12/* Default font. */
13body {
14 font-family: Georgia,serif;
15}
16
17/* Title font. */
18h1, h2, h3, h4, h5, h6,
19div.title, caption.title,
20thead, p.table.header,
21#toctitle,
22#author, #revnumber, #revdate, #revremark,
23#footer {
24 font-family: Arial,Helvetica,sans-serif;
25}
26
27body {
28 margin: 1em 5% 1em 5%;
29}
30
31a {
32 color: blue;
33 text-decoration: underline;
34}
35a:visited {
36 color: fuchsia;
37}
38
39em {
40 font-style: italic;
41 color: navy;
42}
43
44strong {
45 font-weight: bold;
46 color: #083194;
47}
48
49h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
51 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
54}
55
56h1, h2, h3 {
57 border-bottom: 2px solid silver;
58}
59h2 {
60 padding-top: 0.5em;
61}
62h3 {
63 float: left;
64}
65h3 + * {
66 clear: left;
67}
68h5 {
69 font-size: 1.0em;
70}
71
72div.sectionbody {
73 margin-left: 0;
74}
75
76hr {
77 border: 1px solid silver;
78}
79
80p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
83}
84
85ul, ol, li > p {
86 margin-top: 0;
87}
88ul > li { color: #aaa; }
89ul > li > * { color: black; }
90
91.monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
95 padding: 0;
96 margin: 0;
97}
98pre {
99 white-space: pre-wrap;
100}
101
102#author {
103 color: #527bbd;
104 font-weight: bold;
105 font-size: 1.1em;
106}
107#email {
108}
109#revnumber, #revdate, #revremark {
110}
111
112#footer {
113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
117}
118#footer-text {
119 float: left;
120 padding-bottom: 0.5em;
121}
122#footer-badges {
123 float: right;
124 padding-bottom: 0.5em;
125}
126
127#preamble {
128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
130}
131div.imageblock, div.exampleblock, div.verseblock,
132div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133div.admonitionblock {
134 margin-top: 1.0em;
135 margin-bottom: 1.5em;
136}
137div.admonitionblock {
138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
142}
143
144div.content { /* Block element content. */
145 padding: 0;
146}
147
148/* Block element titles. */
149div.title, caption.title {
150 color: #527bbd;
151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
155}
156div.title + * {
157 margin-top: 0;
158}
159
160td div.title:first-child {
161 margin-top: 0.0em;
162}
163div.content div.title:first-child {
164 margin-top: 0.0em;
165}
166div.content + div.title {
167 margin-top: 0.0em;
168}
169
170div.sidebarblock > div.content {
171 background: #ffffee;
172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
174 padding: 0.5em;
175}
176
177div.listingblock > div.content {
178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
181 padding: 0.5em;
182}
183
184div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
187 margin-right: 10%;
188 border-left: 5px solid #f0f0f0;
189 color: #888;
190}
191
192div.quoteblock > div.attribution {
193 padding-top: 0.5em;
194 text-align: right;
195}
196
197div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
200}
201div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
204}
205/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
206div.verseblock + div.attribution {
207 text-align: left;
208}
209
210div.admonitionblock .icon {
211 vertical-align: top;
212 font-size: 1.1em;
213 font-weight: bold;
214 text-decoration: underline;
215 color: #527bbd;
216 padding-right: 0.5em;
217}
218div.admonitionblock td.content {
219 padding-left: 0.5em;
220 border-left: 3px solid #dddddd;
221}
222
223div.exampleblock > div.content {
224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
226}
227
228div.imageblock div.content { padding-left: 0; }
229span.image img { border-style: none; vertical-align: text-bottom; }
230a.image:visited { color: white; }
231
232dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
235}
236dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
239 font-style: normal;
240 color: navy;
241}
242dd > *:first-child {
243 margin-top: 0.1em;
244}
245
246ul, ol {
247 list-style-position: outside;
248}
249ol.arabic {
250 list-style-type: decimal;
251}
252ol.loweralpha {
253 list-style-type: lower-alpha;
254}
255ol.upperalpha {
256 list-style-type: upper-alpha;
257}
258ol.lowerroman {
259 list-style-type: lower-roman;
260}
261ol.upperroman {
262 list-style-type: upper-roman;
263}
264
265div.compact ul, div.compact ol,
266div.compact p, div.compact p,
267div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
270}
271
272tfoot {
273 font-weight: bold;
274}
275td > div.verse {
276 white-space: pre;
277}
278
279div.hdlist {
280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
282}
283div.hdlist tr {
284 padding-bottom: 15px;
285}
286dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
288}
289td.hdlist1 {
290 vertical-align: top;
291 font-style: normal;
292 padding-right: 0.8em;
293 color: navy;
294}
295td.hdlist2 {
296 vertical-align: top;
297}
298div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
301}
302
303.comment {
304 background: yellow;
305}
306
307.footnote, .footnoteref {
308 font-size: 0.8em;
309}
310
311span.footnote, span.footnoteref {
312 vertical-align: super;
313}
314
315#footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
318}
319
320#footnotes div.footnote {
321 margin: 0 0 5px 0;
322}
323
324#footnotes hr {
325 border: none;
326 border-top: 1px solid silver;
327 height: 1px;
328 text-align: left;
329 margin-left: 0;
330 width: 20%;
331 min-width: 100px;
332}
333
334div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
338}
339div.colist td img {
340 margin-top: 0.3em;
341}
342
343@media print {
344 #footer-badges { display: none; }
345}
346
347#toc {
348 margin-bottom: 2.5em;
349}
350
351#toctitle {
352 color: #527bbd;
353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
357}
358
359div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
360 margin-top: 0;
361 margin-bottom: 0;
362}
363div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
366}
367div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
370}
371div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
374}
375
376span.aqua { color: aqua; }
377span.black { color: black; }
378span.blue { color: blue; }
379span.fuchsia { color: fuchsia; }
380span.gray { color: gray; }
381span.green { color: green; }
382span.lime { color: lime; }
383span.maroon { color: maroon; }
384span.navy { color: navy; }
385span.olive { color: olive; }
386span.purple { color: purple; }
387span.red { color: red; }
388span.silver { color: silver; }
389span.teal { color: teal; }
390span.white { color: white; }
391span.yellow { color: yellow; }
392
393span.aqua-background { background: aqua; }
394span.black-background { background: black; }
395span.blue-background { background: blue; }
396span.fuchsia-background { background: fuchsia; }
397span.gray-background { background: gray; }
398span.green-background { background: green; }
399span.lime-background { background: lime; }
400span.maroon-background { background: maroon; }
401span.navy-background { background: navy; }
402span.olive-background { background: olive; }
403span.purple-background { background: purple; }
404span.red-background { background: red; }
405span.silver-background { background: silver; }
406span.teal-background { background: teal; }
407span.white-background { background: white; }
408span.yellow-background { background: yellow; }
409
410span.big { font-size: 2em; }
411span.small { font-size: 0.6em; }
412
413span.underline { text-decoration: underline; }
414span.overline { text-decoration: overline; }
415span.line-through { text-decoration: line-through; }
416
417div.unbreakable { page-break-inside: avoid; }
418
419
420/*
421 * xhtml11 specific
422 *
423 * */
424
425div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
428}
429div.tableblock > table {
430 border: 3px solid #527bbd;
431}
432thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
435}
436p.table {
437 margin-top: 0;
438}
439/* Because the table frame attribute is overriden by CSS in most browsers. */
440div.tableblock > table[frame="void"] {
441 border-style: none;
442}
443div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
446}
447div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
450}
451
452
453/*
454 * html5 specific
455 *
456 * */
457
458table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
461}
462thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
465}
466p.tableblock {
467 margin-top: 0;
468}
469table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
475}
476th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
481}
482
483table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
486}
487table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
490}
491table.tableblock.frame-none {
492 border-style: hidden;
493}
494
495th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
497}
498th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
500}
501th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
503}
504
505th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
507}
508th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
510}
511th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
513}
514
515
516/*
517 * manpage specific
518 *
519 * */
520
521body.manpage h1 {
522 padding-top: 0.5em;
523 padding-bottom: 0.5em;
524 border-top: 2px solid silver;
525 border-bottom: 2px solid silver;
526}
527body.manpage h2 {
528 border-style: none;
529}
530body.manpage div.sectionbody {
531 margin-left: 3em;
532}
533
534@media print {
535 body.manpage div#toc { display: none; }
536}
537
538
539</style>
540<script type="text/javascript">
541/*<![CDATA[*/
542var asciidoc = { // Namespace.
543
544/////////////////////////////////////////////////////////////////////
545// Table Of Contents generator
546/////////////////////////////////////////////////////////////////////
547
548/* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
550 *
551 * Table Of Content generator
552 * Version: 0.4
553 *
554 * Feel free to use this script under the terms of the GNU General Public
555 * License, as long as you do not remove or alter this notice.
556 */
557
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
560
561// toclevels = 1..4.
562toc: function (toclevels) {
563
564 function getText(el) {
565 var text = "";
566 for (var i = el.firstChild; i != null; i = i.nextSibling) {
567 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
568 text += i.data;
569 else if (i.firstChild != null)
570 text += getText(i);
571 }
572 return text;
573 }
574
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
579 }
580
581 function tocEntries(el, toclevels) {
582 var result = new Array;
583 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
584 // Function that scans the DOM tree for header elements (the DOM2
585 // nodeIterator API would be a better technique but not supported by all
586 // browsers).
587 var iterate = function (el) {
588 for (var i = el.firstChild; i != null; i = i.nextSibling) {
589 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
590 var mo = re.exec(i.tagName);
591 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
592 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
593 }
594 iterate(i);
595 }
596 }
597 }
598 iterate(el);
599 return result;
600 }
601
602 var toc = document.getElementById("toc");
603 if (!toc) {
604 return;
605 }
606
607 // Delete existing TOC entries in case we're reloading the TOC.
608 var tocEntriesToRemove = [];
609 var i;
610 for (i = 0; i < toc.childNodes.length; i++) {
611 var entry = toc.childNodes[i];
612 if (entry.nodeName.toLowerCase() == 'div'
613 && entry.getAttribute("class")
614 && entry.getAttribute("class").match(/^toclevel/))
615 tocEntriesToRemove.push(entry);
616 }
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
619 }
620
621 // Rebuild TOC entries.
622 var entries = tocEntries(document.getElementById("content"), toclevels);
623 for (var i = 0; i < entries.length; ++i) {
624 var entry = entries[i];
625 if (entry.element.id == "")
626 entry.element.id = "_toc_" + i;
627 var a = document.createElement("a");
628 a.href = "#" + entry.element.id;
629 a.appendChild(document.createTextNode(entry.text));
630 var div = document.createElement("div");
631 div.appendChild(a);
632 div.className = "toclevel" + entry.toclevel;
633 toc.appendChild(div);
634 }
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
637},
638
639
640/////////////////////////////////////////////////////////////////////
641// Footnotes generator
642/////////////////////////////////////////////////////////////////////
643
644/* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
646 */
647
648footnotes: function () {
649 // Delete existing footnote entries in case we're reloading the footnodes.
650 var i;
651 var noteholder = document.getElementById("footnotes");
652 if (!noteholder) {
653 return;
654 }
655 var entriesToRemove = [];
656 for (i = 0; i < noteholder.childNodes.length; i++) {
657 var entry = noteholder.childNodes[i];
658 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
659 entriesToRemove.push(entry);
660 }
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
663 }
664
665 // Rebuild footnote entries.
666 var cont = document.getElementById("content");
667 var spans = cont.getElementsByTagName("span");
668 var refs = {};
669 var n = 0;
670 for (i=0; i<spans.length; i++) {
671 if (spans[i].className == "footnote") {
672 n++;
673 var note = spans[i].getAttribute("data-note");
674 if (!note) {
675 // Use [\s\S] in place of . so multi-line matches work.
676 // Because JavaScript has no s (dotall) regex flag.
677 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
678 spans[i].innerHTML =
679 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
680 "' title='View footnote' class='footnote'>" + n + "</a>]";
681 spans[i].setAttribute("data-note", note);
682 }
683 noteholder.innerHTML +=
684 "<div class='footnote' id='_footnote_" + n + "'>" +
685 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
686 n + "</a>. " + note + "</div>";
687 var id =spans[i].getAttribute("id");
688 if (id != null) refs["#"+id] = n;
689 }
690 }
691 if (n == 0)
692 noteholder.parentNode.removeChild(noteholder);
693 else {
694 // Process footnoterefs.
695 for (i=0; i<spans.length; i++) {
696 if (spans[i].className == "footnoteref") {
697 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
698 href = href.match(/#.*/)[0]; // Because IE return full URL.
699 n = refs[href];
700 spans[i].innerHTML =
701 "[<a href='#_footnote_" + n +
702 "' title='View footnote' class='footnote'>" + n + "</a>]";
703 }
704 }
705 }
706},
707
708install: function(toclevels) {
709 var timerId;
710
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
715 }
716 }
717
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
721 }
722
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
728}
729
730}
731asciidoc.install();
732/*]]>*/
733</script>
734</head>
735<body class="manpage">
736<div id="header">
737<h1>
738gitsubmodules(7) Manual Page
739</h1>
740<h2>NAME</h2>
741<div class="sectionbody">
742<p>gitsubmodules -
743 mounting one repository inside another
744</p>
745</div>
746</div>
747<div id="content">
748<div class="sect1">
749<h2 id="_synopsis">SYNOPSIS</h2>
750<div class="sectionbody">
751<div class="literalblock">
752<div class="content">
753<pre><code>.gitmodules, $GIT_DIR/config</code></pre>
754</div></div>
755<div class="listingblock">
756<div class="content">
757<pre><code>git submodule
758git &lt;command&gt; --recurse-submodules</code></pre>
759</div></div>
760</div>
761</div>
762<div class="sect1">
763<h2 id="_description">DESCRIPTION</h2>
764<div class="sectionbody">
765<div class="paragraph"><p>A submodule is a repository embedded inside another repository.
766The submodule has its own history; the repository it is embedded
767in is called a superproject.</p></div>
768<div class="paragraph"><p>On the filesystem, a submodule usually (but not always - see FORMS below)
769consists of (i) a Git directory located under the <code>$GIT_DIR/modules/</code>
770directory of its superproject, (ii) a working directory inside the
771superproject&#8217;s working directory, and a <code>.git</code> file at the root of
Junio C Hamano664750f2018-03-06 23:25:44[diff] [blame]772the submodule&#8217;s working directory pointing to (i).</p></div>
Junio C Hamano387ce232017-07-12 23:01:13[diff] [blame]773<div class="paragraph"><p>Assuming the submodule has a Git directory at <code>$GIT_DIR/modules/foo/</code>
774and a working directory at <code>path/to/bar/</code>, the superproject tracks the
775submodule via a <code>gitlink</code> entry in the tree at <code>path/to/bar</code> and an entry
776in its <code>.gitmodules</code> file (see <a href="gitmodules.html">gitmodules(5)</a>) of the form
777<code>submodule.foo.path = path/to/bar</code>.</p></div>
778<div class="paragraph"><p>The <code>gitlink</code> entry contains the object name of the commit that the
Junio C Hamano664750f2018-03-06 23:25:44[diff] [blame]779superproject expects the submodule&#8217;s working directory to be at.</p></div>
Junio C Hamano387ce232017-07-12 23:01:13[diff] [blame]780<div class="paragraph"><p>The section <code>submodule.foo.*</code> in the <code>.gitmodules</code> file gives additional
Junio C Hamano640779d2018-02-14 01:29:14[diff] [blame]781hints to Git&#8217;s porcelain layer. For example, the <code>submodule.foo.url</code>
782setting specifies where to obtain the submodule.</p></div>
Junio C Hamano387ce232017-07-12 23:01:13[diff] [blame]783<div class="paragraph"><p>Submodules can be used for at least two different use cases:</p></div>
784<div class="olist arabic"><ol class="arabic">
785<li>
786<p>
787Using another project while maintaining independent history.
788 Submodules allow you to contain the working tree of another project
789 within your own working tree while keeping the history of both
790 projects separate. Also, since submodules are fixed to an arbitrary
791 version, the other project can be independently developed without
792 affecting the superproject, allowing the superproject project to
793 fix itself to new versions only when desired.
794</p>
795</li>
796<li>
797<p>
798Splitting a (logically single) project into multiple
799 repositories and tying them back together. This can be used to
Junio C Hamano640779d2018-02-14 01:29:14[diff] [blame]800 overcome current limitations of Git&#8217;s implementation to have
Junio C Hamano387ce232017-07-12 23:01:13[diff] [blame]801 finer grained access:
802</p>
803<div class="ulist"><ul>
804<li>
805<p>
Junio C Hamano640779d2018-02-14 01:29:14[diff] [blame]806Size of the Git repository:
Junio C Hamano387ce232017-07-12 23:01:13[diff] [blame]807 In its current form Git scales up poorly for large repositories containing
808 content that is not compressed by delta computation between trees.
Junio C Hamano640779d2018-02-14 01:29:14[diff] [blame]809 For example, you can use submodules to hold large binary assets
810 and these repositories can be shallowly cloned such that you do not
Junio C Hamano387ce232017-07-12 23:01:13[diff] [blame]811 have a large history locally.
812</p>
813</li>
814<li>
815<p>
816Transfer size:
817 In its current form Git requires the whole working tree present. It
818 does not allow partial trees to be transferred in fetch or clone.
Junio C Hamano640779d2018-02-14 01:29:14[diff] [blame]819 If the project you work on consists of multiple repositories tied
820 together as submodules in a superproject, you can avoid fetching the
821 working trees of the repositories you are not interested in.
Junio C Hamano387ce232017-07-12 23:01:13[diff] [blame]822</p>
823</li>
824<li>
825<p>
826Access control:
827 By restricting user access to submodules, this can be used to implement
828 read/write policies for different users.
829</p>
830</li>
831</ul></div>
832</li>
833</ol></div>
834</div>
835</div>
836<div class="sect1">
837<h2 id="_the_configuration_of_submodules">The configuration of submodules</h2>
838<div class="sectionbody">
839<div class="paragraph"><p>Submodule operations can be configured using the following mechanisms
840(from highest to lowest precedence):</p></div>
841<div class="ulist"><ul>
842<li>
843<p>
Junio C Hamano640779d2018-02-14 01:29:14[diff] [blame]844The command line for those commands that support taking submodules
845 as part of their pathspecs. Most commands have a boolean flag
846 <code>--recurse-submodules</code> which specify whether to recurse into submodules.
847 Examples are <code>grep</code> and <code>checkout</code>.
Junio C Hamano387ce232017-07-12 23:01:13[diff] [blame]848 Some commands take enums, such as <code>fetch</code> and <code>push</code>, where you can
849 specify how submodules are affected.
850</p>
851</li>
852<li>
853<p>
854The configuration inside the submodule. This includes <code>$GIT_DIR/config</code>
855 in the submodule, but also settings in the tree such as a <code>.gitattributes</code>
856 or <code>.gitignore</code> files that specify behavior of commands inside the
857 submodule.
858</p>
859<div class="paragraph"><p>For example an effect from the submodule&#8217;s <code>.gitignore</code> file
860would be observed when you run <code>git status --ignore-submodules=none</code> in
861the superproject. This collects information from the submodule&#8217;s working
Junio C Hamano640779d2018-02-14 01:29:14[diff] [blame]862directory by running <code>status</code> in the submodule while paying attention
863to the <code>.gitignore</code> file of the submodule.</p></div>
Junio C Hamano387ce232017-07-12 23:01:13[diff] [blame]864<div class="paragraph"><p>The submodule&#8217;s <code>$GIT_DIR/config</code> file would come into play when running
865<code>git push --recurse-submodules=check</code> in the superproject, as this would
866check if the submodule has any changes not published to any remote. The
867remotes are configured in the submodule as usual in the <code>$GIT_DIR/config</code>
868file.</p></div>
869</li>
870<li>
871<p>
872The configuration file <code>$GIT_DIR/config</code> in the superproject.
Junio C Hamano640779d2018-02-14 01:29:14[diff] [blame]873 Git only recurses into active submodules (see "ACTIVE SUBMODULES"
874 section below).
Junio C Hamano387ce232017-07-12 23:01:13[diff] [blame]875</p>
876<div class="paragraph"><p>If the submodule is not yet initialized, then the configuration
Junio C Hamano640779d2018-02-14 01:29:14[diff] [blame]877inside the submodule does not exist yet, so where to
Junio C Hamano387ce232017-07-12 23:01:13[diff] [blame]878obtain the submodule from is configured here for example.</p></div>
879</li>
880<li>
881<p>
Junio C Hamano640779d2018-02-14 01:29:14[diff] [blame]882The <code>.gitmodules</code> file inside the superproject. A project usually
Junio C Hamano387ce232017-07-12 23:01:13[diff] [blame]883 uses this file to suggest defaults for the upstream collection
Junio C Hamano640779d2018-02-14 01:29:14[diff] [blame]884 of repositories for the mapping that is required between a
885 submodule&#8217;s name and its path.
Junio C Hamano387ce232017-07-12 23:01:13[diff] [blame]886</p>
Junio C Hamano640779d2018-02-14 01:29:14[diff] [blame]887<div class="paragraph"><p>This file mainly serves as the mapping between the name and path of submodules
888in the superproject, such that the submodule&#8217;s Git directory can be
Junio C Hamano387ce232017-07-12 23:01:13[diff] [blame]889located.</p></div>
890<div class="paragraph"><p>If the submodule has never been initialized, this is the only place
891where submodule configuration is found. It serves as the last fallback
892to specify where to obtain the submodule from.</p></div>
893</li>
894</ul></div>
895</div>
896</div>
897<div class="sect1">
898<h2 id="_forms">FORMS</h2>
899<div class="sectionbody">
900<div class="paragraph"><p>Submodules can take the following forms:</p></div>
901<div class="ulist"><ul>
902<li>
903<p>
904The basic form described in DESCRIPTION with a Git directory,
905a working directory, a <code>gitlink</code>, and a <code>.gitmodules</code> entry.
906</p>
907</li>
908<li>
909<p>
910"Old-form" submodule: A working directory with an embedded
911<code>.git</code> directory, and the tracking <code>gitlink</code> and <code>.gitmodules</code> entry in
912the superproject. This is typically found in repositories generated
913using older versions of Git.
914</p>
915<div class="paragraph"><p>It is possible to construct these old form repositories manually.</p></div>
Junio C Hamano664750f2018-03-06 23:25:44[diff] [blame]916<div class="paragraph"><p>When deinitialized or deleted (see below), the submodule&#8217;s Git
Junio C Hamano387ce232017-07-12 23:01:13[diff] [blame]917directory is automatically moved to <code>$GIT_DIR/modules/&lt;name&gt;/</code>
918of the superproject.</p></div>
919</li>
920<li>
921<p>
922Deinitialized submodule: A <code>gitlink</code>, and a <code>.gitmodules</code> entry,
Junio C Hamano664750f2018-03-06 23:25:44[diff] [blame]923but no submodule working directory. The submodule&#8217;s Git directory
Junio C Hamano640779d2018-02-14 01:29:14[diff] [blame]924may be there as after deinitializing the Git directory is kept around.
Junio C Hamano387ce232017-07-12 23:01:13[diff] [blame]925The directory which is supposed to be the working directory is empty instead.
926</p>
927<div class="paragraph"><p>A submodule can be deinitialized by running <code>git submodule deinit</code>.
928Besides emptying the working directory, this command only modifies
Junio C Hamano664750f2018-03-06 23:25:44[diff] [blame]929the superproject&#8217;s <code>$GIT_DIR/config</code> file, so the superproject&#8217;s history
Junio C Hamano387ce232017-07-12 23:01:13[diff] [blame]930is not affected. This can be undone using <code>git submodule init</code>.</p></div>
931</li>
932<li>
933<p>
934Deleted submodule: A submodule can be deleted by running
935<code>git rm &lt;submodule path&gt; &amp;&amp; git commit</code>. This can be undone
936using <code>git revert</code>.
937</p>
Junio C Hamano664750f2018-03-06 23:25:44[diff] [blame]938<div class="paragraph"><p>The deletion removes the superproject&#8217;s tracking data, which are
Junio C Hamano387ce232017-07-12 23:01:13[diff] [blame]939both the <code>gitlink</code> entry and the section in the <code>.gitmodules</code> file.
Junio C Hamano664750f2018-03-06 23:25:44[diff] [blame]940The submodule&#8217;s working directory is removed from the file
Junio C Hamano387ce232017-07-12 23:01:13[diff] [blame]941system, but the Git directory is kept around as it to make it
942possible to checkout past commits without requiring fetching
943from another repository.</p></div>
944<div class="paragraph"><p>To completely remove a submodule, manually delete
945<code>$GIT_DIR/modules/&lt;name&gt;/</code>.</p></div>
946</li>
947</ul></div>
948</div>
949</div>
950<div class="sect1">
Junio C Hamano640779d2018-02-14 01:29:14[diff] [blame]951<h2 id="_active_submodules">ACTIVE SUBMODULES</h2>
952<div class="sectionbody">
953<div class="paragraph"><p>A submodule is considered active,</p></div>
Junio C Hamano94d00a52018-10-30 07:34:40[diff] [blame]954<div class="olist loweralpha"><ol class="loweralpha">
955<li>
956<p>
957if <code>submodule.&lt;name&gt;.active</code> is set to <code>true</code>
958</p>
959<div class="paragraph"><p>or</p></div>
960</li>
961<li>
962<p>
963if the submodule&#8217;s path matches the pathspec in <code>submodule.active</code>
964</p>
965<div class="paragraph"><p>or</p></div>
966</li>
967<li>
968<p>
969if <code>submodule.&lt;name&gt;.url</code> is set.
970</p>
971</li>
972</ol></div>
Junio C Hamano640779d2018-02-14 01:29:14[diff] [blame]973<div class="paragraph"><p>and these are evaluated in this order.</p></div>
974<div class="paragraph"><p>For example:</p></div>
975<div class="literalblock">
976<div class="content">
977<pre><code>[submodule "foo"]
978 active = false
979 url = https://example.org/foo
980[submodule "bar"]
981 active = true
982 url = https://example.org/bar
983[submodule "baz"]
984 url = https://example.org/baz</code></pre>
985</div></div>
986<div class="paragraph"><p>In the above config only the submodule <em>bar</em> and <em>baz</em> are active,
987<em>bar</em> due to (a) and <em>baz</em> due to (c). <em>foo</em> is inactive because
988(a) takes precedence over (c)</p></div>
989<div class="paragraph"><p>Note that (c) is a historical artefact and will be ignored if the
990(a) and (b) specify that the submodule is not active. In other words,
Junio C Hamanoea1ac8d2018-07-18 20:16:48[diff] [blame]991if we have a <code>submodule.&lt;name&gt;.active</code> set to <code>false</code> or if the
Junio C Hamano640779d2018-02-14 01:29:14[diff] [blame]992submodule&#8217;s path is excluded in the pathspec in <code>submodule.active</code>, the
993url doesn&#8217;t matter whether it is present or not. This is illustrated in
994the example that follows.</p></div>
995<div class="literalblock">
996<div class="content">
997<pre><code>[submodule "foo"]
998 active = true
999 url = https://example.org/foo
1000[submodule "bar"]
1001 url = https://example.org/bar
1002[submodule "baz"]
1003 url = https://example.org/baz
1004[submodule "bob"]
1005 ignore = true
1006[submodule]
1007 active = b*
1008 active = :(exclude) baz</code></pre>
1009</div></div>
1010<div class="paragraph"><p>In here all submodules except <em>baz</em> (foo, bar, bob) are active.
1011<em>foo</em> due to its own active flag and all the others due to the
1012submodule active pathspec, which specifies that any submodule
1013starting with <em>b</em> except <em>baz</em> are also active, regardless of the
1014presence of the .url field.</p></div>
1015</div>
1016</div>
1017<div class="sect1">
Junio C Hamano387ce232017-07-12 23:01:13[diff] [blame]1018<h2 id="_workflow_for_a_third_party_library">Workflow for a third party library</h2>
1019<div class="sectionbody">
1020<div class="literalblock">
1021<div class="content">
1022<pre><code># add a submodule
1023git submodule add &lt;url&gt; &lt;path&gt;</code></pre>
1024</div></div>
1025<div class="literalblock">
1026<div class="content">
1027<pre><code># occasionally update the submodule to a new version:
1028git -C &lt;path&gt; checkout &lt;new version&gt;
1029git add &lt;path&gt;
1030git commit -m "update submodule to new version"</code></pre>
1031</div></div>
1032<div class="literalblock">
1033<div class="content">
1034<pre><code># See the list of submodules in a superproject
1035git submodule status</code></pre>
1036</div></div>
1037<div class="literalblock">
1038<div class="content">
1039<pre><code># See FORMS on removing submodules</code></pre>
1040</div></div>
1041</div>
1042</div>
1043<div class="sect1">
1044<h2 id="_workflow_for_an_artificially_split_repo">Workflow for an artificially split repo</h2>
1045<div class="sectionbody">
1046<div class="literalblock">
1047<div class="content">
1048<pre><code># Enable recursion for relevant commands, such that
1049# regular commands recurse into submodules by default
1050git config --global submodule.recurse true</code></pre>
1051</div></div>
1052<div class="literalblock">
1053<div class="content">
1054<pre><code># Unlike the other commands below clone still needs
1055# its own recurse flag:
1056git clone --recurse &lt;URL&gt; &lt;directory&gt;
1057cd &lt;directory&gt;</code></pre>
1058</div></div>
1059<div class="literalblock">
1060<div class="content">
1061<pre><code># Get to know the code:
1062git grep foo
1063git ls-files</code></pre>
1064</div></div>
1065<div class="literalblock">
1066<div class="content">
1067<pre><code># Get new code
1068git fetch
1069git pull --rebase</code></pre>
1070</div></div>
1071<div class="literalblock">
1072<div class="content">
1073<pre><code># change worktree
1074git checkout
1075git reset</code></pre>
1076</div></div>
1077</div>
1078</div>
1079<div class="sect1">
1080<h2 id="_implementation_details">Implementation details</h2>
1081<div class="sectionbody">
1082<div class="paragraph"><p>When cloning or pulling a repository containing submodules the submodules
1083will not be checked out by default; You can instruct <em>clone</em> to recurse
1084into submodules. The <em>init</em> and <em>update</em> subcommands of <em>git submodule</em>
1085will maintain submodules checked out and at an appropriate revision in
1086your working tree. Alternatively you can set <em>submodule.recurse</em> to have
1087<em>checkout</em> recursing into submodules.</p></div>
1088</div>
1089</div>
1090<div class="sect1">
1091<h2 id="_see_also">SEE ALSO</h2>
1092<div class="sectionbody">
1093<div class="paragraph"><p><a href="git-submodule.html">git-submodule(1)</a>, <a href="gitmodules.html">gitmodules(5)</a>.</p></div>
1094</div>
1095</div>
1096<div class="sect1">
1097<h2 id="_git">GIT</h2>
1098<div class="sectionbody">
1099<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1100</div>
1101</div>
1102</div>
1103<div id="footnotes"><hr /></div>
1104<div id="footer">
1105<div id="footer-text">
Junio C Hamano2ef0ba32018-01-26 23:13:53[diff] [blame]1106Last updated
Junio C Hamanocf731002019-01-29 21:19:52[diff] [blame^]1107 2018-10-30 00:33:48 PDT
Junio C Hamano387ce232017-07-12 23:01:13[diff] [blame]1108</div>
1109</div>
1110</body>
1111</html>