Merge branch 'maint'

[git.git] / Documentation / git-submodule.txt

diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index 829b03201d0bc365983ed98034c3df284081c1d3..babaa9bc46a404c4610abc4e4c4281b6c5c5ea6c 100644 (file)
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -14,6 +14,8 @@ SYNOPSIS
 'git submodule' [--quiet] init [--] [<path>...]
 'git submodule' [--quiet] update [--init] [--] [<path>...]
 'git submodule' [--quiet] summary [--summary-limit <n>] [commit] [--] [<path>...]
 'git submodule' [--quiet] init [--] [<path>...]
 'git submodule' [--quiet] update [--init] [--] [<path>...]
 'git submodule' [--quiet] summary [--summary-limit <n>] [commit] [--] [<path>...]

+'git submodule' [--quiet] foreach <command>
+'git submodule' [--quiet] sync [--] [<path>...]

 
 
 DESCRIPTION
 
 
 DESCRIPTION


@@ -63,7 +65,7 @@ COMMANDS
 add::
        Add the given repository as a submodule at the given path
        to the changeset to be committed next to the current
 add::
        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 termed the "superproject".
+       project: the current project is termed the "superproject".

 +
 This requires two arguments: <repository> and <path>.
 +
 +
 This requires two arguments: <repository> and <path>.
 +


@@ -123,6 +125,30 @@ summary::
        in the submodule between the given super project commit and the
        index or working tree (switched by --cached) are shown.
 
        in the submodule between the given super project commit and the
        index or working tree (switched by --cached) are shown.
 

+foreach::
+       Evaluates an arbitrary shell command in each checked out submodule.
+       The command has access to the variables $path and $sha1:
+       $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.
+       A non-zero return from the command in any submodule causes
+       the processing to terminate. This can be overridden by adding '|| :'
+       to the end of the command.
++
+As an example, "git submodule foreach 'echo $path `git rev-parse HEAD`' will
+show the path and currently checked out commit for each submodule.
+
+sync::
+       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.
++
+"git submodule sync" synchronizes all submodules while
+"git submodule sync -- A" synchronizes submodule "A" only.
+

 OPTIONS
 -------
 -q::
 OPTIONS
 -------
 -q::


@@ -146,8 +172,8 @@ OPTIONS
        (the default). This limit only applies to modified submodules. The
        size is always limited to 1 for added/deleted/typechanged submodules.
 
        (the default). This limit only applies to modified submodules. The
        size is always limited to 1 for added/deleted/typechanged submodules.
 

-<path>::
-       Path to submodule(s). When specified this will restrict the command
+<path>...::
+       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).
 
        to only operate on the submodules found at the specified paths.
        (This argument is required with add).