diff options
author | Junio C Hamano <junio@hera.kernel.org> | 2008-07-15 15:49:03 +0000 |
---|---|---|
committer | Junio C Hamano <junio@hera.kernel.org> | 2008-07-15 15:49:03 +0000 |
commit | 38ddcce0c19a8eedec7a98bd291f65b2127a82b9 (patch) | |
tree | bc44e0dbf17d91c4eec1fdc57bafcec5a15f74dc /git-submodule.html | |
parent | c4b18dd00515b271e8b4e4725ce0d19c4ca41636 (diff) | |
download | git-htmldocs-38ddcce0c19a8eedec7a98bd291f65b2127a82b9.tar.gz |
Autogenerated HTML docs for v1.5.6.3-350-g6c11a
Diffstat (limited to 'git-submodule.html')
-rw-r--r-- | git-submodule.html | 34 |
1 files changed, 24 insertions, 10 deletions
diff --git a/git-submodule.html b/git-submodule.html index a222a7e4f..721a90b09 100644 --- a/git-submodule.html +++ b/git-submodule.html @@ -321,7 +321,7 @@ git-submodule(1) Manual Page <h2>SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<div class="content"><em>git submodule</em> [--quiet] add [-b branch] [--] <repository> [<path>]
+<div class="content"><em>git submodule</em> [--quiet] add [-b branch] [--] <repository> <path>
<em>git submodule</em> [--quiet] status [--cached] [--] [<path>…]
<em>git submodule</em> [--quiet] init [--] [<path>…]
<em>git submodule</em> [--quiet] update [--init] [--] [<path>…]
@@ -336,15 +336,28 @@ add <dd>
<p>
Add the given repository as a submodule at the given path
- to the changeset to be committed next. If path is a valid
- repository within the project, it is added as is. Otherwise,
- repository is cloned at the specified path. path is added to the
- changeset and registered in .gitmodules. If no path is
- specified, the path is deduced from the repository specification.
- If the repository url begins with ./ or ../, it is stored as
- given but resolved as a relative path from the main project's
- url when cloning.
+ to the changeset to be committed next to the current
+ project: the current project is termed 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 need be provided: git-submodule will correctly
+locate the submodule using the relative URL in .gitmodules.</p></div>
</dd>
<dt>
status
@@ -454,6 +467,7 @@ summary <p>
Path 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>
@@ -476,7 +490,7 @@ for details.</p></div> </div>
<div id="footer">
<div id="footer-text">
-Last updated 2008-07-06 05:17:04 UTC
+Last updated 2008-07-15 15:48:35 UTC
</div>
</div>
</body>
|