git-submodule.html - external/gitster/git-htmldocs - Git at Google

 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
  "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
 <meta name="generator" content="AsciiDoc 8.2.5" />
 <style type="text/css">
 /* Debug borders */
 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
 /*
  border: 1px solid red;
 */
 }

 body {
  margin: 1em 5% 1em 5%;
 }

 a {
  color: blue;
  text-decoration: underline;
 }
 a:visited {
  color: fuchsia;
 }

 em {
  font-style: italic;
 }

 strong {
  font-weight: bold;
 }

 tt {
  color: navy;
 }

 h1, h2, h3, h4, h5, h6 {
  color: #527bbd;
  font-family: sans-serif;
  margin-top: 1.2em;
  margin-bottom: 0.5em;
  line-height: 1.3;
 }

 h1, h2, h3 {
  border-bottom: 2px solid silver;
 }
 h2 {
  padding-top: 0.5em;
 }
 h3 {
  float: left;
 }
 h3 + * {
  clear: left;
 }

 div.sectionbody {
  font-family: serif;
  margin-left: 0;
 }

 hr {
  border: 1px solid silver;
 }

 p {
  margin-top: 0.5em;
  margin-bottom: 0.5em;
 }

 pre {
  padding: 0;
  margin: 0;
 }

 span#author {
  color: #527bbd;
  font-family: sans-serif;
  font-weight: bold;
  font-size: 1.1em;
 }
 span#email {
 }
 span#revision {
  font-family: sans-serif;
 }

 div#footer {
  font-family: sans-serif;
  font-size: small;
  border-top: 2px solid silver;
  padding-top: 0.5em;
  margin-top: 4.0em;
 }
 div#footer-text {
  float: left;
  padding-bottom: 0.5em;
 }
 div#footer-badges {
  float: right;
  padding-bottom: 0.5em;
 }

 div#preamble,
 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 div.admonitionblock {
  margin-right: 10%;
  margin-top: 1.5em;
  margin-bottom: 1.5em;
 }
 div.admonitionblock {
  margin-top: 2.5em;
  margin-bottom: 2.5em;
 }

 div.content { /* Block element content. */
  padding: 0;
 }

 /* Block element titles. */
 div.title, caption.title {
  font-family: sans-serif;
  font-weight: bold;
  text-align: left;
  margin-top: 1.0em;
  margin-bottom: 0.5em;
 }
 div.title + * {
  margin-top: 0;
 }

 td div.title:first-child {
  margin-top: 0.0em;
 }
 div.content div.title:first-child {
  margin-top: 0.0em;
 }
 div.content + div.title {
  margin-top: 0.0em;
 }

 div.sidebarblock > div.content {
  background: #ffffee;
  border: 1px solid silver;
  padding: 0.5em;
 }

 div.listingblock {
  margin-right: 0%;
 }
 div.listingblock > div.content {
  border: 1px solid silver;
  background: #f4f4f4;
  padding: 0.5em;
 }

 div.quoteblock > div.content {
  padding-left: 2.0em;
 }

 div.attribution {
  text-align: right;
 }
 div.verseblock + div.attribution {
  text-align: left;
 }

 div.admonitionblock .icon {
  vertical-align: top;
  font-size: 1.1em;
  font-weight: bold;
  text-decoration: underline;
  color: #527bbd;
  padding-right: 0.5em;
 }
 div.admonitionblock td.content {
  padding-left: 0.5em;
  border-left: 2px solid silver;
 }

 div.exampleblock > div.content {
  border-left: 2px solid silver;
  padding: 0.5em;
 }

 div.verseblock div.content {
  white-space: pre;
 }

 div.imageblock div.content { padding-left: 0; }
 div.imageblock img { border: 1px solid silver; }
 span.image img { border-style: none; }

 dl {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
 }
 dt {
  margin-top: 0.5em;
  margin-bottom: 0;
  font-style: italic;
 }
 dd > *:first-child {
  margin-top: 0;
 }

 ul, ol {
  list-style-position: outside;
 }
 div.olist2 ol {
  list-style-type: lower-alpha;
 }

 div.tableblock > table {
  border: 3px solid #527bbd;
 }
 thead {
  font-family: sans-serif;
  font-weight: bold;
 }
 tfoot {
  font-weight: bold;
 }

 div.hlist {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
 }
 div.hlist td {
  padding-bottom: 5px;
 }
 td.hlist1 {
  vertical-align: top;
  font-style: italic;
  padding-right: 0.8em;
 }
 td.hlist2 {
  vertical-align: top;
 }

 @media print {
  div#footer-badges { display: none; }
 }

 div#toctitle {
  color: #527bbd;
  font-family: sans-serif;
  font-size: 1.1em;
  font-weight: bold;
  margin-top: 1.0em;
  margin-bottom: 0.1em;
 }

 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
  margin-top: 0;
  margin-bottom: 0;
 }
 div.toclevel2 {
  margin-left: 2em;
  font-size: 0.9em;
 }
 div.toclevel3 {
  margin-left: 4em;
  font-size: 0.9em;
 }
 div.toclevel4 {
  margin-left: 6em;
  font-size: 0.9em;
 }
 include1::./stylesheets/xhtml11-manpage.css[]
 /* Workarounds for IE6's broken and incomplete CSS2. */

 div.sidebar-content {
  background: #ffffee;
  border: 1px solid silver;
  padding: 0.5em;
 }
 div.sidebar-title, div.image-title {
  font-family: sans-serif;
  font-weight: bold;
  margin-top: 0.0em;
  margin-bottom: 0.5em;
 }

 div.listingblock div.content {
  border: 1px solid silver;
  background: #f4f4f4;
  padding: 0.5em;
 }

 div.quoteblock-content {
  padding-left: 2.0em;
 }

 div.exampleblock-content {
  border-left: 2px solid silver;
  padding-left: 0.5em;
 }

 /* IE6 sets dynamically generated links as visited. */
 div#toc a:visited { color: blue; }
 </style>
 <title>git-submodule(1)</title>
 </head>
 <body>
 <div id="header">
 <h1>
 git-submodule(1) Manual Page
 </h1>
 <h2>NAME</h2>
 <div class="sectionbody">
 <p>git-submodule -
  Initialize, update or inspect submodules
 </p>
 </div>
 </div>
 <h2>SYNOPSIS</h2>
 <div class="sectionbody">
 <div class="verseblock">
 <div class="content"><em>git submodule</em> [--quiet] add [-b branch]
  [--reference &lt;repository&gt;] [--] &lt;repository&gt; &lt;path&gt;
 <em>git submodule</em> [--quiet] status [--cached] [--recursive] [--] [&lt;path&gt;&#8230;]
 <em>git submodule</em> [--quiet] init [--] [&lt;path&gt;&#8230;]
 <em>git submodule</em> [--quiet] update [--init] [-N|--no-fetch] [--rebase]
  [--reference &lt;repository&gt;] [--merge] [--recursive] [--] [&lt;path&gt;&#8230;]
 <em>git submodule</em> [--quiet] summary [--cached|--files] [--summary-limit &lt;n&gt;] [commit] [--] [&lt;path&gt;&#8230;]
 <em>git submodule</em> [--quiet] foreach [--recursive] &lt;command&gt;
 <em>git submodule</em> [--quiet] sync [--] [&lt;path&gt;&#8230;]</div></div>
 </div>
 <h2 id="_description">DESCRIPTION</h2>
 <div class="sectionbody">
 <div class="para"><p>Submodules allow foreign repositories to be embedded within
 a dedicated subdirectory of the source tree, always pointed
 at a particular commit.</p></div>
 <div class="para"><p>They are not to be confused with remotes, which are meant mainly
 for branches of the same project; submodules are meant for
 different projects you would like to make part of your source tree,
 while the history of the two projects still stays completely
 independent and you cannot modify the contents of the submodule
 from within the main project.
 If you want to merge the project histories and want to treat the
 aggregated whole as a single project from then on, you may want to
 add a remote for the other project and use the <em>subtree</em> merge strategy,
 instead of treating the other project as a submodule. Directories
 that come from both projects can be cloned and checked out as a whole
 if you choose to go that route.</p></div>
 <div class="para"><p>Submodules are composed from a so-called <tt>gitlink</tt> tree entry
 in the main repository that refers to a particular commit object
 within the inner repository that is completely separate.
 A record in the <tt>.gitmodules</tt> file at the root of the source
 tree assigns a logical name to the submodule and describes
 the default URL the submodule shall be cloned from.
 The logical name can be used for overriding this URL within your
 local repository configuration (see <em>submodule init</em>).</p></div>
 <div class="para"><p>This command will manage the tree entries and contents of the
 gitmodules file for you, as well as inspect the status of your
 submodules and update them.
 When adding a new submodule to the tree, the <em>add</em> subcommand
 is to be used. However, when pulling a tree containing submodules,
 these will not be checked out by default;
 the <em>init</em> and <em>update</em> subcommands will maintain submodules
 checked out and at appropriate revision in your working tree.
 You can briefly inspect the up-to-date status of your submodules
 using the <em>status</em> subcommand and get a detailed overview of the
 difference between the index and checkouts using the <em>summary</em>
 subcommand.</p></div>
 </div>
 <h2 id="_commands">COMMANDS</h2>
 <div class="sectionbody">
 <div class="vlist"><dl>
 <dt>
 add
 </dt>
 <dd>
 <p>
  Add the given repository as a submodule at the given path
  to the changeset to be committed next to the current
  project: the current project is termed the "superproject".
 </p>
 <div class="para"><p>This requires two arguments: &lt;repository&gt; and &lt;path&gt;.</p></div>
 <div class="para"><p>&lt;repository&gt; is the URL of the new submodule's origin repository.
 This may be either an absolute URL, or (if it begins with ./
 or ../), the location relative to the superproject's origin
 repository.</p></div>
 <div class="para"><p>&lt;path&gt; is the relative location for the cloned submodule to
 exist in the superproject. If &lt;path&gt; does not exist, then the
 submodule is created by cloning from the named URL. If &lt;path&gt; does
 exist and is already a valid git repository, then this is added
 to the changeset without cloning. This second form is provided
 to ease creating a new submodule from scratch, and presumes
 the user will later push the submodule to the given URL.</p></div>
 <div class="para"><p>In either case, the given URL is recorded into .gitmodules for
 use by subsequent users cloning the superproject. If the URL is
 given relative to the superproject's repository, the presumption
 is the superproject and submodule repositories will be kept
 together in the same relative location, and only the
 superproject's URL needs to be provided: git-submodule will correctly
 locate the submodule using the relative URL in .gitmodules.</p></div>
 </dd>
 <dt>
 status
 </dt>
 <dd>
 <p>
  Show the status of the submodules. This will print the SHA-1 of the
  currently checked out commit for each submodule, along with the
  submodule path and the output of <em>git-describe</em> for the
  SHA-1. Each SHA-1 will be prefixed with <tt>-</tt> if the submodule is not
  initialized and <tt>+</tt> if the currently checked out submodule commit
  does not match the SHA-1 found in the index of the containing
  repository. This command is the default command for <em>git-submodule</em>.
 </p>
 <div class="para"><p>If <em>--recursive</em> is specified, this command will recurse into nested
 submodules, and show their status as well.</p></div>
 </dd>
 <dt>
 init
 </dt>
 <dd>
 <p>
  Initialize the submodules, i.e. register each submodule name
  and url found in .gitmodules into .git/config.
  The key used in .git/config is <tt>submodule.$name.url</tt>.
  This command does not alter existing information in .git/config.
  You can then customize the submodule clone URLs in .git/config
  for your local setup and proceed to <em>git submodule update</em>;
  you can also just use <em>git submodule update --init</em> without
  the explicit <em>init</em> step if you do not intend to customize
  any submodule locations.
 </p>
 </dd>
 <dt>
 update
 </dt>
 <dd>
 <p>
  Update the registered submodules, i.e. clone missing submodules and
  checkout the commit specified in the index of the containing repository.
  This will make the submodules HEAD be detached unless <em>--rebase</em> or
  <em>--merge</em> is specified or the key <tt>submodule.$name.update</tt> is set to
  <tt>rebase</tt> or <tt>merge</tt>.
 </p>
 <div class="para"><p>If the submodule is not yet initialized, and you just want to use the
 setting as stored in .gitmodules, you can automatically initialize the
 submodule with the --init option.</p></div>
 <div class="para"><p>If <em>--recursive</em> is specified, this command will recurse into the
 registered submodules, and update any nested submodules within.</p></div>
 </dd>
 <dt>
 summary
 </dt>
 <dd>
 <p>
  Show commit summary between the given commit (defaults to HEAD) and
  working tree/index. For a submodule in question, a series of commits
  in the submodule between the given super project commit and the
  index or working tree (switched by --cached) are shown. If the option
  --files is given, show the series of commits in the submodule between
  the index of the super project and the working tree of the submodule
  (this option doesn't allow to use the --cached option or to provide an
  explicit commit).
 </p>
 </dd>
 <dt>
 foreach
 </dt>
 <dd>
 <p>
  Evaluates an arbitrary shell command in each checked out submodule.
  The command has access to the variables $name, $path and $sha1:
  $name is the name of the relevant submodule section in .gitmodules,
  $path is the name of the submodule directory relative to the
  superproject, and $sha1 is the commit as recorded in the superproject.
  Any submodules defined in the superproject but not checked out are
  ignored by this command. Unless given --quiet, foreach prints the name
  of each submodule before evaluating the command.
  If --recursive is given, submodules are traversed recursively (i.e.
  the given shell command is evaluated in nested submodules as well).
  A non-zero return from the command in any submodule causes
  the processing to terminate. This can be overridden by adding <em>|| :</em>
  to the end of the command.
 </p>
 <div class="para"><p>As an example, +git submodule foreach 'echo $path &#96;git
 rev-parse HEAD&#96;'+ will show the path and currently checked out
 commit for each submodule.</p></div>
 </dd>
 <dt>
 sync
 </dt>
 <dd>
 <p>
  Synchronizes submodules' remote URL configuration setting
  to the value specified in .gitmodules. This is useful when
  submodule URLs change upstream and you need to update your local
  repositories accordingly.
 </p>
 <div class="para"><p>"git submodule sync" synchronizes all submodules while
 "git submodule sync &#8212; A" synchronizes submodule "A" only.</p></div>
 </dd>
 </dl></div>
 </div>
 <h2 id="_options">OPTIONS</h2>
 <div class="sectionbody">
 <div class="vlist"><dl>
 <dt>
 -q
 </dt>
 <dt>
 --quiet
 </dt>
 <dd>
 <p>
  Only print error messages.
 </p>
 </dd>
 <dt>
 -b
 </dt>
 <dt>
 --branch
 </dt>
 <dd>
 <p>
  Branch of repository to add as submodule.
 </p>
 </dd>
 <dt>
 --cached
 </dt>
 <dd>
 <p>
  This option is only valid for status and summary commands. These
  commands typically use the commit found in the submodule HEAD, but
  with this option, the commit stored in the index is used instead.
 </p>
 </dd>
 <dt>
 --files
 </dt>
 <dd>
 <p>
  This option is only valid for the summary command. This command
  compares the commit in the index with that in the submodule HEAD
  when this option is used.
 </p>
 </dd>
 <dt>
 -n
 </dt>
 <dt>
 --summary-limit
 </dt>
 <dd>
 <p>
  This option is only valid for the summary command.
  Limit the summary size (number of commits shown in total).
  Giving 0 will disable the summary; a negative number means unlimited
  (the default). This limit only applies to modified submodules. The
  size is always limited to 1 for added/deleted/typechanged submodules.
 </p>
 </dd>
 <dt>
 -N
 </dt>
 <dt>
 --no-fetch
 </dt>
 <dd>
 <p>
  This option is only valid for the update command.
  Don't fetch new objects from the remote site.
 </p>
 </dd>
 <dt>
 --merge
 </dt>
 <dd>
 <p>
  This option is only valid for the update command.
  Merge the commit recorded in the superproject into the current branch
  of the submodule. If this option is given, the submodule's HEAD will
  not be detached. If a merge failure prevents this process, you will
  have to resolve the resulting conflicts within the submodule with the
  usual conflict resolution tools.
  If the key <tt>submodule.$name.update</tt> is set to <tt>merge</tt>, this option is
  implicit.
 </p>
 </dd>
 <dt>
 --rebase
 </dt>
 <dd>
 <p>
  This option is only valid for the update command.
  Rebase the current branch onto the commit recorded in the
  superproject. If this option is given, the submodule's HEAD will not
  be detached. If a a merge failure prevents this process, you will have
  to resolve these failures with <a href="git-rebase.html">git-rebase(1)</a>.
  If the key <tt>submodule.$name.update</tt> is set to <tt>rebase</tt>, this option is
  implicit.
 </p>
 </dd>
 <dt>
 --reference &lt;repository&gt;
 </dt>
 <dd>
 <p>
  This option is only valid for add and update commands. These
  commands sometimes need to clone a remote repository. In this case,
  this option will be passed to the <a href="git-clone.html">git-clone(1)</a> command.
 </p>
 <div class="para"><p><strong>NOTE</strong>: Do <strong>not</strong> use this option unless you have read the note
 for <a href="git-clone.html">git-clone(1)</a>'s --reference and --shared options carefully.</p></div>
 </dd>
 <dt>
 --recursive
 </dt>
 <dd>
 <p>
  This option is only valid for foreach, update and status commands.
  Traverse submodules recursively. The operation is performed not
  only in the submodules of the current repo, but also
  in any nested submodules inside those submodules (and so on).
 </p>
 </dd>
 <dt>
 &lt;path&gt;&#8230;
 </dt>
 <dd>
 <p>
  Paths to submodule(s). When specified this will restrict the command
  to only operate on the submodules found at the specified paths.
  (This argument is required with add).
 </p>
 </dd>
 </dl></div>
 </div>
 <h2 id="_files">FILES</h2>
 <div class="sectionbody">
 <div class="para"><p>When initializing submodules, a .gitmodules file in the top-level directory
 of the containing repository is used to find the url of each submodule.
 This file should be formatted in the same way as <tt>$GIT_DIR/config</tt>. The key
 to each submodule url is "submodule.$name.url". See <a href="gitmodules.html">gitmodules(5)</a>
 for details.</p></div>
 </div>
 <h2 id="_author">AUTHOR</h2>
 <div class="sectionbody">
 <div class="para"><p>Written by Lars Hjemli &lt;hjemli@gmail.com&gt;</p></div>
 </div>
 <h2 id="_git">GIT</h2>
 <div class="sectionbody">
 <div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
 </div>
 <div id="footer">
 <div id="footer-text">
 Last updated 2009-08-28 01:08:24 UTC
 </div>
 </div>
 </body>
 </html>
	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
	"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
	<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
	<meta name="generator" content="AsciiDoc 8.2.5" />
	<style type="text/css">
	/* Debug borders */
	p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
	/*
	border: 1px solid red;
	*/
	}

	body {
	margin: 1em 5% 1em 5%;
	}

	a {
	color: blue;
	text-decoration: underline;
	}
	a:visited {
	color: fuchsia;
	}

	em {
	font-style: italic;
	}

	strong {
	font-weight: bold;
	}

	tt {
	color: navy;
	}

	h1, h2, h3, h4, h5, h6 {
	color: #527bbd;
	font-family: sans-serif;
	margin-top: 1.2em;
	margin-bottom: 0.5em;
	line-height: 1.3;
	}

	h1, h2, h3 {
	border-bottom: 2px solid silver;
	}
	h2 {
	padding-top: 0.5em;
	}
	h3 {
	float: left;
	}
	h3 + * {
	clear: left;
	}

	div.sectionbody {
	font-family: serif;
	margin-left: 0;
	}

	hr {
	border: 1px solid silver;
	}

	p {
	margin-top: 0.5em;
	margin-bottom: 0.5em;
	}

	pre {
	padding: 0;
	margin: 0;
	}

	span#author {
	color: #527bbd;
	font-family: sans-serif;
	font-weight: bold;
	font-size: 1.1em;
	}
	span#email {
	}
	span#revision {
	font-family: sans-serif;
	}

	div#footer {
	font-family: sans-serif;
	font-size: small;
	border-top: 2px solid silver;
	padding-top: 0.5em;
	margin-top: 4.0em;
	}
	div#footer-text {
	float: left;
	padding-bottom: 0.5em;
	}
	div#footer-badges {
	float: right;
	padding-bottom: 0.5em;
	}

	div#preamble,
	div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
	div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
	div.admonitionblock {
	margin-right: 10%;
	margin-top: 1.5em;
	margin-bottom: 1.5em;
	}
	div.admonitionblock {
	margin-top: 2.5em;
	margin-bottom: 2.5em;
	}

	div.content { /* Block element content. */
	padding: 0;
	}

	/* Block element titles. */
	div.title, caption.title {
	font-family: sans-serif;
	font-weight: bold;
	text-align: left;
	margin-top: 1.0em;
	margin-bottom: 0.5em;
	}
	div.title + * {
	margin-top: 0;
	}

	td div.title:first-child {
	margin-top: 0.0em;
	}
	div.content div.title:first-child {
	margin-top: 0.0em;
	}
	div.content + div.title {
	margin-top: 0.0em;
	}

	div.sidebarblock > div.content {
	background: #ffffee;
	border: 1px solid silver;
	padding: 0.5em;
	}

	div.listingblock {
	margin-right: 0%;
	}
	div.listingblock > div.content {
	border: 1px solid silver;
	background: #f4f4f4;
	padding: 0.5em;
	}

	div.quoteblock > div.content {
	padding-left: 2.0em;
	}

	div.attribution {
	text-align: right;
	}
	div.verseblock + div.attribution {
	text-align: left;
	}

	div.admonitionblock .icon {
	vertical-align: top;
	font-size: 1.1em;
	font-weight: bold;
	text-decoration: underline;
	color: #527bbd;
	padding-right: 0.5em;
	}
	div.admonitionblock td.content {
	padding-left: 0.5em;
	border-left: 2px solid silver;
	}

	div.exampleblock > div.content {
	border-left: 2px solid silver;
	padding: 0.5em;
	}

	div.verseblock div.content {
	white-space: pre;
	}

	div.imageblock div.content { padding-left: 0; }
	div.imageblock img { border: 1px solid silver; }
	span.image img { border-style: none; }

	dl {
	margin-top: 0.8em;
	margin-bottom: 0.8em;
	}
	dt {
	margin-top: 0.5em;
	margin-bottom: 0;
	font-style: italic;
	}
	dd > *:first-child {
	margin-top: 0;
	}

	ul, ol {
	list-style-position: outside;
	}
	div.olist2 ol {
	list-style-type: lower-alpha;
	}

	div.tableblock > table {
	border: 3px solid #527bbd;
	}
	thead {
	font-family: sans-serif;
	font-weight: bold;
	}
	tfoot {
	font-weight: bold;
	}

	div.hlist {
	margin-top: 0.8em;
	margin-bottom: 0.8em;
	}
	div.hlist td {
	padding-bottom: 5px;
	}
	td.hlist1 {
	vertical-align: top;
	font-style: italic;
	padding-right: 0.8em;
	}
	td.hlist2 {
	vertical-align: top;
	}

	@media print {
	div#footer-badges { display: none; }
	}

	div#toctitle {
	color: #527bbd;
	font-family: sans-serif;
	font-size: 1.1em;
	font-weight: bold;
	margin-top: 1.0em;
	margin-bottom: 0.1em;
	}

	div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
	margin-top: 0;
	margin-bottom: 0;
	}
	div.toclevel2 {
	margin-left: 2em;
	font-size: 0.9em;
	}
	div.toclevel3 {
	margin-left: 4em;
	font-size: 0.9em;
	}
	div.toclevel4 {
	margin-left: 6em;
	font-size: 0.9em;
	}
	include1::./stylesheets/xhtml11-manpage.css[]
	/* Workarounds for IE6's broken and incomplete CSS2. */

	div.sidebar-content {
	background: #ffffee;
	border: 1px solid silver;
	padding: 0.5em;
	}
	div.sidebar-title, div.image-title {
	font-family: sans-serif;
	font-weight: bold;
	margin-top: 0.0em;
	margin-bottom: 0.5em;
	}

	div.listingblock div.content {
	border: 1px solid silver;
	background: #f4f4f4;
	padding: 0.5em;
	}

	div.quoteblock-content {
	padding-left: 2.0em;
	}

	div.exampleblock-content {
	border-left: 2px solid silver;
	padding-left: 0.5em;
	}

	/* IE6 sets dynamically generated links as visited. */
	div#toc a:visited { color: blue; }
	</style>
	<title>git-submodule(1)</title>
	</head>
	<body>
	<div id="header">
	<h1>
	git-submodule(1) Manual Page
	</h1>
	<h2>NAME</h2>
	<div class="sectionbody">
	<p>git-submodule -
	Initialize, update or inspect submodules
	</p>
	</div>
	</div>
	<h2>SYNOPSIS</h2>
	<div class="sectionbody">
	<div class="verseblock">
	<div class="content"><em>git submodule</em> [--quiet] add [-b branch]
	[--reference <repository>] [--] <repository> <path>
	<em>git submodule</em> [--quiet] status [--cached] [--recursive] [--] [<path>…]
	<em>git submodule</em> [--quiet] init [--] [<path>…]
	<em>git submodule</em> [--quiet] update [--init] [-N\|--no-fetch] [--rebase]
	[--reference <repository>] [--merge] [--recursive] [--] [<path>…]
	<em>git submodule</em> [--quiet] summary [--cached\|--files] [--summary-limit <n>] [commit] [--] [<path>…]
	<em>git submodule</em> [--quiet] foreach [--recursive] <command>
	<em>git submodule</em> [--quiet] sync [--] [<path>…]</div></div>
	</div>
	<h2 id="_description">DESCRIPTION</h2>
	<div class="sectionbody">
	<div class="para"><p>Submodules allow foreign repositories to be embedded within
	a dedicated subdirectory of the source tree, always pointed
	at a particular commit.</p></div>
	<div class="para"><p>They are not to be confused with remotes, which are meant mainly
	for branches of the same project; submodules are meant for
	different projects you would like to make part of your source tree,
	while the history of the two projects still stays completely
	independent and you cannot modify the contents of the submodule
	from within the main project.
	If you want to merge the project histories and want to treat the
	aggregated whole as a single project from then on, you may want to
	add a remote for the other project and use the <em>subtree</em> merge strategy,
	instead of treating the other project as a submodule. Directories
	that come from both projects can be cloned and checked out as a whole
	if you choose to go that route.</p></div>
	<div class="para"><p>Submodules are composed from a so-called <tt>gitlink</tt> tree entry
	in the main repository that refers to a particular commit object
	within the inner repository that is completely separate.
	A record in the <tt>.gitmodules</tt> file at the root of the source
	tree assigns a logical name to the submodule and describes
	the default URL the submodule shall be cloned from.
	The logical name can be used for overriding this URL within your
	local repository configuration (see <em>submodule init</em>).</p></div>
	<div class="para"><p>This command will manage the tree entries and contents of the
	gitmodules file for you, as well as inspect the status of your
	submodules and update them.
	When adding a new submodule to the tree, the <em>add</em> subcommand
	is to be used. However, when pulling a tree containing submodules,
	these will not be checked out by default;
	the <em>init</em> and <em>update</em> subcommands will maintain submodules
	checked out and at appropriate revision in your working tree.
	You can briefly inspect the up-to-date status of your submodules
	using the <em>status</em> subcommand and get a detailed overview of the
	difference between the index and checkouts using the <em>summary</em>
	subcommand.</p></div>
	</div>
	<h2 id="_commands">COMMANDS</h2>
	<div class="sectionbody">
	<div class="vlist"><dl>
	<dt>
	add
	</dt>
	<dd>
	<p>
	Add the given repository as a submodule at the given path
	to the changeset to be committed next to the current
	project: the current project is termed the "superproject".
	</p>
	<div class="para"><p>This requires two arguments: <repository> and <path>.</p></div>
	<div class="para"><p><repository> is the URL of the new submodule's origin repository.
	This may be either an absolute URL, or (if it begins with ./
	or ../), the location relative to the superproject's origin
	repository.</p></div>
	<div class="para"><p><path> is the relative location for the cloned submodule to
	exist in the superproject. If <path> does not exist, then the
	submodule is created by cloning from the named URL. If <path> does
	exist and is already a valid git repository, then this is added
	to the changeset without cloning. This second form is provided
	to ease creating a new submodule from scratch, and presumes
	the user will later push the submodule to the given URL.</p></div>
	<div class="para"><p>In either case, the given URL is recorded into .gitmodules for
	use by subsequent users cloning the superproject. If the URL is
	given relative to the superproject's repository, the presumption
	is the superproject and submodule repositories will be kept
	together in the same relative location, and only the
	superproject's URL needs to be provided: git-submodule will correctly
	locate the submodule using the relative URL in .gitmodules.</p></div>
	</dd>
	<dt>
	status
	</dt>
	<dd>
	<p>
	Show the status of the submodules. This will print the SHA-1 of the
	currently checked out commit for each submodule, along with the
	submodule path and the output of <em>git-describe</em> for the
	SHA-1. Each SHA-1 will be prefixed with <tt>-</tt> if the submodule is not
	initialized and <tt>+</tt> if the currently checked out submodule commit
	does not match the SHA-1 found in the index of the containing
	repository. This command is the default command for <em>git-submodule</em>.
	</p>
	<div class="para"><p>If <em>--recursive</em> is specified, this command will recurse into nested
	submodules, and show their status as well.</p></div>
	</dd>
	<dt>
	init
	</dt>
	<dd>
	<p>
	Initialize the submodules, i.e. register each submodule name
	and url found in .gitmodules into .git/config.
	The key used in .git/config is <tt>submodule.$name.url</tt>.
	This command does not alter existing information in .git/config.
	You can then customize the submodule clone URLs in .git/config
	for your local setup and proceed to <em>git submodule update</em>;
	you can also just use <em>git submodule update --init</em> without
	the explicit <em>init</em> step if you do not intend to customize
	any submodule locations.
	</p>
	</dd>
	<dt>
	update
	</dt>
	<dd>
	<p>
	Update the registered submodules, i.e. clone missing submodules and
	checkout the commit specified in the index of the containing repository.
	This will make the submodules HEAD be detached unless <em>--rebase</em> or
	<em>--merge</em> is specified or the key <tt>submodule.$name.update</tt> is set to
	<tt>rebase</tt> or <tt>merge</tt>.
	</p>
	<div class="para"><p>If the submodule is not yet initialized, and you just want to use the
	setting as stored in .gitmodules, you can automatically initialize the
	submodule with the --init option.</p></div>
	<div class="para"><p>If <em>--recursive</em> is specified, this command will recurse into the
	registered submodules, and update any nested submodules within.</p></div>
	</dd>
	<dt>
	summary
	</dt>
	<dd>
	<p>
	Show commit summary between the given commit (defaults to HEAD) and
	working tree/index. For a submodule in question, a series of commits
	in the submodule between the given super project commit and the
	index or working tree (switched by --cached) are shown. If the option
	--files is given, show the series of commits in the submodule between
	the index of the super project and the working tree of the submodule
	(this option doesn't allow to use the --cached option or to provide an
	explicit commit).
	</p>
	</dd>
	<dt>
	foreach
	</dt>
	<dd>
	<p>
	Evaluates an arbitrary shell command in each checked out submodule.
	The command has access to the variables $name, $path and $sha1:
	$name is the name of the relevant submodule section in .gitmodules,
	$path is the name of the submodule directory relative to the
	superproject, and $sha1 is the commit as recorded in the superproject.
	Any submodules defined in the superproject but not checked out are
	ignored by this command. Unless given --quiet, foreach prints the name
	of each submodule before evaluating the command.
	If --recursive is given, submodules are traversed recursively (i.e.
	the given shell command is evaluated in nested submodules as well).
	A non-zero return from the command in any submodule causes
	the processing to terminate. This can be overridden by adding <em>\|\| :</em>
	to the end of the command.
	</p>
	<div class="para"><p>As an example, +git submodule foreach 'echo $path `git
	rev-parse HEAD`'+ will show the path and currently checked out
	commit for each submodule.</p></div>
	</dd>
	<dt>
	sync
	</dt>
	<dd>
	<p>
	Synchronizes submodules' remote URL configuration setting
	to the value specified in .gitmodules. This is useful when
	submodule URLs change upstream and you need to update your local
	repositories accordingly.
	</p>
	<div class="para"><p>"git submodule sync" synchronizes all submodules while
	"git submodule sync — A" synchronizes submodule "A" only.</p></div>
	</dd>
	</dl></div>
	</div>
	<h2 id="_options">OPTIONS</h2>
	<div class="sectionbody">
	<div class="vlist"><dl>
	<dt>
	-q
	</dt>
	<dt>
	--quiet
	</dt>
	<dd>
	<p>
	Only print error messages.
	</p>
	</dd>
	<dt>
	-b
	</dt>
	<dt>
	--branch
	</dt>
	<dd>
	<p>
	Branch of repository to add as submodule.
	</p>
	</dd>
	<dt>
	--cached
	</dt>
	<dd>
	<p>
	This option is only valid for status and summary commands. These
	commands typically use the commit found in the submodule HEAD, but
	with this option, the commit stored in the index is used instead.
	</p>
	</dd>
	<dt>
	--files
	</dt>
	<dd>
	<p>
	This option is only valid for the summary command. This command
	compares the commit in the index with that in the submodule HEAD
	when this option is used.
	</p>
	</dd>
	<dt>
	-n
	</dt>
	<dt>
	--summary-limit
	</dt>
	<dd>
	<p>
	This option is only valid for the summary command.
	Limit the summary size (number of commits shown in total).
	Giving 0 will disable the summary; a negative number means unlimited
	(the default). This limit only applies to modified submodules. The
	size is always limited to 1 for added/deleted/typechanged submodules.
	</p>
	</dd>
	<dt>
	-N
	</dt>
	<dt>
	--no-fetch
	</dt>
	<dd>
	<p>
	This option is only valid for the update command.
	Don't fetch new objects from the remote site.
	</p>
	</dd>
	<dt>
	--merge
	</dt>
	<dd>
	<p>
	This option is only valid for the update command.
	Merge the commit recorded in the superproject into the current branch
	of the submodule. If this option is given, the submodule's HEAD will
	not be detached. If a merge failure prevents this process, you will
	have to resolve the resulting conflicts within the submodule with the
	usual conflict resolution tools.
	If the key <tt>submodule.$name.update</tt> is set to <tt>merge</tt>, this option is
	implicit.
	</p>
	</dd>
	<dt>
	--rebase
	</dt>
	<dd>
	<p>
	This option is only valid for the update command.
	Rebase the current branch onto the commit recorded in the
	superproject. If this option is given, the submodule's HEAD will not
	be detached. If a a merge failure prevents this process, you will have
	to resolve these failures with <a href="git-rebase.html">git-rebase(1)</a>.
	If the key <tt>submodule.$name.update</tt> is set to <tt>rebase</tt>, this option is
	implicit.
	</p>
	</dd>
	<dt>
	--reference <repository>
	</dt>
	<dd>
	<p>
	This option is only valid for add and update commands. These
	commands sometimes need to clone a remote repository. In this case,
	this option will be passed to the <a href="git-clone.html">git-clone(1)</a> command.
	</p>
	<div class="para"><p><strong>NOTE</strong>: Do <strong>not</strong> use this option unless you have read the note
	for <a href="git-clone.html">git-clone(1)</a>'s --reference and --shared options carefully.</p></div>
	</dd>
	<dt>
	--recursive
	</dt>
	<dd>
	<p>
	This option is only valid for foreach, update and status commands.
	Traverse submodules recursively. The operation is performed not
	only in the submodules of the current repo, but also
	in any nested submodules inside those submodules (and so on).
	</p>
	</dd>
	<dt>
	<path>…
	</dt>
	<dd>
	<p>
	Paths to submodule(s). When specified this will restrict the command
	to only operate on the submodules found at the specified paths.
	(This argument is required with add).
	</p>
	</dd>
	</dl></div>
	</div>
	<h2 id="_files">FILES</h2>
	<div class="sectionbody">
	<div class="para"><p>When initializing submodules, a .gitmodules file in the top-level directory
	of the containing repository is used to find the url of each submodule.
	This file should be formatted in the same way as <tt>$GIT_DIR/config</tt>. The key
	to each submodule url is "submodule.$name.url". See <a href="gitmodules.html">gitmodules(5)</a>
	for details.</p></div>
	</div>
	<h2 id="_author">AUTHOR</h2>
	<div class="sectionbody">
	<div class="para"><p>Written by Lars Hjemli <hjemli@gmail.com></p></div>
	</div>
	<h2 id="_git">GIT</h2>
	<div class="sectionbody">
	<div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
	</div>
	<div id="footer">
	<div id="footer-text">
	Last updated 2009-08-28 01:08:24 UTC
	</div>
	</div>
	</body>
	</html>