Google Git
Sign in
chromium / external / gitster / git-htmldocs / bb34317b8b0b3c34f91f17697ad618fe19148f7b / . / git-submodule.html
blob: b00e5ddfe552af868131e9fa1321dc1e5e5087fd [file] [log] [blame]
Junio C Hamano38b693c2007-06-03 08:40:14[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" />
6<meta name="generator" content="AsciiDoc 7.0.2" />
7<style type="text/css">
8/* Debug borders */
9p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
10/*
11 border: 1px solid red;
12*/
13}
14
15body {
16 margin: 1em 5% 1em 5%;
17}
18
19a { color: blue; }
20a:visited { color: fuchsia; }
21
22em {
23 font-style: italic;
24}
25
26strong {
27 font-weight: bold;
28}
29
30tt {
31 color: navy;
32}
33
34h1, h2, h3, h4, h5, h6 {
35 color: #527bbd;
36 font-family: sans-serif;
37 margin-top: 1.2em;
38 margin-bottom: 0.5em;
39 line-height: 1.3;
40}
41
42h1 {
43 border-bottom: 2px solid silver;
44}
45h2 {
46 border-bottom: 2px solid silver;
47 padding-top: 0.5em;
48}
49
50div.sectionbody {
51 font-family: serif;
52 margin-left: 0;
53}
54
55hr {
56 border: 1px solid silver;
57}
58
59p {
60 margin-top: 0.5em;
61 margin-bottom: 0.5em;
62}
63
64pre {
65 padding: 0;
66 margin: 0;
67}
68
69span#author {
70 color: #527bbd;
71 font-family: sans-serif;
72 font-weight: bold;
73 font-size: 1.2em;
74}
75span#email {
76}
77span#revision {
78 font-family: sans-serif;
79}
80
81div#footer {
82 font-family: sans-serif;
83 font-size: small;
84 border-top: 2px solid silver;
85 padding-top: 0.5em;
86 margin-top: 4.0em;
87}
88div#footer-text {
89 float: left;
90 padding-bottom: 0.5em;
91}
92div#footer-badges {
93 float: right;
94 padding-bottom: 0.5em;
95}
96
97div#preamble,
98div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
99div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
100div.admonitionblock {
101 margin-right: 10%;
102 margin-top: 1.5em;
103 margin-bottom: 1.5em;
104}
105div.admonitionblock {
106 margin-top: 2.5em;
107 margin-bottom: 2.5em;
108}
109
110div.content { /* Block element content. */
111 padding: 0;
112}
113
114/* Block element titles. */
115div.title, caption.title {
116 font-family: sans-serif;
117 font-weight: bold;
118 text-align: left;
119 margin-top: 1.0em;
120 margin-bottom: 0.5em;
121}
122div.title + * {
123 margin-top: 0;
124}
125
126td div.title:first-child {
127 margin-top: 0.0em;
128}
129div.content div.title:first-child {
130 margin-top: 0.0em;
131}
132div.content + div.title {
133 margin-top: 0.0em;
134}
135
136div.sidebarblock > div.content {
137 background: #ffffee;
138 border: 1px solid silver;
139 padding: 0.5em;
140}
141
142div.listingblock > div.content {
143 border: 1px solid silver;
144 background: #f4f4f4;
145 padding: 0.5em;
146}
147
148div.quoteblock > div.content {
149 padding-left: 2.0em;
150}
151div.quoteblock .attribution {
152 text-align: right;
153}
154
155div.admonitionblock .icon {
156 vertical-align: top;
157 font-size: 1.1em;
158 font-weight: bold;
159 text-decoration: underline;
160 color: #527bbd;
161 padding-right: 0.5em;
162}
163div.admonitionblock td.content {
164 padding-left: 0.5em;
165 border-left: 2px solid silver;
166}
167
168div.exampleblock > div.content {
169 border-left: 2px solid silver;
170 padding: 0.5em;
171}
172
173div.verseblock div.content {
174 white-space: pre;
175}
176
177div.imageblock div.content { padding-left: 0; }
178div.imageblock img { border: 1px solid silver; }
179span.image img { border-style: none; }
180
181dl {
182 margin-top: 0.8em;
183 margin-bottom: 0.8em;
184}
185dt {
186 margin-top: 0.5em;
187 margin-bottom: 0;
188 font-style: italic;
189}
190dd > *:first-child {
191 margin-top: 0;
192}
193
194ul, ol {
195 list-style-position: outside;
196}
197ol.olist2 {
198 list-style-type: lower-alpha;
199}
200
201div.tableblock > table {
202 border-color: #527bbd;
203 border-width: 3px;
204}
205thead {
206 font-family: sans-serif;
207 font-weight: bold;
208}
209tfoot {
210 font-weight: bold;
211}
212
213div.hlist {
214 margin-top: 0.8em;
215 margin-bottom: 0.8em;
216}
217td.hlist1 {
218 vertical-align: top;
219 font-style: italic;
220 padding-right: 0.8em;
221}
222td.hlist2 {
223 vertical-align: top;
224}
225
226@media print {
227 div#footer-badges { display: none; }
228}
229include::./stylesheets/xhtml11-manpage.css[]
230/* Workarounds for IE6's broken and incomplete CSS2. */
231
232div.sidebar-content {
233 background: #ffffee;
234 border: 1px solid silver;
235 padding: 0.5em;
236}
237div.sidebar-title, div.image-title {
238 font-family: sans-serif;
239 font-weight: bold;
240 margin-top: 0.0em;
241 margin-bottom: 0.5em;
242}
243
244div.listingblock div.content {
245 border: 1px solid silver;
246 background: #f4f4f4;
247 padding: 0.5em;
248}
249
250div.quoteblock-content {
251 padding-left: 2.0em;
252}
253
254div.exampleblock-content {
255 border-left: 2px solid silver;
256 padding-left: 0.5em;
257}
258</style>
259<title>git-submodule(1)</title>
260</head>
261<body>
262<div id="header">
263<h1>
264git-submodule(1) Manual Page
265</h1>
266<h2>NAME</h2>
267<div class="sectionbody">
268<p>git-submodule -
269 Initialize, update or inspect submodules
270</p>
271</div>
272</div>
273<h2>SYNOPSIS</h2>
274<div class="sectionbody">
Junio C Hamano7a4a2832007-07-07 21:53:22[diff] [blame]275<div class="verseblock">
Junio C Hamano42059e72008-01-22 08:39:14[diff] [blame]276<div class="content"><em>git-submodule</em> [--quiet] add [-b branch] [--] &lt;repository&gt; [&lt;path&gt;]
277<em>git-submodule</em> [--quiet] status [--cached] [--] [&lt;path&gt;&#8230;]
278<em>git-submodule</em> [--quiet] [init|update] [--] [&lt;path&gt;&#8230;]</div></div>
Junio C Hamano38b693c2007-06-03 08:40:14[diff] [blame]279</div>
280<h2>COMMANDS</h2>
281<div class="sectionbody">
282<dl>
283<dt>
Junio C Hamano1d90cb02007-07-03 07:05:31[diff] [blame]284add
285</dt>
286<dd>
287<p>
288 Add the given repository as a submodule at the given path
Junio C Hamanobb343172008-03-09 10:39:09[diff] [blame^]289 to the changeset to be committed next. If path is a valid
290 repository within the project, it is added as is. Otherwise,
291 repository is cloned at the specified path. path is added to the
Junio C Hamano1d90cb02007-07-03 07:05:31[diff] [blame]292 changeset and registered in .gitmodules. If no path is
293 specified, the path is deduced from the repository specification.
Junio C Hamano4fd58d42007-09-30 00:51:14[diff] [blame]294 If the repository url begins with ./ or ../, it is stored as
295 given but resolved as a relative path from the main project's
296 url when cloning.
Junio C Hamano1d90cb02007-07-03 07:05:31[diff] [blame]297</p>
298</dd>
299<dt>
Junio C Hamano38b693c2007-06-03 08:40:14[diff] [blame]300status
301</dt>
302<dd>
303<p>
304 Show the status of the submodules. This will print the SHA-1 of the
305 currently checked out commit for each submodule, along with the
306 submodule path and the output of <a href="git-describe.html">git-describe(1)</a> for the
307 SHA-1. Each SHA-1 will be prefixed with <tt>-</tt> if the submodule is not
308 initialized and <tt>+</tt> if the currently checked out submodule commit
309 does not match the SHA-1 found in the index of the containing
310 repository. This command is the default command for git-submodule.
311</p>
312</dd>
313<dt>
314init
315</dt>
316<dd>
317<p>
Junio C Hamano16f98872007-06-12 16:09:14[diff] [blame]318 Initialize the submodules, i.e. register in .git/config each submodule
Junio C Hamano7a4a2832007-07-07 21:53:22[diff] [blame]319 name and url found in .gitmodules. The key used in .git/config is
320 <tt>submodule.$name.url</tt>. This command does not alter existing information
Junio C Hamano16f98872007-06-12 16:09:14[diff] [blame]321 in .git/config.
Junio C Hamano38b693c2007-06-03 08:40:14[diff] [blame]322</p>
323</dd>
324<dt>
325update
326</dt>
327<dd>
328<p>
Junio C Hamano16f98872007-06-12 16:09:14[diff] [blame]329 Update the registered submodules, i.e. clone missing submodules and
330 checkout the commit specified in the index of the containing repository.
331 This will make the submodules HEAD be detached.
Junio C Hamano38b693c2007-06-03 08:40:14[diff] [blame]332</p>
333</dd>
334</dl>
335</div>
336<h2>OPTIONS</h2>
337<div class="sectionbody">
338<dl>
339<dt>
340-q, --quiet
341</dt>
342<dd>
343<p>
344 Only print error messages.
345</p>
346</dd>
347<dt>
Junio C Hamano1d90cb02007-07-03 07:05:31[diff] [blame]348-b, --branch
349</dt>
350<dd>
351<p>
352 Branch of repository to add as submodule.
353</p>
354</dd>
355<dt>
Junio C Hamano38b693c2007-06-03 08:40:14[diff] [blame]356--cached
357</dt>
358<dd>
359<p>
360 Display the SHA-1 stored in the index, not the SHA-1 of the currently
361 checked out submodule commit. This option is only valid for the
362 status command.
363</p>
364</dd>
365<dt>
366&lt;path&gt;
367</dt>
368<dd>
369<p>
370 Path to submodule(s). When specified this will restrict the command
371 to only operate on the submodules found at the specified paths.
372</p>
373</dd>
374</dl>
375</div>
376<h2>FILES</h2>
377<div class="sectionbody">
Junio C Hamano16f98872007-06-12 16:09:14[diff] [blame]378<p>When initializing submodules, a .gitmodules file in the top-level directory
Junio C Hamano38b693c2007-06-03 08:40:14[diff] [blame]379of the containing repository is used to find the url of each submodule.
Junio C Hamano91baf102007-12-31 09:44:26[diff] [blame]380This file should be formatted in the same way as <tt>$GIT_DIR/config</tt>. The key
Junio C Hamanoe66c6c02007-12-17 08:26:13[diff] [blame]381to each submodule url is "submodule.$name.url". See <a href="gitmodules.html">gitmodules(5)</a>
382for details.</p>
Junio C Hamano38b693c2007-06-03 08:40:14[diff] [blame]383</div>
384<h2>AUTHOR</h2>
385<div class="sectionbody">
386<p>Written by Lars Hjemli &lt;hjemli@gmail.com&gt;</p>
387</div>
388<h2>GIT</h2>
389<div class="sectionbody">
390<p>Part of the <a href="git.html">git(7)</a> suite</p>
391</div>
392<div id="footer">
393<div id="footer-text">
Junio C Hamanobb343172008-03-09 10:39:09[diff] [blame^]394Last updated 09-Mar-2008 10:38:33 UTC
Junio C Hamano38b693c2007-06-03 08:40:14[diff] [blame]395</div>
396</div>
397</body>
398</html>