X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-submodule.txt;h=2c48936fcd72c5276ae2fed217bd9b9564342f03;hb=07efafef2bcd87b35bf8880364dd5d098058cd4e;hp=f8fb80f18b91fc7a7044da261e54ef25988ced99;hpb=610f043bb378d12f399f4e5692fb874e0a043b23;p=git.git diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt index f8fb80f18..2c48936fc 100644 --- a/Documentation/git-submodule.txt +++ b/Documentation/git-submodule.txt @@ -8,11 +8,20 @@ git-submodule - Initialize, update or inspect submodules SYNOPSIS -------- +[verse] +'git-submodule' [--quiet] [-b branch] add [] 'git-submodule' [--quiet] [--cached] [status|init|update] [--] [...] COMMANDS -------- +add:: + Add the given repository as a submodule at the given path + to the changeset to be committed next. In particular, the + repository is cloned at the specified path, added to the + changeset and registered in .gitmodules. If no path is + specified, the path is deduced from the repository specification. + status:: Show the status of the submodules. This will print the SHA-1 of the currently checked out commit for each submodule, along with the @@ -24,8 +33,8 @@ status:: init:: Initialize the submodules, i.e. register in .git/config each submodule - path and url found in .gitmodules. The key used in git/config is - `submodule.$path.url`. This command does not alter existing information + name and url found in .gitmodules. The key used in .git/config is + `submodule.$name.url`. This command does not alter existing information in .git/config. update:: @@ -39,6 +48,9 @@ OPTIONS -q, --quiet:: Only print error messages. +-b, --branch:: + Branch of repository to add as submodule. + --cached:: Display the SHA-1 stored in the index, not the SHA-1 of the currently checked out submodule commit. This option is only valid for the @@ -53,7 +65,7 @@ FILES 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 $GIR_DIR/config. The key -to each submodule url is "module.$path.url". +to each submodule url is "submodule.$name.url". AUTHOR