From: Imran M Yousuf <imyousuf@xxxxxxxxxxxxxxxxxxxxxx> Documentation with brief description is added for the recurse sucommand along with its arguments and their nature. Signed-off-by: Imran M Yousuf <imyousuf@xxxxxxxxxxxxxxxxxxxxxx> --- Documentation/git-submodule.txt | 35 +++++++++++++++++++++++++++++++++++ 1 files changed, 35 insertions(+), 0 deletions(-) diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt index 6ffd896..9a95522 100644 --- a/Documentation/git-submodule.txt +++ b/Documentation/git-submodule.txt @@ -13,6 +13,10 @@ SYNOPSIS 'git-submodule' [--quiet] status [--cached] [--] [<path>...] 'git-submodule' [--quiet] [init|update] [--] [<path>...] 'git-submodule' [--quiet] summary [--summary-limit <n>] [commit] [--] [<path>...] +'git-submodule' recurse [-q|--quiet] [-e|--exit-after-error] + [-d|--depth <recursion depth>] [-b|--breadth-first] + [-a|--customized-argument] [-p|--pre-command] + <git command> [<arg> ...]" COMMANDS @@ -54,6 +58,10 @@ summary:: in the submodule between the given super project commit and the index or working tree (switched by --cached) are shown. +recurse:: + Recurse, IOW propagate, command to its submodules if they are + initialized. + OPTIONS ------- -q, --quiet:: @@ -78,6 +86,33 @@ OPTIONS Path to submodule(s). When specified this will restrict the command to only operate on the submodules found at the specified paths. +-e, --exit-after-error:: + This option is only valid for the recurse command. If its provided then + then command will not be recursed into any other module once a command + has failed +-d, --depth <recursion depth>:: + This option is only valid for the recurse command. If its provided then + then the command will be recursed upto <recursion depth> only. +-b, --breadth-first:: + This option is only valid for the recurse command. If its provided then + the command will execute in the current node before traversing to its + child, else it will first traverse the children before executing in the + current node. +-a, --customized-argument:: + This option is only valid for the recurse command. If its provided then + user will be prompted for an argument for the <git command> specified. + Its particularly useful when one wants to supply different arguments + for the same <git command> for different submodules; for example, + checking out a branch, one might want branch to differ from submodule + to submodule +-p, --pre-command:: + This option is only valid for the recurse command. If its provided then + user will be prompted for a shell command, e.g. 'ls -al', 'pwd' etc. +<git command> [<arg>...]:: + Any git command and their argument. For example, to get the status use + 'status' as <git command> and '-s' or '-o' or any other 'git status' + arguments as <arg> + FILES ----- When initializing submodules, a .gitmodules file in the top-level directory -- 1.5.4.2 -- To unsubscribe from this list: send the line "unsubscribe git" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
