1git-submodule(1) 2================ 3 4NAME 5---- 6git-submodule - Initialize, update or inspect submodules 7 8 9SYNOPSIS 10-------- 11[verse] 12'git-submodule' [--quiet] add [-b branch] [--] <repository> [<path>] 13'git-submodule' [--quiet] status [--cached] [--] [<path>...] 14'git-submodule' [--quiet] [init|update] [--] [<path>...] 15 16 17COMMANDS 18-------- 19add:: 20 Add the given repository as a submodule at the given path 21 to the changeset to be committed next. In particular, the 22 repository is cloned at the specified path, added to the 23 changeset and registered in .gitmodules. If no path is 24 specified, the path is deduced from the repository specification. 25 If the repository url begins with ./ or ../, it is stored as 26 given but resolved as a relative path from the main project's 27 url when cloning. 28 29status:: 30 Show the status of the submodules. This will print the SHA-1 of the 31 currently checked out commit for each submodule, along with the 32 submodule path and the output of linkgit:git-describe[1] for the 33 SHA-1. Each SHA-1 will be prefixed with `-` if the submodule is not 34 initialized and `+` if the currently checked out submodule commit 35 does not match the SHA-1 found in the index of the containing 36 repository. This command is the default command for git-submodule. 37 38init:: 39 Initialize the submodules, i.e. register in .git/config each submodule 40 name and url found in .gitmodules. The key used in .git/config is 41 `submodule.$name.url`. This command does not alter existing information 42 in .git/config. 43 44update:: 45 Update the registered submodules, i.e. clone missing submodules and 46 checkout the commit specified in the index of the containing repository. 47 This will make the submodules HEAD be detached. 48 49 50OPTIONS 51------- 52-q, --quiet:: 53 Only print error messages. 54 55-b, --branch:: 56 Branch of repository to add as submodule. 57 58--cached:: 59 Display the SHA-1 stored in the index, not the SHA-1 of the currently 60 checked out submodule commit. This option is only valid for the 61 status command. 62 63<path>:: 64 Path to submodule(s). When specified this will restrict the command 65 to only operate on the submodules found at the specified paths. 66 67FILES 68----- 69When initializing submodules, a .gitmodules file in the top-level directory 70of the containing repository is used to find the url of each submodule. 71This file should be formatted in the same way as `$GIT_DIR/config`. The key 72to each submodule url is "submodule.$name.url". See linkgit:gitmodules[5] 73for details. 74 75 76AUTHOR 77------ 78Written by Lars Hjemli <hjemli@gmail.com> 79 80GIT 81--- 82Part of the linkgit:git[7] suite