From e1296e9af0b7e04013cdb44f4cac6d9d456719e7 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Mon, 8 Aug 2011 22:58:15 +0000 Subject: [PATCH] Autogenerated HTML docs for v1.7.6-433-g1421f --- git-submodule.html | 43 ++++++++++++++++++++++++++++++------------- git-submodule.txt | 38 ++++++++++++++++++++++++++------------ 2 files changed, 56 insertions(+), 25 deletions(-) diff --git a/git-submodule.html b/git-submodule.html index 24bf5fd253..9fa9845166 100644 --- a/git-submodule.html +++ b/git-submodule.html @@ -421,7 +421,8 @@ git-submodule(1) Manual Page git submodule [--quiet] init [--] [<path>…] git submodule [--quiet] update [--init] [-N|--no-fetch] [--rebase] [--reference <repository>] [--merge] [--recursive] [--] [<path>…] -git submodule [--quiet] summary [--cached|--files] [--summary-limit <n>] [commit] [--] [<path>…] +git submodule [--quiet] summary [--cached|--files] [(-n|--summary-limit) <n>] + [commit] [--] [<path>…] git submodule [--quiet] foreach [--recursive] <command> git submodule [--quiet] sync [--] [<path>…]
@@ -517,8 +518,12 @@ status repository and U if the submodule has merge conflicts. This command is the default command for git submodule.

-

If --recursive is specified, this command will recurse into nested +

If --recursive is specified, this command will recurse into nested submodules, and show their status as well.

+

If you are only interested in changes of the currently initialized +submodules with respect to the commit recorded in the index or the HEAD, +git-status(1) and git-diff(1) will provide that information +too (and can also report changes to a submodule’s work tree).

init @@ -543,14 +548,14 @@ update

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 --rebase or - --merge is specified or the key submodule.$name.update is set to + This will make the submodules HEAD be detached unless --rebase or + --merge is specified or the key submodule.$name.update is set to rebase or merge.

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.

-

If --recursive is specified, this command will recurse into the +submodule with the --init option.

+

If --recursive is specified, this command will recurse into the registered submodules, and update any nested submodules within.

@@ -561,12 +566,14 @@ summary 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 + 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 + (this option doesn’t allow to use the --cached option or to provide an explicit commit).

+

Using the --submodule=log option with git-diff(1) will provide that +information too.

foreach @@ -581,9 +588,9 @@ foreach superproject, $sha1 is the commit as recorded in the superproject, and $toplevel is the absolute path to the top-level of the superproject. Any submodules defined in the superproject but not checked out are - ignored by this command. Unless given --quiet, foreach prints the name + 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. + 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 || : @@ -726,6 +733,16 @@ sync

+--init +
+
+

+ This option is only valid for the update command. + Initialize all submodules for which "git submodule init" has not been + called so far before updating. +

+
+
--reference <repository>
@@ -735,7 +752,7 @@ sync this option will be passed to the git-clone(1) command.

NOTE: Do not use this option unless you have read the note -for git-clone(1)'s --reference and --shared options carefully.

+for git-clone(1)'s --reference and --shared options carefully.

--recursive @@ -774,7 +791,7 @@ for details.

diff --git a/git-submodule.txt b/git-submodule.txt index 0ec85742dd..67cf5f0f8b 100644 --- a/git-submodule.txt +++ b/git-submodule.txt @@ -15,7 +15,8 @@ SYNOPSIS 'git submodule' [--quiet] init [--] [...] 'git submodule' [--quiet] update [--init] [-N|--no-fetch] [--rebase] [--reference ] [--merge] [--recursive] [--] [...] -'git submodule' [--quiet] summary [--cached|--files] [--summary-limit ] [commit] [--] [...] +'git submodule' [--quiet] summary [--cached|--files] [(-n|--summary-limit) ] + [commit] [--] [...] 'git submodule' [--quiet] foreach [--recursive] 'git submodule' [--quiet] sync [--] [...] @@ -108,8 +109,13 @@ status:: repository and `U` if the submodule has merge conflicts. This command is the default command for 'git submodule'. + -If '--recursive' is specified, this command will recurse into nested +If `--recursive` is specified, this command will recurse into nested submodules, and show their status as well. ++ +If you are only interested in changes of the currently initialized +submodules with respect to the commit recorded in the index or the HEAD, +linkgit:git-status[1] and linkgit:git-diff[1] will provide that information +too (and can also report changes to a submodule's work tree). init:: Initialize the submodules, i.e. register each submodule name @@ -125,26 +131,29 @@ init:: update:: 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 '--rebase' or - '--merge' is specified or the key `submodule.$name.update` is set to + This will make the submodules HEAD be detached unless `--rebase` or + `--merge` is specified or the key `submodule.$name.update` is set to `rebase` or `merge`. + 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. +submodule with the `--init` option. + -If '--recursive' is specified, this command will recurse into the +If `--recursive` is specified, this command will recurse into the registered submodules, and update any nested submodules within. summary:: 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 + 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 + (this option doesn't allow to use the `--cached` option or to provide an explicit commit). ++ +Using the `--submodule=log` option with linkgit:git-diff[1] will provide that +information too. foreach:: Evaluates an arbitrary shell command in each checked out submodule. @@ -155,9 +164,9 @@ foreach:: superproject, $sha1 is the commit as recorded in the superproject, and $toplevel is the absolute path to the top-level of the superproject. Any submodules defined in the superproject but not checked out are - ignored by this command. Unless given --quiet, foreach prints the name + 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. + 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 '|| :' @@ -237,13 +246,18 @@ OPTIONS If the key `submodule.$name.update` is set to `rebase`, this option is implicit. +--init:: + This option is only valid for the update command. + Initialize all submodules for which "git submodule init" has not been + called so far before updating. + --reference :: 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 linkgit:git-clone[1] command. + *NOTE*: Do *not* use this option unless you have read the note -for linkgit:git-clone[1]'s --reference and --shared options carefully. +for linkgit:git-clone[1]'s `--reference` and `--shared` options carefully. --recursive:: This option is only valid for foreach, update and status commands. -- 2.11.4.GIT