X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-submodule.txt;h=335e973a6a1d5350c1558eb68985ffe812c09212;hb=e66273a6abb8e9cd0967d52113e29c8014a255f8;hp=7f0904e2933613e1da2312bec28682d3accf2a1d;hpb=e2b1accc59ab5d682d71fd801ebe959c3e871488;p=git.git diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt index 7f0904e29..335e973a6 100644 --- a/Documentation/git-submodule.txt +++ b/Documentation/git-submodule.txt @@ -8,6 +8,7 @@ git-submodule - Initialize, update or inspect submodules SYNOPSIS -------- +[verse] 'git-submodule' [--quiet] [-b branch] add [] 'git-submodule' [--quiet] [--cached] [status|init|update] [--] [...] @@ -20,6 +21,9 @@ add:: 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. + 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. status:: Show the status of the submodules. This will print the SHA-1 of the @@ -32,8 +36,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:: @@ -64,7 +68,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